qiskit.aqua.operators.state_fns.DictStateFn

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

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

パラメータ

• 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[int, float, complex, ParameterExpression]) – A coefficient by which to multiply the state function.

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

例外

TypeError – invalid parameters.

__init__(primitive=None, coeff=1.0, is_measurement=False)

パラメータ

• 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[int, float, complex, ParameterExpression]) – A coefficient by which to multiply the state function.

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

例外

TypeError – invalid parameters.

Methods

__init__([primitive, coeff, is_measurement])	type primitive Union[str, dict, Result, None]
add(other)	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(param_dict)	Binds scalar values to any Terra Parameters in the coefficients or primitives of the Operator, or substitutes one Parameter for another.
bind_parameters(param_dict)	Same as assign_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign_parameters and bind_parameters).
compose(other[, permutation, front])	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(other)	Evaluate Equality between Operators, overloaded by ==.
eval([front])	Evaluate the Operator’s underlying function, either on a binary string or another Operator.
mul(scalar)	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(permutation)	Permute the qubits of the state function.
power(exponent)	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([shots, massive, reverse_endianness])	Sample the state function as a normalized probability distribution.
tensor(other)	Return tensor product between self and other, overloaded by ^.
tensorpower(other)	Return tensor product with self multiple times, overloaded by ^.
to_circuit_op()	Return StateFnCircuit corresponding to this StateFn.
to_density_matrix([massive])	Return matrix representing product of StateFn evaluated on pairs of basis states.
to_legacy_op([massive])	Attempt to return the Legacy Operator representation of the Operator.
to_matrix([massive])	Return NumPy representation of the Operator.
to_matrix_op([massive])	Return a VectorStateFn for this StateFn.
to_spmatrix()	Same as to_matrix, but returns csr sparse matrix.
traverse(convert_fn[, coeff])	Apply the convert_fn to the internal primitive if the primitive is an Operator (as in the case of OperatorStateFn).

Attributes

INDENTATION
coeff	A coefficient by which the state function is multiplied.
is_measurement	Whether the StateFn object is a measurement Operator.
num_qubits	The number of qubits over which the Operator is defined.
parameters	Return a set of Parameter objects contained in the Operator.
primitive	The primitive which defines the behavior of the underlying State function.

add(other)

Return Operator addition of self and other, overloaded by +.

パラメータ

other (OperatorBase) – An OperatorBase with the same number of qubits as self, and in the same 『Operator』, 『State function』, or 『Measurement』 category as self (i.e. the same type of underlying function).

戻り値の型

OperatorBase

戻り値

An OperatorBase equivalent to the sum of self and other.

adjoint()

Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by ~. For StateFns, this also turns the StateFn into a measurement.

戻り値の型

OperatorBase

戻り値

An OperatorBase equivalent to the adjoint of self.

assign_parameters(param_dict)

Binds scalar values to any Terra Parameters in the coefficients or primitives of the Operator, or substitutes one Parameter for another. This method differs from Terra’s assign_parameters in that it also supports lists of values to assign for a give Parameter, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an OpList. If lists of parameterizations are used, every Parameter in the param_dict must have the same length list of parameterizations.

パラメータ

param_dict (dict) – The dictionary of Parameters to replace, and values or lists of values by which to replace them.

戻り値の型

OperatorBase

戻り値

The OperatorBase with the Parameters in self replaced by the values or Parameters in param_dict. If param_dict contains parameterization lists, this OperatorBase is an OpList.

bind_parameters(param_dict)

Same as assign_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign_parameters and bind_parameters).

戻り値の型

OperatorBase

property coeff

A coefficient by which the state function is multiplied.

戻り値の型

Union[int, float, complex, ParameterExpression]

compose(other, permutation=None, front=False)

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.

パラメータ

• other (OperatorBase) – The Operator to compose with self.

• permutation (Optional[List[int]]) – List[int] which defines permutation on other operator.

• front (bool) – If front==True, return other.compose(self).

戻り値の型

OperatorBase

戻り値

An Operator equivalent to the function composition of self and other.

例外

ValueError – If self is not a measurement, it cannot be composed from the right.

equals(other)

Evaluate Equality between Operators, overloaded by ==. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal.

パラメータ

other (OperatorBase) – The OperatorBase to compare to self.

戻り値の型

bool

戻り値

A bool equal to the equality of self and other.

eval(front=None)

Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, op.eval('0110').eval('1110') can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those 「indices.」 Similarly for a StateFn, op.eval('1011') will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if .eval('0000') is already called implicitly to always 「indexing」 from column 0).

If front is None, the matrix-representation of the operator is returned.

パラメータ

front (Union[str, Dict[str, complex], ndarray, OperatorBase, None]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None.

戻り値の型

Union[OperatorBase, float, complex]

戻り値

The output of the Operator’s evaluation function. If self is a StateFn, the result is a float or complex. If self is an Operator (PrimitiveOp, ComposedOp, SummedOp, EvolvedOp, etc.), the result is a StateFn. If front is None, the matrix-representation of the operator is returned, which is a MatrixOp for the operators and a VectorStateFn for state-functions. If either self or front contain proper ListOps (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps.

property is_measurement

Whether the StateFn object is a measurement Operator.

戻り値の型

bool

mul(scalar)

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).

パラメータ

scalar (Union[int, float, complex, ParameterExpression]) – The real or complex scalar by which to multiply the Operator, or the ParameterExpression to serve as a placeholder for a scalar factor.

戻り値の型

OperatorBase

戻り値

An OperatorBase equivalent to product of self and scalar.

neg()

Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by -.

戻り値の型

OperatorBase

戻り値

An OperatorBase equivalent to the negation of self.

property num_qubits

The number of qubits over which the Operator is defined. If op.num_qubits == 5, then op.eval('1' * 5) will be valid, but op.eval('11') will not.

戻り値の型

int

戻り値

The number of qubits accepted by the Operator’s underlying function.

property parameters

Return a set of Parameter objects contained in the Operator.

permute(permutation)

Permute the qubits of the state function.

パラメータ

permutation (List[int]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation[j].

戻り値の型

DictStateFn

戻り値

A new StateFn containing the permuted primitive.

power(exponent)

Compose with Self Multiple Times, undefined for StateFns.

パラメータ

exponent (int) – The number of times to compose self with self.

例外

ValueError – This function is not defined for StateFns.

戻り値の型

OperatorBase

property primitive

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

primitive_strings()

Return a set of strings describing the primitives contained in the Operator. For example, {'QuantumCircuit', 'Pauli'}. For hierarchical Operators, such as ListOps, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied.

戻り値の型

Set[str]

戻り値

A set of strings describing the primitives contained within the Operator.

reduce()

Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self.

戻り値の型

OperatorBase

戻り値

The reduced OperatorBase.

sample(shots=1024, massive=False, reverse_endianness=False)

Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability.

パラメータ

• shots (int) – The number of samples to take to approximate the State function.

• massive (bool) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits.

• reverse_endianness (bool) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness.

戻り値の型

dict

戻り値

A dict containing pairs sampled strings from the State function and sampling frequency divided by shots.

tensor(other)

Return tensor product between self and other, overloaded by ^. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like

|0⟩– |+⟩–

Because Terra prints circuits and results with qubit 0 at the end of the string or circuit.

パラメータ

other (OperatorBase) – The OperatorBase to tensor product with self.

戻り値の型

OperatorBase

戻り値

An OperatorBase equivalent to the tensor product of self and other.

tensorpower(other)

Return tensor product with self multiple times, overloaded by ^.

パラメータ

other (int) – The int number of times to tensor product self with itself via tensorpower.

戻り値の型

Union[OperatorBase, int]

戻り値

An OperatorBase equivalent to the tensorpower of self by other.

to_circuit_op()

Return StateFnCircuit corresponding to this StateFn.

戻り値の型

OperatorBase

to_density_matrix(massive=False)

Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes.

パラメータ

massive (bool) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits.

戻り値の型

ndarray

戻り値

The NumPy array representing the density matrix of the State function.

例外

ValueError – If massive is set to False, and exponentially large computation is needed.

to_legacy_op(massive=False)

Attempt to return the Legacy Operator representation of the Operator. If self is a SummedOp of PauliOps, will attempt to convert to WeightedPauliOperator, and otherwise will simply convert to MatrixOp and then to MatrixOperator. The Legacy Operators cannot represent StateFns or proper ListOps (meaning not one of the ListOp subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self.

Warn if more than 16 qubits to force having to set massive=True if such a large vector is desired.

戻り値の型

LegacyBaseOperator

戻り値

The LegacyBaseOperator representing this Operator.

例外

TypeError – self is an Operator which cannot be represented by a LegacyBaseOperator, such as StateFn, proper (non-subclass) ListOp, or an Operator with an unbound coeff Parameter.

to_matrix(massive=False)

Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set massive=True if such a large vector is desired.

戻り値の型

ndarray

戻り値

The NumPy ndarray equivalent to this Operator.

to_matrix_op(massive=False)

Return a VectorStateFn for this StateFn.

パラメータ

massive (bool) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits.

戻り値の型

OperatorBase

戻り値

A VectorStateFn equivalent to self.

to_spmatrix()

Same as to_matrix, but returns csr sparse matrix.

戻り値の型

spmatrix

戻り値

CSR sparse matrix representation of the State function.

例外

ValueError – invalid parameters.

traverse(convert_fn, coeff=None)

Apply the convert_fn to the internal primitive if the primitive is an Operator (as in the case of OperatorStateFn). Otherwise do nothing. Used by converters.

パラメータ

• convert_fn (Callable) – The function to apply to the internal OperatorBase.

• coeff (Union[int, float, complex, ParameterExpression, None]) – A coefficient to multiply by after applying convert_fn. If it is None, self.coeff is used instead.

戻り値の型

OperatorBase

戻り値

The converted StateFn.