mici.types module

Type aliases.

mici.types.AdaptationStatisticFunction

Function returning adaptation statistic given dictionary of transition statistics.

alias of Callable[[dict[str, bool | int | float | LogRepFloat | number]], float]

mici.types.AdapterState

Dictionary defining current state of an mici.adapters.Adapter.

alias of dict[str, Any]

mici.types.ArrayFunction

Function taking an array-like input and returning a array-like output.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]]

mici.types.GradientFunction

Function returning the gradient of a scalar-valued function.

May optionally also return scalar-like value of function.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str] | tuple[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str], bool | int | float | LogRepFloat | number]]

mici.types.HessianFunction

Function returning the Hessian matrix of a scalar-valued function.

May optionally also return gradient and value of function.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str] | tuple[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str], bool | int | float | LogRepFloat | number]]

mici.types.JacobianFunction

Function returning the Jacobian of a array (vector) valued function.

May optionally aslo return the array value of the function.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str] | tuple[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]]]

mici.types.MatrixHessianProduct

Function returning the product between a matrix and Hessian of an array function.

Hessian here is the 3-dimensional array of second-order derivatives of an array-valued function.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]]

mici.types.MatrixHessianProductFunction

Function returning a matrix-Hessian product function for an array function.

Hessian here is the 3-dimensional array of second-order derivatives of an array-valued function.

May optionally also return the Jacobian matrix and array value of function.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]] | tuple[Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]]]

mici.types.MatrixLike

Matrix like objects.

alias of Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str] | Matrix

mici.types.MatrixTressianProduct

Function returning the product between a matrix and ‘Tressian’ of a scalar function.

Tressian here is the 3-dimensional array of third-order derivatives of a scalar function.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]]

mici.types.MatrixTressianProductFunction

Function returning a matrix-Tressian product function for a scalar function.

Tressian here is the 3-dimensional array of third-order derivatives of a scalar function.

May optionally also return the Hessian matrix, gradient and value of function.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]] | tuple[Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str], bool | int | float | LogRepFloat | number]]

mici.types.MetricLike

Metric (positive definite matrix) like objects.

alias of Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str] | PositiveDefiniteMatrix

mici.types.PyTree

Arbitrarily nested structure of Python dict, list and tuple types.

alias of dict[Any, PyTree] | list[PyTree] | tuple[PyTree] | T

mici.types.ReducerFunction

Function combining per-chain control variables from adapters.

alias of Callable[[Collection[float]], float]

mici.types.ScalarFunction

Function taking an array-like input and returning a scalar-like output.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], bool | int | float | LogRepFloat | number]

mici.types.ScalarLike: TypeAlias = bool | int | float | mici.utils.LogRepFloat | numpy.number

Scalar like objects.

mici.types.SystemStateMethod

System method computing function of chain state.

alias of Callable[[System, ChainState], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str] | bool | int | float | LogRepFloat | number]

mici.types.SystemStateWithAuxMethod

System method computing function chain state with auxiliary return values.

alias of Callable[[System, ChainState], tuple[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str] | bool | int | float | LogRepFloat | number, …]]

mici.types.TerminationCriterion

Function indicating whether to terminate trajectory tree expansion.

alias of Callable[[System, ChainState, ChainState, Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], bool]

mici.types.TraceFunction

Function returning a dictionary of chain variables to trace given chain state.

alias of Callable[[ChainState], dict[str, Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]]]

mici.types.TransitionStatistics

Dictionary of statistics computed by mici.transitions.Transition.sample()

alias of dict[str, bool | int | float | LogRepFloat | number]

mici.types.VectorJacobianProduct

Function returning the product between an array and Jacobian of a array function.

Jacobian here is the (d+1)-dimensional array of first-order derivatives of an d-dimensional array-valued function taking a 1-dimensional array as input.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]]

mici.types.VectorJacobianProductFunction

Function returning a vector-Jaccobian product function for an array function.

Jacobian here is the (d+1)-dimensional array of first-order derivatives of an d-dimensional array-valued function taking a 1-dimensional array as input.

May optionally also return the array value of function.

alias of Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]] | tuple[Callable[[Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]], Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]]]