From 5585a3caf6832908ea64089fe47666a4e1b72c76 Mon Sep 17 00:00:00 2001 From: Edoardo Pasca Date: Fri, 15 Mar 2019 16:37:21 +0000 Subject: add docstring --- Wrappers/Python/ccpi/optimisation/operators/Operator.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Wrappers/Python/ccpi/optimisation/operators/Operator.py b/Wrappers/Python/ccpi/optimisation/operators/Operator.py index 95082f4..cdf15a7 100755 --- a/Wrappers/Python/ccpi/optimisation/operators/Operator.py +++ b/Wrappers/Python/ccpi/optimisation/operators/Operator.py @@ -12,12 +12,19 @@ class Operator(object): '''Returns if the operator is linear''' return False def direct(self,x, out=None): + '''Returns the application of the Operator on x''' raise NotImplementedError def norm(self): + '''Returns the norm of the Operator''' raise NotImplementedError def range_geometry(self): + '''Returns the range of the Operator: Y space''' raise NotImplementedError def domain_geometry(self): + '''Returns the domain of the Operator: X space''' raise NotImplementedError def __rmul__(self, scalar): + '''Defines the multiplication by a scalar on the left + + returns a ScaledOperator''' return ScaledOperator(self, scalar) -- cgit v1.2.3