CircuitStateFn

class CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)

Bases: qiskit.aqua.operators.state_fns.state_fn.StateFn

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.

Parameters

• primitive (Union[QuantumCircuit, Instruction, None]) – The QuantumCircuit (or Instruction, which will be converted) which defines the behavior of the underlying function.

• coeff (Union[int, float, complex, ParameterExpression]) – A coefficient multiplying the state function.

• is_measurement (bool) – Whether the StateFn is a measurement operator.

Raises

TypeError – Unsupported primitive, or primitive has ClassicalRegisters.

Methods

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 ~.
assign_parameters	Binds scalar values to any Terra Parameters in the coefficients or primitives of the Operator, or substitutes one Parameter for another.
bind_parameters	Same as assign_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign_parameters and bind_parameters).
compose	Composition (Linear algebra-style: A@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements.
equals	Evaluate Equality between Operators, overloaded by ==.
eval	Evaluate the Operator’s underlying function, either on a binary string or another Operator.
from_dict	Construct the CircuitStateFn from a dict mapping strings to probability densities.
from_vector	Construct the CircuitStateFn from a vector representing the statevector.
mul	Returns the scalar multiplication of the Operator, overloaded by *, including support for Terra’s Parameters, which can be bound to values later (via bind_parameters).
neg	Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by -.
permute	Permute the qubits of the circuit.
power	Compose with Self Multiple Times, undefined for StateFns.
primitive_strings	Return a set of strings describing the primitives contained in the Operator.
reduce	Try collapsing the Operator structure, usually after some type of conversion, e.g.
sample	Sample the state function as a normalized probability distribution.
tensor	Return tensor product between self and other, overloaded by ^.
tensorpower	Return tensor product with self multiple times, overloaded by ^.
to_circuit	Return QuantumCircuit representing StateFn
to_circuit_op	Return StateFnCircuit corresponding to this StateFn.
to_density_matrix	Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix.
to_instruction	Return Instruction corresponding to primitive.
to_legacy_op	Attempt to return the Legacy Operator representation of the Operator.
to_matrix	Return NumPy representation of the Operator.
to_matrix_op	Return a VectorStateFn for this StateFn.
traverse	Apply the convert_fn to the internal primitive if the primitive is an Operator (as in the case of OperatorStateFn).

Attributes

ENABLE_DEPRECATION = True

INDENTATION = ' '

coeff

A coefficient by which the state function is multiplied.

Return type

Union[int, float, complex, ParameterExpression]

is_measurement

Whether the StateFn object is a measurement Operator.

Return type

bool

num_qubits

Return type

int

parameters

primitive

The primitive which defines the behavior of the underlying State function.