Typing

Type hints for common dimod inputs.

Bias

A Union representing objects that can be used as biases.

This includes:

• Python’s int and float.

• NumPy’s floating and integer.

alias of float | floating | integer

GraphLike

Objects that can be interpreted as a graph.

This includes:

• An int, interpreted as a complete graph with nodes labelled range(n).

• A list of edges

• A 2-tuple containing a list of nodes and a list of edges

• A networkx.Graph.

alias of int | tuple[Collection[Hashable], Collection[tuple[Hashable, Hashable]]] | Collection[tuple[Hashable, Hashable]] | Graph

Polynomial

A polynomial represented by a mapping.

SampleLike

Objects that can be interpreted as a single sample.

This includes:

• A one-dimensional NumPy array_like.

• A 2-tuple containing a one-dimensional NumPy array_like and a list of variable labels.

• A dict where the keys are variable labels and the values are the assignments.

NumPy array_like is a very flexible definition.

alias of Sequence[float | floating | integer] | Mapping[Hashable, float | floating | integer] | tuple[Sequence[float | floating | integer], Sequence[Hashable]] | tuple[ndarray, Sequence[Hashable]] | ndarray

SamplesLike

Objects that can be interpreted as a collection of samples.

This includes:

• Any SampleLike.

• A two-dimensional NumPy array_like.

• A 2-tuple containing a two-dimensional array_like and a list of variable labels.

• A list of dict where each dict has the same keys.

alias of Sequence[float | floating | integer] | Mapping[Hashable, float | floating | integer] | tuple[Sequence[float | floating | integer], Sequence[Hashable]] | tuple[ndarray, Sequence[Hashable]] | ndarray | Sequence[Sequence[float | floating | integer]] | tuple[Sequence[Sequence[float | floating | integer]], Sequence[Hashable]] | Sequence[Sequence[float | floating | integer] | Mapping[Hashable, float | floating | integer] | tuple[Sequence[float | floating | integer], Sequence[Hashable]] | tuple[ndarray, Sequence[Hashable]] | ndarray] | Iterator[Sequence[float | floating | integer] | Mapping[Hashable, float | floating | integer] | tuple[Sequence[float | floating | integer], Sequence[Hashable]] | tuple[ndarray, Sequence[Hashable]] | ndarray]

Variable

Objects that can be used as variable labels.

Note

In dimod variables can be labelled using any hashable object except for None. However, for simplicity we alias Hashable which does permit None.

VartypeLike

Objects that can be interpreted as a variable type.

This includes:

• SPIN, 'SPIN', {-1, 1}

• BINARY, 'BINARY', {0, 1}

• INTEGER, 'INTEGER'

• REAL, 'REAL'