Package parsimony :: Package algorithms :: Module bases :: Class IterativeAlgorithm

Class IterativeAlgorithm

object --+
         |
        IterativeAlgorithm

Known Subclasses:

Algorithms that require iterative steps to achieve the goal.

Fields
------
max_iter : Non-negative integer. The maximum number of allowed iterations.

min_iter : Non-negative integer less than or equal to max_iter. The minimum
        number of iterations that must be performed. Default is 1.

num_iter : Non-negative integer greater than or equal to min_iter. The
        number of iterations performed by the iterative algorithm. All
        algorithms that inherit from IterativeAlgortihm MUST call
        iter_reset before every run.

Parameters
----------
max_iter : Non-negative integer. The maximum number of allowed iterations.

min_iter : Non-negative integer. The minimum number of required iterations.

Instance Methods

[hide private]

__init__(self, max_iter=10000, min_iter=1, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

iter_reset(self)

source code

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, max_iter=10000, min_iter=1, **kwargs)
(Constructor)

source code

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

Overrides: object.__init__: (inherited documentation)

Class IterativeAlgorithm

__init__(self, max_iter=10000, min_iter=1, **kwargs) (Constructor)

init(self, max_iter=10000, min_iter=1, **kwargs)
(Constructor)