GenericPass
qiskit.passmanager.GenericPass
Bases: Task, ABC (opens in a new tab)
Base class of a single pass manager task.
A pass instance can read and write to the provided PropertySet, and may modify the input pass manager IR.
Methods
execute
execute(passmanager_ir, state, callback=None)
Execute optimization task for input Qiskit IR.
Parameters
- passmanager_ir (Any (opens in a new tab)) – Qiskit IR to optimize.
- state (PassManagerState) – State associated with workflow execution by the pass manager itself.
- callback (Callable (opens in a new tab) | None) – A callback function which is caller per execution of optimization task.
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()
Name of the pass.
Return type
run
abstract run(passmanager_ir)
Run optimization task.
Parameters
passmanager_ir (Any (opens in a new tab)) – Qiskit IR to optimize.
Returns
Optimized Qiskit IR.
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