iterative

iterative#

Base class for iterative algorithms

Classes#

`StateItem`	Base class for dataclasses that should act like a JAX pytree node.
`AttributeStateItem`	Base class for dataclasses that should act like a JAX pytree node.
`ConsErrStateItem`	Base class for dataclasses that should act like a JAX pytree node.
`PosStateItem`	Base class for dataclasses that should act like a JAX pytree node.
`CellStateItem`	Base class for dataclasses that should act like a JAX pytree node.
`Hook`	Base class for dataclasses that should act like a JAX pytree node.

Module Contents#

class iterative.StateItem(*args, **kwargs)#

Bases: IMLCV.base.datastructures.MyPyTreeNode

Base class for dataclasses that should act like a JAX pytree node.

key: str#

value: Any#

update(iterative)#

abstract get_value(iterative) → Any#

class iterative.AttributeStateItem(*args, **kwargs)#

Bases: StateItem

Base class for dataclasses that should act like a JAX pytree node.

get_value(iterative)#

class iterative.ConsErrStateItem(*args, **kwargs)#

Bases: StateItem

Base class for dataclasses that should act like a JAX pytree node.

get_value(iterative)#

class iterative.PosStateItem(*args, **kwargs)#

Bases: StateItem

Base class for dataclasses that should act like a JAX pytree node.

key = 'pos'#

get_value(iterative)#

class iterative.CellStateItem(*args, **kwargs)#

Bases: StateItem

Base class for dataclasses that should act like a JAX pytree node.

key = 'cell'#

get_value(iterative)#

class iterative.Hook(*args, **kwargs)#

Bases: IMLCV.base.datastructures.MyPyTreeNode

Base class for dataclasses that should act like a JAX pytree node.

name: str#

kind: str#

method: str#

start: jax.Array#

step: jax.Array#

expects_call(counter)#

abstract __call__(iterative)#