VectorStateFn¶
- class VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)[source]¶
Bases:
qiskit.opflow.state_fns.state_fn.StateFn
A class for state functions and measurements which are defined in vector representation, and stored using Terra’s
Statevector
class.- Parameters
primitive (
Union
[list
,ndarray
,Statevector
,None
]) – TheStatevector
, NumPy array, or list, which defines the behavior of the underlying function.coeff (
Union
[complex
,ParameterExpression
]) – A coefficient multiplying the state function.is_measurement (
bool
) – Whether the StateFn is a measurement operator
Methods Defined Here
Return Operator addition of self and other, overloaded by
+
.Return a new Operator equal to the Operator's adjoint (conjugate transpose), overloaded by
~
.Evaluate the Operator's underlying function, either on a binary string or another Operator.
Permute the qubits of the state function.
Return a set of strings describing the primitives contained in the Operator.
Sample the state function as a normalized probability distribution.
Return tensor product between self and other, overloaded by
^
.Return
StateFnCircuit
corresponding to this StateFn.Return matrix representing product of StateFn evaluated on pairs of basis states.
Creates the equivalent state function of type DictStateFn.
Return NumPy representation of the Operator.
Return a
VectorStateFn
for thisStateFn
.Attributes
- INDENTATION = ' '¶
- coeff¶
A coefficient by which the state function is multiplied.
- Return type
Union
[complex
,ParameterExpression
]
- instance_id¶
Return the unique instance id.
- Return type
int
- is_measurement¶
Whether the StateFn object is a measurement Operator.
- Return type
bool
- num_qubits¶
- Return type
int
- parameters¶
- primitive: qiskit.quantum_info.states.statevector.Statevector¶
The primitive which defines the behavior of the underlying State function.
- settings¶
Return settings.
- Return type
Dict