ListOp

class qiskit.opflow.list_ops.ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)

Bases : OperatorBase

Deprecated: A Class for manipulating List Operators, and parent class to SummedOp, ComposedOp and TensoredOp.

List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or combo_fn defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the ListOp. For example, a SummedOp has an addition-based combo_fn, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the SummedOp’s evaluation. In theory, this combo_fn can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling to_matrix on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators” underlying function is combined to form the underlying Operator function of the ListOp. In this way, the ListOps are the basis for constructing large and sophisticated Operators, State Functions, and Measurements.

The base ListOp class is particularly interesting, as its combo_fn is « the identity list Operation ». Meaning, if we understand the combo_fn as a function from a list of complex values to some output, one such function is returning the list as-is. This is powerful for constructing compact hierarchical Operators which return many measurements in multiple dimensional lists.

Obsolète depuis la version 0.24.0: The class qiskit.opflow.list_ops.list_op.ListOp is deprecated as of qiskit-terra 0.24.0. It will be removed no earlier than 3 months after the release date. For code migration guidelines, visit https://qisk.it/opflow_migration.

Paramètres:

• oplist (Sequence[OperatorBase]) – The list of OperatorBases defining this Operator’s underlying function.

• combo_fn (Callable | None) – The recombination function to combine classical results of the oplist Operators” eval functions (e.g. sum). Default is lambda x: x.

• coeff (complex | ParameterExpression) – A coefficient multiplying the operator

• abelian (bool) – Indicates whether the Operators in oplist are known to mutually commute.

• grad_combo_fn (Callable | None) – The gradient of recombination function. If None, the gradient will be computed automatically.

• the (Note that the default "recombination function" lambda above is essentially) –

• values (identity - it accepts the list of) –

• list. (and returns them in a) –

Attributes

INDENTATION = '  '

abelian

Whether the Operators in oplist are known to commute with one another.

Renvoie:

A bool indicating whether the oplist is Abelian.

coeff

The scalar coefficient multiplying the Operator.

Renvoie:

The coefficient.

coeffs

Return a list of the coefficients of the operators listed. Raises exception for nested Listops.

combo_fn

The function defining how to combine oplist (or Numbers, or NumPy arrays) to produce the Operator’s underlying function. For example, SummedOp’s combination function is to add all of the Operators in oplist.

Renvoie:

The combination function.

distributive

Indicates whether the ListOp or subclass is distributive under composition. ListOp and SummedOp are, meaning that (opv @ op) = (opv[0] @ op + opv[1] @ op) (using plus for SummedOp, list for ListOp, etc.), while ComposedOp and TensoredOp do not behave this way.

Renvoie:

A bool indicating whether the ListOp is distributive under composition.

grad_combo_fn

The gradient of combo_fn.

instance_id

Return the unique instance id.

num_qubits

oplist

The list of OperatorBases defining the underlying function of this Operator.

Renvoie:

The Operators defining the ListOp

parameters

settings

Return settings.

Methods

add(other)

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

Paramètres:

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

Renvoie:

An OperatorBase equivalent to the sum of self and other.

Type renvoyé:

ListOp

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.

Renvoie:

An OperatorBase equivalent to the adjoint of self.

Type renvoyé:

ListOp

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ètres:

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

Renvoie:

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.

Type renvoyé:

OperatorBase

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

Return Operator Composition between self and other (linear algebra-style: A@B(x) = A(B(x))), overloaded by @.

Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like

-[Y]-[X]-

Because Terra prints circuits with the initial state at the left side of the circuit.

Paramètres:

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

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

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

Renvoie:

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

Type renvoyé:

OperatorBase

static default_combo_fn(x)

ListOp default combo function i.e. lambda x: x

Type renvoyé:

Any

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.

Paramètres:

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

Renvoie:

A bool equal to the equality of self and other.

Type renvoyé:

bool

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

ListOp’s eval recursively evaluates each Operator in oplist, and combines the results using the recombination function combo_fn.

Paramètres:

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

Renvoie:

The output of the oplist Operators” evaluation function, combined with the combo_fn. 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.

Lève:

• NotImplementedError – Raised if called for a subclass which is not distributive.

• TypeError – Operators with mixed hierarchies, such as a ListOp containing both PrimitiveOps and ListOps, are not supported.

• NotImplementedError – Attempting to call ListOp’s eval from a non-distributive subclass.

Type renvoyé:

OperatorBase | complex

exp_i()

Return an OperatorBase equivalent to an exponentiation of self * -i, e^(-i*op).

Type renvoyé:

OperatorBase

log_i(massive=False)

Return a MatrixOp equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies log_i to all ops in oplist.

Type renvoyé:

OperatorBase

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

Paramètres:

scalar (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.

Renvoie:

An OperatorBase equivalent to product of self and scalar.

Type renvoyé:

ListOp

permute(permutation)

Permute the qubits of the operator.

Paramètres:

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

Renvoie:

A new ListOp representing the permuted operator.

Lève:

OpflowError – if indices do not define a new index for each qubit.

Type renvoyé:

OperatorBase

power(exponent)

Return Operator composed with self multiple times, overloaded by **.

Type renvoyé:

OperatorBase

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.

Renvoie:

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

Type renvoyé:

Set[str]

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.

Renvoie:

The reduced OperatorBase.

Type renvoyé:

OperatorBase

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, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like

-[Y]- -[X]-

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

Paramètres:

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

Renvoie:

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

Type renvoyé:

OperatorBase

tensorpower(other)

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

Paramètres:

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

Renvoie:

An OperatorBase equivalent to the tensorpower of self by other.

Type renvoyé:

OperatorBase | int

to_circuit_op()

Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as CircuitOp and CircuitStateFn.

Type renvoyé:

OperatorBase

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.

Renvoie:

The NumPy ndarray equivalent to this Operator.

Type renvoyé:

ndarray

to_matrix_op(massive=False)

Returns an equivalent Operator composed of only NumPy-based primitives, such as MatrixOp and VectorStateFn.

Type renvoyé:

ListOp

to_pauli_op(massive=False)

Returns an equivalent Operator composed of only Pauli-based primitives, such as PauliOp.

Type renvoyé:

ListOp

to_spmatrix()

Returns SciPy sparse matrix representation of the Operator.

Renvoie:

CSR sparse matrix representation of the Operator, or List thereof.

Type renvoyé:

spmatrix | List[spmatrix]

traverse(convert_fn, coeff=None)

Apply the convert_fn to each node in the oplist.

Paramètres:

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

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

Renvoie:

The converted ListOp.

Type renvoyé:

ListOp