DictStateFn¶

class DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)[source]¶

A class for state functions and measurements which are defined by a lookup table, stored in a dict.

Parameters

primitive (Union[str, dict, Result, None]) -- The dict, single bitstring (if defining a basis sate), or Qiskit Result, which defines the behavior of the underlying function.
coeff (Union[complex, ParameterExpression]) -- A coefficient by which to multiply the state function.
is_measurement (bool) -- Whether the StateFn is a measurement operator.
from_operator (bool) -- if True the StateFn is derived from OperatorStateFn. (Default: False)

Raises

TypeError -- invalid parameters.

Methods Defined Here

`add`	Return Operator addition of self and other, overloaded by `+`.
`adjoint`	Return a new Operator equal to the Operator's adjoint (conjugate transpose), overloaded by `~`.
`eval`	Evaluate the Operator's underlying function, either on a binary string or another Operator.
`permute`	Permute the qubits of the state function.
`primitive_strings`	Return a set of strings describing the primitives contained in the Operator.
`sample`	Sample the state function as a normalized probability distribution.
`tensor`	Return tensor product between self and other, overloaded by `^`.
`to_circuit_op`	Convert this state function to a `CircuitStateFn`.
`to_density_matrix`	Return matrix representing product of StateFn evaluated on pairs of basis states.
`to_matrix`	Return NumPy representation of the Operator.
`to_spmatrix`	Same as to_matrix, but returns csr sparse matrix.
`to_spmatrix_op`	Convert this state function to a `SparseVectorStateFn`.

Attributes

coeff¶

A coefficient by which the state function is multiplied.

instance_id¶

Return the unique instance id.

is_measurement¶

Whether the StateFn object is a measurement Operator.

num_qubits¶

primitive: Dict[str, complex]¶: The primitive which defines the behavior of the underlying State function.

settings¶

Return settings.