Skip to main contentIBM Quantum Documentation

CommutativeCancellation

qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs) GitHub(opens in a new tab)

Bases: TransformationPass

Cancel the redundant (self-adjoint) gates through commutation relations.

Pass for cancelling self-inverse gates/rotations. The cancellation utilizes the commutation relations in the circuit. Gates considered include:

H, X, Y, Z, CX, CY, CZ

CommutativeCancellation initializer.

Parameters

  • basis_gates (list(opens in a new tab)[str(opens in a new tab)]) – Basis gates to consider, e.g. ['u3', 'cx']. For the effects of this pass, the basis is the set intersection between the basis_gates parameter and the gates in the dag.
  • target (Target) – The Target representing the target backend, if both basis_gates and target are specified then this argument will take precedence and basis_gates will be ignored.

Attributes

is_analysis_pass

Check if the pass is an analysis pass.

If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.

is_transformation_pass

Check if the pass is a transformation pass.

If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).


Methods

execute

execute(passmanager_ir, state, callback=None) GitHub(opens in a new tab)

Execute optimization task for input Qiskit IR.

Parameters

Returns

Optimized Qiskit IR and state of the workflow.

Return type

tuple(opens in a new tab)[Any(opens in a new tab), qiskit.passmanager.compilation_status.PassManagerState]

name

name() GitHub(opens in a new tab)

Name of the pass.

Return type

str(opens in a new tab)

run

run(dag) GitHub(opens in a new tab)

Run the CommutativeCancellation pass on dag.

Parameters

dag (DAGCircuit) – the DAG to be optimized.

Returns

the optimized DAG.

Return type

DAGCircuit

Raises

TranspilerError – when the 1-qubit rotation gates are not found

update_status

update_status(state, run_state) GitHub(opens in a new tab)

Update workflow status.

Parameters

  • state (PassManagerState) – Pass manager state to update.
  • run_state (RunState) – Completion status of current task.

Returns

Updated pass manager state.

Return type

PassManagerState

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