CommutativeCancellation
class qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)
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, CZCommutativeCancellation initializer.
Parameters
- basis_gates (list[str]) – Basis gates to consider, e.g.
['u3', 'cx']. For the effects of this pass, the basis is the set intersection between thebasis_gatesparameter and the gates in the dag. - target (Target) – The
Targetrepresenting the target backend, if bothbasis_gatesandtargetare specified then this argument will take precedence andbasis_gateswill 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)
Execute optimization task for input Qiskit IR.
Parameters
- passmanager_ir (Any) – Qiskit IR to optimize.
- state (PassManagerState) – State associated with workflow execution by the pass manager itself.
- callback (Callable | None) – A callback function which is caller per execution of optimization task.
Returns
Optimized Qiskit IR and state of the workflow.
Return type
tuple[Any, qiskit.passmanager.compilation_status.PassManagerState]
name
run
run(dag)
Run the CommutativeCancellation pass on dag.
Parameters
dag (DAGCircuit) – the DAG to be optimized.
Returns
the optimized DAG.
Return type
update_status
update_status(state, run_state)
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