Typing¶
Type hints for common dimod inputs.
- Bias[source]¶
A
Union
representing objects that can be used as biases.This includes:
alias of
Union
[float
,numpy.floating
,numpy.integer
]
- GraphLike[source]¶
Objects that can be interpreted as a graph.
This includes:
An
int
, interpreted as a complete graph with nodes labelledrange(n)
.A list of edges
A 2-tuple containing a list of nodes and a list of edges
alias of
Union
[int
,Tuple
[Collection
[Hashable
],Collection
[Tuple
[Hashable
,Hashable
]]],Collection
[Tuple
[Hashable
,Hashable
]],networkx.classes.graph.Graph
]
- Polynomial[source]¶
A polynomial represented by a mapping.
alias of
Mapping
[Sequence
[Hashable
],Union
[float
,numpy.floating
,numpy.integer
]]
- SampleLike[source]¶
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
Union
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]],Mapping
[Hashable
,Union
[float
,numpy.floating
,numpy.integer
]],Tuple
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]],Sequence
[Hashable
]],Tuple
[numpy.ndarray
,Sequence
[Hashable
]],numpy.ndarray
]
- SamplesLike[source]¶
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.
alias of
Union
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]],Mapping
[Hashable
,Union
[float
,numpy.floating
,numpy.integer
]],Tuple
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]],Sequence
[Hashable
]],Tuple
[numpy.ndarray
,Sequence
[Hashable
]],numpy.ndarray
,Sequence
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]]],Tuple
[Sequence
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]]],Sequence
[Hashable
]],Sequence
[Union
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]],Mapping
[Hashable
,Union
[float
,numpy.floating
,numpy.integer
]],Tuple
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]],Sequence
[Hashable
]],Tuple
[numpy.ndarray
,Sequence
[Hashable
]],numpy.ndarray
]],Iterator
[Union
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]],Mapping
[Hashable
,Union
[float
,numpy.floating
,numpy.integer
]],Tuple
[Sequence
[Union
[float
,numpy.floating
,numpy.integer
]],Sequence
[Hashable
]],Tuple
[numpy.ndarray
,Sequence
[Hashable
]],numpy.ndarray
]]]