Package parsimony :: Package algorithms :: Module proximal :: Class DykstrasProximalAlgorithm

Class DykstrasProximalAlgorithm

         object --+        
                  |        
bases.BaseAlgorithm --+    
                      |    
bases.ExplicitAlgorithm --+
                          |
                         DykstrasProximalAlgorithm

Dykstra's proximal algorithm. Computes the minimum of the sum of two proximal operators.

The functions have proximal operators (ProjectionOperator.prox).

Instance Methods

[hide private]

__init__(self, eps=5e-08, max_iter=1000, min_iter=1)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

run(self, function, x)
Finds the proximal operator of the sum of two proximal operators.

source code

Inherited from bases.BaseAlgorithm: get_params, set_params

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods

[hide private]

Inherited from bases.BaseAlgorithm: check_compatibility

Class Variables

[hide private]

INTERFACES = [<class 'parsimony.functions.properties.Function'...

__abstractmethods__ = frozenset([])

_abc_negative_cache_version = 14

Inherited from bases.ExplicitAlgorithm: __metaclass__

Inherited from bases.BaseAlgorithm (private): _abc_cache, _abc_negative_cache, _abc_registry

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, eps=5e-08, max_iter=1000, min_iter=1)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

run(self, function, x)

source code

Finds the proximal operator of the sum of two proximal operators.

Parameters
----------
function : List or tuple with two Functions. The two functions.

x : Numpy array. The point that we wish to compute the proximal
        operator of.

Overrides: bases.ExplicitAlgorithm.run

Class Variable Details

[hide private]

INTERFACES

Value:

[<class 'parsimony.functions.properties.Function'>,
 <class 'parsimony.functions.properties.ProximalOperator'>]

Class DykstrasProximalAlgorithm

__init__(self, eps=5e-08, max_iter=1000, min_iter=1) (Constructor)

run(self, function, x)

INTERFACES

init(self, eps=5e-08, max_iter=1000, min_iter=1)
(Constructor)