InverseCancellation

class qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)[source]

Bases: TransformationPass

Cancel specific Gates which are inverses of each other when they occur back-to- back.

Initialize InverseCancellation pass.

Parameters:

gates_to_cancel – List describing the gates to cancel. Each element of the list is either a single gate or a pair of gates. If a single gate, then it should be self-inverse. If a pair of gates, then the gates in the pair should be inverses of each other.

Raises:

TranspilerError – Input is not a self-inverse gate or a pair of inverse gates.

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

Name of the pass.

Return type:

str

run(dag)[source]

Run the InverseCancellation pass on dag.

Parameters:

dag (DAGCircuit) – the directed acyclic graph to run on.

Returns:

Transformed DAG.

Return type:

DAGCircuit

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:

PassManagerState