Skip to main contentIBM Quantum Documentation

BaseController

qiskit.passmanager.BaseController(options=None)GitHub(opens in a new tab)

Bases: Task, ABC(opens in a new tab)

Base class of controller.

A controller is built with a collection of pass manager tasks, and a subclass provides a custom logic to choose next task to run. Note a controller can be nested into another controller, and a controller itself doesn’t provide any subroutine to modify the input IR.

Create new flow controller.

Parameters

options (dict(opens in a new tab)[str(opens in a new tab), Any] | None) – Option for this flow controller.


Methods

execute

execute(passmanager_ir, state, callback=None)

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]

iter_tasks

abstract iter_tasks(state)

A custom logic to choose a next task to run.

Controller subclass can consume the state to build a proper task pipeline. The updated state after a task execution will be fed back in as the “return” value of any yield statements. This indicates the order of task execution is only determined at running time. This method is not allowed to mutate the given state object.

Parameters

  • state (PassManagerState) – The state of the passmanager workflow at the beginning of this flow controller’s execution.
  • state – the state of pass manager after the execution of the last task that was yielded. The generator does not need to inspect this if it is irrelevant to its logic, nor update it.

Yields

Task – Next task to run.

Return type

Generator(opens in a new tab)[Task, PassManagerState, None]

Was this page helpful?