Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit. Switch to latest version

PauliSumOp

PauliSumOp(primitive, coeff=1.0, grouping_type='None')GitHub(opens in a new tab)

Bases: qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp

Class for Operators backed by Terra’s SparsePauliOp class.

Parameters

  • primitive (SparsePauliOp) – The SparsePauliOp which defines the behavior of the underlying function.
  • coeff (Union[complex, ParameterExpression]) – A coefficient multiplying the primitive.
  • grouping_type (str) – The type of grouping. If None, the operator is not grouped.

Raises

TypeError – invalid parameters.


Methods Defined Here

add

PauliSumOp.add(other)GitHub(opens in a new tab)

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

Parameters

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

Return type

OperatorBase

Returns

An OperatorBase equivalent to the sum of self and other.

adjoint

PauliSumOp.adjoint()GitHub(opens in a new tab)

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

Return type

PauliSumOp

Returns

An OperatorBase equivalent to the adjoint of self.

compose

PauliSumOp.compose(other, permutation=None, front=False)GitHub(opens in a new tab)

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.

Parameters

  • other (OperatorBase) – The OperatorBase with which to compose self.
  • permutation (Optional[List[int]]) – List[int] which defines permutation on other operator.
  • front (bool) – If front==True, return other.compose(self).

Return type

OperatorBase

Returns

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

equals

PauliSumOp.equals(other)GitHub(opens in a new tab)

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.

Parameters

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

Return type

bool

Returns

A bool equal to the equality of self and other.

eval

PauliSumOp.eval(front=None)GitHub(opens in a new tab)

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.

Parameters

front (Union[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, or None.

Return type

Union[OperatorBase, complex]

Returns

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.

exp_i

PauliSumOp.exp_i()GitHub(opens in a new tab)

Return a CircuitOp equivalent to e^-iH for this operator H.

Return type

OperatorBase

from_list

classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=<class 'complex'>)GitHub(opens in a new tab)

Construct from a pauli_list with the form [(pauli_str, coeffs)]

Parameters

  • pauli_list (List[Tuple[str, Union[complex, ParameterExpression]]]) – A list of Tuple of pauli_str and coefficient.
  • coeff (Union[complex, ParameterExpression]) – A coefficient multiplying the primitive.
  • dtype (type) – The dtype to use to construct the internal SparsePauliOp. Defaults to complex.

Return type

PauliSumOp

Returns

The PauliSumOp constructed from the pauli_list.

is_hermitian

PauliSumOp.is_hermitian()GitHub(opens in a new tab)

Return True if the operator is hermitian.

Returns: Boolean value

is_zero

PauliSumOp.is_zero()GitHub(opens in a new tab)

Return this operator is zero operator or not.

Return type

bool

matrix_iter

PauliSumOp.matrix_iter(sparse=False)GitHub(opens in a new tab)

Return a matrix representation iterator.

This is a lazy iterator that converts each term in the PauliSumOp into a matrix as it is used. To convert to a single matrix use the to_matrix() method.

Parameters

sparse (bool) – optionally return sparse CSR matrices if True, otherwise return Numpy array matrices (Default: False)

Returns

matrix iterator object for the PauliSumOp.

Return type

MatrixIterator

mul

PauliSumOp.mul(scalar)GitHub(opens in a new tab)

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

Parameters

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

Return type

OperatorBase

Returns

An OperatorBase equivalent to product of self and scalar.

permute

PauliSumOp.permute(permutation)GitHub(opens in a new tab)

Permutes the sequence of PauliSumOp.

Parameters

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

Return type

PauliSumOp

Returns

A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) and indices=[1,2,4], it returns (X ^ I ^ Y ^ Z ^ I).

Raises

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

primitive_strings

PauliSumOp.primitive_strings()GitHub(opens in a new tab)

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.

Return type

Set[str]

Returns

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

reduce

PauliSumOp.reduce(atol=None, rtol=None)GitHub(opens in a new tab)

Simplify the primitive SparsePauliOp.

Parameters

  • atol (Optional[float]) – Absolute tolerance for checking if coefficients are zero (Default: 1e-8).
  • rtol (Optional[float]) – Relative tolerance for checking if coefficients are zero (Default: 1e-5).

Return type

PauliSumOp

Returns

The simplified PauliSumOp.

tensor

PauliSumOp.tensor(other)GitHub(opens in a new tab)

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.

Parameters

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

Return type

Union[PauliSumOp, TensoredOp]

Returns

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

to_instruction

PauliSumOp.to_instruction()GitHub(opens in a new tab)

Returns an Instruction equivalent to this Operator.

Return type

Instruction

to_matrix

PauliSumOp.to_matrix(massive=False)GitHub(opens in a new tab)

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.

Return type

ndarray

Returns

The NumPy ndarray equivalent to this Operator.

to_pauli_op

PauliSumOp.to_pauli_op(massive=False)GitHub(opens in a new tab)

Returns a sum of PauliOp s equivalent to this Operator.

Return type

Union[PauliOp, SummedOp]

to_spmatrix

PauliSumOp.to_spmatrix()GitHub(opens in a new tab)

Returns SciPy sparse matrix representation of the PauliSumOp.

Return type

spmatrix

Returns

CSR sparse matrix representation of the PauliSumOp.

Raises

ValueError – invalid parameters.


Attributes

INDENTATION

= '  '

coeff

The scalar coefficient multiplying the Operator.

Return type

Union[complex, ParameterExpression]

Returns

The coefficient.

coeffs

Return the Pauli coefficients.

grouping_type

Type of Grouping

Type

Returns

Return type

str

instance_id

Return the unique instance id.

Return type

int

num_qubits

Return type

int

parameters

primitive

qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp

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.

Return type

Dict

Was this page helpful?