qiskit.opflow.state_fns
State Functions
qiskit.opflow.state_fns
The qiskit.opflow module is deprecated and will be removed no earlier than 3 months after the release date. For code migration guidelines, visit https://qisk.it/opflow_migration(opens in a new tab).
State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method.
Measurements are defined to be functionals over StateFns, taking them to real values. Generally, this real value is interpreted to represent the probability of some classical state (binary string) being observed from a probabilistic or quantum system represented by a StateFn. This leads to the equivalent definition, which is that a measurement m is a function over binary strings producing StateFns, such that the probability of measuring a given binary string b from a system with StateFn f is equal to the inner product between f and m(b).
All mathematical methods between StateFns are not in-place, meaning that they return a new object, but the underlying primitives are not copied.
State functions here are not restricted to wave functions, as there is no requirement of normalization.
State Functions
StateFn([primitive, coeff, is_measurement]) | Deprecated: A class for representing state functions and measurements. |
CircuitStateFn(*args, **kwargs) | Deprecated: A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from |0⟩, and stored using Terra's QuantumCircuit class. |
DictStateFn(*args, **kwargs) | Deprecated: A class for state functions and measurements which are defined by a lookup table, stored in a dict. |
VectorStateFn(*args, **kwargs) | Deprecated: A class for state functions and measurements which are defined in vector representation, and stored using Terra's Statevector class. |
SparseVectorStateFn(*args, **kwargs) | Deprecated: A class for sparse state functions and measurements in vector representation. |
OperatorStateFn(*args, **kwargs) | Deprecated: A class for state functions and measurements which are defined by a density Operator, stored using an OperatorBase. |
CVaRMeasurement(*args, **kwargs) | Deprecated: A specialized measurement class to compute CVaR expectation values. |