diff options
| author | Edoardo Pasca <edo.paskino@gmail.com> | 2019-03-15 16:37:21 +0000 |
|---|---|---|
| committer | Edoardo Pasca <edo.paskino@gmail.com> | 2019-03-15 16:37:21 +0000 |
| commit | 5585a3caf6832908ea64089fe47666a4e1b72c76 (patch) | |
| tree | 6829b9a971a8be2c842b9bd89aea06b6edee6b59 | |
| parent | 071f9b65e552ba338fa35e0798116a6ccd00802a (diff) | |
| download | framework-5585a3caf6832908ea64089fe47666a4e1b72c76.tar.gz framework-5585a3caf6832908ea64089fe47666a4e1b72c76.tar.bz2 framework-5585a3caf6832908ea64089fe47666a4e1b72c76.tar.xz framework-5585a3caf6832908ea64089fe47666a4e1b72c76.zip | |
add docstring
| -rwxr-xr-x | Wrappers/Python/ccpi/optimisation/operators/Operator.py | 7 |
1 files changed, 7 insertions, 0 deletions
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)
|