Package linear_operators :: Package iterative :: Module algorithms :: Class Algorithm

Class Algorithm

object --+
         |
        Algorithm

Known Subclasses:


Abstract class to define iterative algorithms.

Attributes
----------

iter_ : int
    Current iteration number.

Methods
-------

initialize : Set variables to initial state
iterate : perform one iteration and return current solution
callback : user-defined function to print status or save variables
cont : continue the optimization skipping initialiaztion
__call__ : perform the optimization unt stop_condition is reached

Instance Methods

[hide private]

initialize(self)

source code

callback(self)

source code

iterate(self)
Perform one iteration and returns current solution.

source code

at_exit(self)
Perform some task at exit.

source code

__call__(self)
Perform the optimization.

source code

cont(self)
Continue an interrupted estimation (like call but avoid initialization).

source code

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

at_exit(self)

source code

Perform some task at exit. Does nothing by default.