SparseVectorStateFn¶

class SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)[source]¶

Bases: qiskit.opflow.state_fns.state_fn.StateFn

A class for sparse state functions and measurements in vector representation.

This class uses scipy.sparse.spmatrix for the internal representation.

Parameters

primitive (spmatrix) – The underlying sparse vector.
coeff (Union[complex, ParameterExpression]) – A coefficient multiplying the state function.
is_measurement (bool) – Whether the StateFn is a measurement operator

Raises

ValueError – If the primitive is not a column vector.
ValueError – If the number of elements in the primitive is not a power of 2.

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 `~`.
`equals`	Evaluate Equality between Operators, overloaded by `==`.
`eval`	Evaluate the Operator’s underlying function, either on a binary string or another Operator.
`primitive_strings`	Return a set of strings describing the primitives contained in the Operator.
`sample`	Sample the state function as a normalized probability distribution.
`to_circuit_op`	Convert this state function to a `CircuitStateFn`.
`to_dict_fn`	Convert this state function to a `DictStateFn`.
`to_matrix`	Return NumPy representation of the Operator.
`to_matrix_op`	Return a `VectorStateFn` for this `StateFn`.
`to_spmatrix`	Return SciPy sparse matrix representation of the Operator.

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: scipy.sparse.base.spmatrix¶: The primitive which defines the behavior of the underlying State function.

settings¶

Return settings.