summaryrefslogtreecommitdiffstats
path: root/Wrappers/Python
diff options
context:
space:
mode:
Diffstat (limited to 'Wrappers/Python')
-rwxr-xr-xWrappers/Python/ccpi/optimisation/functions/Function.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/Wrappers/Python/ccpi/optimisation/functions/Function.py b/Wrappers/Python/ccpi/optimisation/functions/Function.py
index 43ce900..27a5f01 100755
--- a/Wrappers/Python/ccpi/optimisation/functions/Function.py
+++ b/Wrappers/Python/ccpi/optimisation/functions/Function.py
@@ -22,7 +22,9 @@ import warnings
class Function(object):
'''Abstract class representing a function
-
+ Members:
+ L is the Lipschitz constant of the gradient of the Function
+ alpha is scaling parameter of the function.
'''
def __init__(self):
self.L = None