dwave.optimization.symbols.Permutation

class Permutation

Permutation of the elements of a symbol.

Examples

This example creates a permutation of a constant symbol.

>>> from dwave.optimization.model import Model
>>> model = Model()
>>> C = model.constant([[1, 2, 3], [2, 3, 1], [0, 1, 0]])
>>> l = model.list(3)
>>> p = C[l, :][:, l]
>>> type(p)
<class 'dwave.optimization.symbols.Permutation'>

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
all()	Create an All symbol.
equals(other)	Compare whether two nodes are identical.
expired()
has_state([index])	Return the initialization status of the indexed state.
iter_predecessors()	Iterate over a node's predecessors in the model.
iter_successors()	Iterate over a node's successors in the model.
max()	Create a Max symbol.
maybe_equals(other)	Compare to another symbol.
min()	Create a Min symbol.
ndim()	Return the number of dimensions for a symbol.
prod()	Create a Prod symbol.
reset_state(index)	Reset the state of a node and any successor symbols.
reshape(*shape)	Create a Reshape symbol.
shape()	Return the shape of the symbol.
shares_memory(other)	Determine if two symbols share memory.
size()	Return the number of elements in the symbol.
state([index, copy])	Return the state of the node.
state_size()	Return an estimated byte-size of the state.
strides()	Return the stride length, in bytes, for traversing a symbol.
sum()	Create a Sum symbol.
topological_index()	Topological index of the node.

Attributes

model