IterativeAlgorithm

class IterativeAlgorithm(*args)

Iterative algorithm

Parameters:

dimensionint, default=1

Dimension of the input data.

Methods

getClassName()	Accessor to the object's name.
getDimension()	Get the dimension of the algorithm
getId()	Accessor to the object's id.
getImplementation()	Accessor to the underlying implementation.
getIterationNumber()	Get the current iteration of the algorithm
getName()	Accessor to the object's name.
increment(*args)	Increment the internal data.
setName(name)	Accessor to the object's name.

Notes

Base class for iterative algorithms: persistent objects that can be incremented iteratively.

__init__(*args)

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

The object class name (object.__class__.__name__).

getDimension()

Get the dimension of the algorithm

Returns:

dimensionint

Dimension of the algorithm

getId()

Accessor to the object’s id.

Returns:

idint

Internal unique identifier.

getImplementation()

Accessor to the underlying implementation.

Returns:

implImplementation

A copy of the underlying implementation object.

getIterationNumber()

Get the current iteration of the algorithm

Returns:

iterationint

Current iteration of the algorithm

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

increment(*args)

Increment the internal data.

Parameters:

datasequence of float or 2-d sequence of float

New input point or sample.

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.