bug: fix precomposition allowed types for b (#178)

All b to be of float and np.ndarray type

Author: mrava87

.readthedocs.yaml

@@ -10,8 +10,6 @@ build:
   os: ubuntu-20.04
   tools:
     python: "3.9"
-  apt_packages:
-    - libopenblas-dev
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

environment-dev.yml

@@ -17,7 +17,8 @@ dependencies:
   - numba
   - icc_rt
   - pip:
-    - bm3d
+    - bm4d<4.2.4 # temporary as gclib problem arises in readthedocs
+    - bm3d<4.0.2 # temporary as gclib problem arises in readthedocs
     - pytest-runner
     - setuptools_scm
     - pydata-sphinx-theme

pyproximal/ProxOperator.py

@@ -73,17 +73,16 @@ def _proxdual_moreau(self, x, tau, **kwargs):
     def prox(self, x, tau, **kwargs):
         """Proximal operator applied to a vector
 
-        The  proximal operator can always be computed given its dual
+        The proximal operator can always be computed given its dual
         proximal operator using the Moreau decomposition as defined in
-        :func:`pyprox.moreau`. For this reason we can easily create a common
+        :func:`pyproximal.moreau`. For this reason we can easily create a common
         method for all proximal operators that can be evaluated provided the
         dual proximal is implemented.
 
         However, direct implementations are generally available. This can
         be done by simply implementing ``prox`` for a specific proximal
         operator, which will overwrite the general method.
 
-
         Parameters
         ----------
         x : :obj:`np.ndarray`
@@ -100,9 +99,9 @@ def proxdual(self, x, tau, **kwargs):
 
         The dual of a proximal operator can always be computed given its
         proximal operator using the Moreau decomposition as defined in
-        :func:`pyprox.moreau`. For this reason we can easily create a common
+        :func:`pyproximal.moreau`. For this reason we can easily create a common
         method for all dual proximal operators that can be evaluated provided
-        he proximal is implemented.
+        the proximal is implemented.
 
         However, since the dual of a proximal operator of a function is
         equivalent to the proximal operator of the conjugate function, smarter
@@ -163,7 +162,7 @@ def affine_addition(self, v):
         if isinstance(v, np.ndarray):
             return _SumOperator(self, v)
         else:
-            return NotImplemented
+            raise NotImplementedError('v must be of type numpy.ndarray')
 
     def postcomposition(self, sigma):
         r"""Postcomposition
@@ -191,7 +190,7 @@ def postcomposition(self, sigma):
         if isinstance(sigma, float):
             return _PostcompositionOperator(self, sigma)
         else:
-            return NotImplemented
+            raise NotImplementedError('sigma must be of type float')
 
     def precomposition(self, a, b):
         r"""Precomposition
@@ -217,10 +216,12 @@ def precomposition(self, a, b):
             prox_{a^2 \tau f} (a \mathbf{x} + b) - b)
 
         """
-        if isinstance(a, float) and isinstance(b, float):
+        if isinstance(a, float) and isinstance(b, (float, np.ndarray)):
             return _PrecompositionOperator(self, a, b)
         else:
-            return NotImplemented
+            raise NotImplementedError('a must be of type float and b '
+                                      'must be of type float or '
+                                      'numpy.ndarray')
 
     def chain(self, g):
         r"""Chain
@@ -347,7 +348,7 @@ def __init__(self, f, a, b):
         #    raise ValueError('First input must be a ProxOperator')
         if not isinstance(a, float):
             raise ValueError('Second input must be a float')
-        if not isinstance(b, float):
+        if not isinstance(b, (float, np.ndarray)):
             raise ValueError('Second input must be a float')
         self.f, self.a, self.b = f, a, b
         super().__init__(None, True if f.grad else False)

requirements-dev.txt

@@ -5,7 +5,8 @@ numba
 scikit-image
 matplotlib
 ipython
-bm3d
+bm4d<4.2.4 # temporary as gclib problem arises in readthedocs
+bm3d<4.0.2 # temporary as gclib problem arises in readthedocs
 pytest
 pytest-runner
 setuptools_scm