PauliOp¶

class PauliOp(primitive, coeff=1.0)[source]¶

Bases: qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp

Class for Operators backed by Terra’s Pauli module.

Parameters

primitive (Pauli) – The Pauli which defines the behavior of the underlying function.
coeff (Union[complex, ParameterExpression]) – A coefficient multiplying the primitive.

Raises

TypeError – invalid parameters.

Methods Defined Here

`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 `~`.
`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.
`permute`	Permutes the sequence of Pauli matrices.
`primitive_strings`	Return a set of strings describing the primitives contained in the Operator.
`tensor`	Return tensor product between self and other, overloaded by `^`.
`to_circuit`	Returns a `QuantumCircuit` equivalent to this Operator.
`to_instruction`	Returns an `Instruction` equivalent to this Operator.
`to_matrix`	Return NumPy representation of the Operator.
`to_pauli_op`	Returns a sum of `PauliOp` s equivalent to this Operator.
`to_spmatrix`	Returns SciPy sparse matrix representation of the Operator.

Attributes

coeff¶

The scalar coefficient multiplying the Operator.

instance_id¶

Return the unique instance id.

num_qubits¶

primitive: qiskit.quantum_info.operators.symplectic.pauli.Pauli¶

The primitive defining the underlying function of the Operator.

Return type: Union[QuantumCircuit, Operator, Pauli, SparsePauliOp, OperatorBase]
Returns: The primitive object.

settings¶

Return operator settings.