TensoredOp¶
-
class
TensoredOp
(oplist, coeff=1.0, abelian=False)[source]¶ Bases:
qiskit.aqua.operators.list_ops.list_op.ListOp
A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in
oplist
are meant to be tensored together, and therefore if they reach a point in which they can be, such as after conversion to QuantumCircuits, they can be reduced by tensor product.- Parameters
oplist (
List
[OperatorBase
]) – The Operators being tensored.coeff (
Union
[int
,float
,complex
,ParameterExpression
]) – A coefficient multiplying the operatorabelian (
bool
) – Indicates whether the Operators inoplist
are known to mutually commute.
Methods
Return Operator addition of self and other, overloaded by
+
.Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by
~
.Binds scalar values to any Terra
Parameters
in the coefficients or primitives of the Operator, or substitutes oneParameter
for another.Same as assign_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign_parameters and bind_parameters).
Return Operator Composition between self and other (linear algebra-style: A@B(x) = A(B(x))), overloaded by
@
.Evaluate Equality between Operators, overloaded by
==
.Evaluate the Operator’s underlying function, either on a binary string or another Operator.
Return an
OperatorBase
equivalent to an exponentiation of self * -i, e^(-i*op).Return a
MatrixOp
equivalent to log(H)/-i for this operator H.Returns the scalar multiplication of the Operator, overloaded by
*
, including support for Terra’sParameters
, which can be bound to values later (viabind_parameters
).Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by
-
.Permute the qubits of the operator.
Return Operator composed with self multiple times, overloaded by
**
.Return a set of strings describing the primitives contained in the Operator.
Try collapsing the Operator structure, usually after some type of conversion, e.g.
Return tensor product between self and other, overloaded by
^
.Return tensor product with self multiple times, overloaded by
^
.Returns the quantum circuit, representing the tensored operator.
Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as
CircuitOp
andCircuitStateFn
.Attempt to return the Legacy Operator representation of the Operator.
Return NumPy representation of the Operator.
Returns an equivalent Operator composed of only NumPy-based primitives, such as
MatrixOp
andVectorStateFn
.Returns an equivalent Operator composed of only Pauli-based primitives, such as
PauliOp
.Returns SciPy sparse matrix representation of the Operator.
Apply the convert_fn to each node in the oplist.
Attributes
-
ENABLE_DEPRECATION
= True¶
-
INDENTATION
= ' '¶
-
abelian
¶ Whether the Operators in
oplist
are known to commute with one another.- Return type
bool
- Returns
A bool indicating whether the
oplist
is Abelian.
-
coeff
¶ The scalar coefficient multiplying the Operator.
- Return type
Union
[int
,float
,complex
,ParameterExpression
]- Returns
The coefficient.
-
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 inoplist
.- Return type
Callable
- Returns
The combination function.
-
distributive
¶ - Return type
bool
-
grad_combo_fn
¶ The gradient of
combo_fn
.- Return type
Optional
[Callable
]
-
num_qubits
¶ - Return type
int
-
oplist
¶ The list of
OperatorBases
defining the underlying function of this Operator.- Return type
List
[OperatorBase
]- Returns
The Operators defining the ListOp
-
parameters
¶