From 26dcd132486c8ab6bb2df4b24d8c053e0b42269c Mon Sep 17 00:00:00 2001 From: Edoardo Pasca Date: Wed, 15 Jan 2020 16:14:28 +0000 Subject: Function m (#482) * fix func style * update pnorm not quite right * add test for SumFunction * passed test for SumFunction * passed test for SumFunction * passed test for SumFunction * rename Norm2Sq to LeastSquares * rename Norm2Sq to LeastSquares * delete files and move to Function.py * fix accuracy convex conjugate * comment proximal conjugate, have generic expression * remove some imports * remove imports and comment gradient, proximal conjugate , rmul * remove imports and comment prox conj * fix init * fix out gradient * fix init * SumFunction full test * rename Norm2Sq * rename Norm2Sq * change kwargs in KL, not ready yet * change def of KL cases * change kwargs in KL, not ready yet * LinearOperatorMatrix FISTA cvx is not working * change name in KL * minor fix * BlockDataContainer should give a geometry when shape is the same * change convex conj when we have BDC * remove space * fix out for prox * rename x to b * add SumFunctionScalar test * fix convex conj of constant * fix convex conj of constant * minor fix * fix con conj * add new tests * KL not ready yet * add docs, not ready yet * fix documentation * fix docs * fix doc scaled function * fix doc translate function * fix modules path for documentation * minor doc fix * fix doc prox conj for KL * fix vector geometry in vectordata * fix direct/adjpint LinearOperator * add test LinearOperatorMatrix * fix doc and check methods for functionOperaCom * add new test for FunctionOperCom with LinearOperMatr * get vector geometry in vector data * minor changes and docs * fix docs * check Lips cons * rename Norm2Sq to LeastSquares for docs * fix KL, docs, background term, conve conj * add KL test * fix KL * minor fix doc * add back prox conj work with smoothTV * smooth TV not ready yet * add prox conj back * minor change * no change * fixing docs, not ready yet * uncomment prox_conj for ScaledFunction * fix doc for BlockFunction * add smoothTV not ready yet * no change * fix doc and uncomment prox conj * remove unicode literals * sphnix is a nightmare * fixing ADMM * remove conv conj, prox, prox conj from smooth TV * merge edo's docs * fix docs for L2Norm after edo's PR * fix docs * remove ADMM * add docs for Function module * remove unicode_literals from future imports https://stackoverflow.com/questions/7602171/unicode-error-unicodeescape-codec-cant-decode-bytes-string-with-u * remove ADMM * removed unicode literals from future imports * fix init for functions * remove main * add explcit KL prox conj, does not work with generic prox conj of function * add elif pass for vector geometry * fixes from comments on the PR * minor changes * fix mul in Function and Identity in TranslateFunction * remove from call * remove BlockGeometr from BDC * remove min, max * cleaned Function * add test for constant function * remove smooth mixed L21 Norm * fixed fill method and test of SumFunction * Functions dev (#479) * v19.10 docs (#467) updated docstrings and documentation * add Gemma in the authors * update docs * Installs with make install (#478) * closes #477 * install from build dir Co-authored-by: Vaggelis Papoutsellis <22398586+epapoutsellis@users.noreply.github.com> --- docs/source/optimisation.rst | 44 +++++++++++++++++++++++++++++++------------- 1 file changed, 31 insertions(+), 13 deletions(-) (limited to 'docs') diff --git a/docs/source/optimisation.rst b/docs/source/optimisation.rst index 59f3dd3..d20bc9c 100644 --- a/docs/source/optimisation.rst +++ b/docs/source/optimisation.rst @@ -271,6 +271,29 @@ Base classes .. autoclass:: ccpi.optimisation.functions.ScaledFunction :members: :special-members: + +.. autoclass:: ccpi.optimisation.functions.SumFunction + :members: + :special-members: + +Zero Function +------------- + +.. autoclass:: ccpi.optimisation.functions.ZeroFunction + :members: + :special-members: + +.. autoclass:: ccpi.optimisation.functions.SumFunctionScalar + :members: + :special-members: + +Constant Function +----------------- + +.. autoclass:: ccpi.optimisation.functions.ConstantFunction + :members: + :special-members: + Composition of operator and a function -------------------------------------- @@ -329,9 +352,10 @@ Squared L2 norm :members: :special-members: -And a least squares function: +Least Squares +------------- -.. autoclass:: ccpi.optimisation.functions.Norm2Sq +.. autoclass:: ccpi.optimisation.functions.LeastSquares :members: :special-members: @@ -341,25 +365,19 @@ Mixed L21 norm .. autoclass:: ccpi.optimisation.functions.MixedL21Norm :members: :special-members: + +Smooth Mixed L21 norm +--------------------- -.. autoclass:: ccpi.optimisation.functions.ZeroFunction +.. autoclass:: ccpi.optimisation.functions.smoothMixedL21Norm :members: - :special-members: + :special-members: Block Framework *************** Block Operator -============== - - -.. autoclass:: ccpi.optimisation.operators.BlockOperator - :members: - :special-members: -.. autoclass:: ccpi.optimisation.operators.BlockScaledOperator - :members: - :special-members: Block Function -- cgit v1.2.3