API

Algorithms

Sequential

sa	Simulated Annealing algorithm.
vsa	Simulated Annealing using vectorized cost functions for computing multiple function evaluations at once.
mcsa	Simulated Annealing running a vectorized cost function on multiple CPU cores in parallel for computing multiple function evaluations at once.

Parallel

parallel.psa	Simulated Annealing algorithm solving multiple problems in parallel.
parallel.ParallelArgument	Object passed to parallel cost functions which holds instructions on what should be computed.

Moves

moves.base.State	Object for describing the current state of the SA algorithm.
moves.base.Move	Base abstract class for defining how positions evolve in the SA algorithm.

Sequential

moves.sequential	Simple sequential move functions.
moves.discrete	Move functions that work on a discrete set of possible positions.
moves.ensemble	Move functions that use multiple walkers to better solve some types of problems.

Parallel

parallel.moves.base.ParallelMove	Base class for building moves that solve optimization problems in parallel.
parallel.moves.discrete	Discrete move functions designed to work with josiann's parallel mode.

Outputs

Result	Object for storing the results of a run.
Trace	Object for storing the trace history of an SA run.

Typing

typing.DType	alias of Union[float64, int64]
typing.DT_ARR	Type variable.