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

AbelianGrouper

qiskit.opflow.converters.AbelianGrouper(traverse=True) GitHub(opens in a new tab)

Bases: ConverterBase

Deprecated: The AbelianGrouper converts SummedOps into a sum of Abelian sums.

Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of commuting Operators into their own SummedOps, and return the sum-of-commuting-SummedOps. This is particularly useful for cases where mutually commuting groups can be handled similarly, as in the case of Pauli Expectations, where commuting Paulis have the same diagonalizing circuit rotation, or Pauli Evolutions, where commuting Paulis can be diagonalized together.

Deprecated since version 0.24.0

The class qiskit.opflow.converters.abelian_grouper.AbelianGrouper is deprecated as of qiskit-terra 0.24.0. It will be removed in the Qiskit 1.0 release. For code migration guidelines, visit https://qisk.it/opflow_migration(opens in a new tab).

Parameters

traverse (bool(opens in a new tab)) – Whether to convert only the Operator passed to convert, or traverse down that Operator.


Methods

convert

convert(operator)

Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and traverse is True, attempt to convert any sub-Operators.

Parameters

operator (OperatorBase) – The Operator to attempt to convert.

Returns

The converted Operator.

Return type

OperatorBase

group_subops

classmethod group_subops(list_op)

Given a ListOp, attempt to group into Abelian ListOps of the same type.

Parameters

list_op (ListOp |PauliSumOp) – The Operator to group into Abelian groups

Returns

The grouped Operator.

Raises

OpflowError – If any of list_op’s sub-ops is not PauliOp.

Return type

ListOp

Was this page helpful?
Report a bug or request content on GitHub.