MatrixOp

class MatrixOp(primitive, coeff=1.0)

Bases: qiskit.aqua.operators.primitive_ops.primitive_op.PrimitiveOp

Class for Operators represented by matrices, backed by Terra’s Operator module.

Parameters

• primitive (Union[list, ndarray, spmatrix, Operator]) – The matrix-like object which defines the behavior of the underlying function.

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

Raises

• TypeError – invalid parameters.

• ValueError – invalid parameters.

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	Return Operator Composition between self and other (linear algebra-style: A@B(x) = A(B(x))), overloaded by @.
equals	Evaluate Equality between Operators, overloaded by ==.
eval	Evaluate the Operator’s underlying function, either on a binary string or another Operator.
exp_i	Return a CircuitOp equivalent to e^-iH for this operator H
log_i	Return a MatrixOp equivalent to log(H)/-i for this operator H.
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	Creates a new MatrixOp that acts on the permuted qubits.
power	Return Operator composed with self multiple times, overloaded by **.
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.
tensor	Return tensor product between self and other, overloaded by ^.
tensorpower	Return tensor product with self multiple times, overloaded by ^.
to_circuit	Returns a QuantumCircuit equivalent to this Operator.
to_circuit_op	Returns a CircuitOp equivalent to this Operator.
to_instruction	Returns an Instruction equivalent to this Operator.
to_legacy_op	Attempt to return the Legacy Operator representation of the Operator.
to_matrix	Return NumPy representation of the Operator.
to_matrix_op	Returns a MatrixOp equivalent to this Operator.
to_pauli_op	Returns a sum of PauliOp s equivalent to this Operator.

Attributes

ENABLE_DEPRECATION = True

INDENTATION = ' '

coeff

The scalar coefficient multiplying the Operator.

Return type

Union[int, float, complex, ParameterExpression]

Returns

The coefficient.

num_qubits

Return type

int

parameters

primitive

The primitive defining the underlying function of the Operator.

Return type

Union[Instruction, QuantumCircuit, List, ndarray, spmatrix, Operator, Pauli]

Returns

The primitive object.