josiann.moves.base.State

class josiann.moves.base.State(complementary_set, iteration, max_iter)[source]

Object for describing the current state of the SA algorithm.

Parameters:

complementary_set (ndarray[Any, dtype[Union[float64, int64]]]) – matrix of position vectors from walkers other than the one to update.
iteration (int) – current iteration number.
max_iter (int) – maximum iteration number.

Method generated by attrs for class State.

Attributes

`State.complementary_set`	matrix of position vectors from walkers other than the one to update.
`State.iteration`	current iteration number.
`State.max_iter`	maximum iteration number.

Methods

State.__init__

Method generated by attrs for class State.

Attributes

State.complementary_set: ndarray[Any, dtype[Union[float64, int64]]]

matrix of position vectors from walkers other than the one to update.

State.iteration: int

current iteration number.

State.max_iter: int

maximum iteration number.

Methods

State.__init__(complementary_set, iteration, max_iter)

Method generated by attrs for class State.

Parameters:

complementary_set (ndarray[Any, dtype[float64 | int64]]) –

iteration (int) –

max_iter (int) –

Return type:

None