Skip to main contentIBM Quantum Documentation

ContainsInstruction

class qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)

GitHub

Bases: AnalysisPass

An analysis pass to detect if the DAG contains a specific instruction.

This pass takes in a single instruction name for example 'delay' and will set the property set contains_delay to True if the DAG contains that instruction and False if it does not.

ContainsInstruction initializer.

Parameters

  • instruction_name (str | Iterable[str]) – The instruction or instructions to check are in the DAG. The output in the property set is set to contains_ prefixed on each value for this parameter.
  • recurse (bool) – if True (default), then recurse into control-flow operations.

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

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

GitHub

Name of the pass.

Return type

str

run

run(dag)

GitHub

Run the ContainsInstruction pass on dag.

update_status

update_status(state, run_state)

GitHub

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.