josiann.moves.discrete.DiscreteMove

class josiann.moves.discrete.DiscreteMove(*, position_set, bounds=None, repr_attributes=(), **kwargs)[source]

Base class for building moves that work on a discrete set of valid positions.

Instantiate a Move.

Parameters:

position_set (Sequence[Sequence[float] | ndarray[tuple[int, ...], dtype[floating[Any]]]]) – sets of only possible values for x in each dimension.
bounds (Optional[ndarray[tuple[int, ...], dtype[float64 | int64]]] (default: None)) – optional sequence of (min, max) bounds for values to propose in each dimension.
repr_attributes (tuple[str, ...] (default: ())) – tuple of attribute names to include in the move’s representation.
kwargs (Any)

Methods

`DiscreteMove.__init__`	Instantiate a Move.
`DiscreteMove.get_proposal`	Generate a new proposed vector x.
`DiscreteMove.set_bounds`	Set bounds for the move.

Methods

DiscreteMove.__init__(*, position_set, bounds=None, repr_attributes=(), **kwargs)[source]

Instantiate a Move.

Parameters:

position_set (Sequence[Sequence[float] | ndarray[tuple[int, ...], dtype[floating[Any]]]]) – sets of only possible values for x in each dimension.

bounds (Optional[ndarray[tuple[int, ...], dtype[float64 | int64]]] (default: None)) – optional sequence of (min, max) bounds for values to propose in each dimension.

repr_attributes (tuple[str, ...] (default: ())) – tuple of attribute names to include in the move’s representation.

kwargs (Any)

DiscreteMove.get_proposal(x, state)

Generate a new proposed vector x.

Parameters:

x (ndarray[tuple[int, ...], dtype[TypeVar(DT_ARR, bound= float64 | int64)]]) – current vector x of shape (ndim,).

state (State) – current state of the SA algorithm.

Return type:

ndarray[tuple[int, ...], dtype[TypeVar(DT_ARR, bound= float64 | int64)]]

Returns:

New proposed vector x of shape (ndim,).

DiscreteMove.set_bounds(bounds)

Set bounds for the move.

Parameters:

bounds (tuple[float, float] | Sequence[tuple[float, float]] | None) – sequence of (min, max) bounds for values to propose in each dimension.

Return type:

None