90 lines
3.5 KiB
Plaintext
90 lines
3.5 KiB
Plaintext
---
|
||
title: FlowController
|
||
description: API reference for qiskit.transpiler.FlowController
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.transpiler.FlowController
|
||
---
|
||
|
||
# FlowController
|
||
|
||
<Class id="qiskit.transpiler.FlowController" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/transpiler/runningpassmanager.py" signature="qiskit.transpiler.FlowController(passes, options, **partial_controller)" modifiers="class">
|
||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||
|
||
Base class for multiple types of working list.
|
||
|
||
This class is a base class for multiple types of working list. When you iterate on it, it returns the next pass to run.
|
||
|
||
## Attributes
|
||
|
||
### registered\_controllers
|
||
|
||
<Attribute id="qiskit.transpiler.FlowController.registered_controllers" attributeValue="{'condition': <class 'qiskit.transpiler.runningpassmanager.ConditionalController'>, 'do_while': <class 'qiskit.transpiler.runningpassmanager.DoWhileController'>}" />
|
||
|
||
## Methods
|
||
|
||
### add\_flow\_controller
|
||
|
||
<Function id="qiskit.transpiler.FlowController.add_flow_controller" signature="add_flow_controller(name, controller)" modifiers="classmethod">
|
||
Adds a flow controller.
|
||
|
||
**Parameters**
|
||
|
||
* **name** (*string*) – Name of the controller to add.
|
||
* **controller** ([*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.12)")*(*[*FlowController*](#qiskit.transpiler.FlowController "qiskit.transpiler.FlowController")*)*) – The class implementing a flow controller.
|
||
</Function>
|
||
|
||
### controller\_factory
|
||
|
||
<Function id="qiskit.transpiler.FlowController.controller_factory" signature="controller_factory(passes, options, **partial_controller)" modifiers="classmethod">
|
||
Constructs a flow controller based on the partially evaluated controller arguments.
|
||
|
||
**Parameters**
|
||
|
||
* **passes** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[TBasePass]*) – passes to add to the flow controller.
|
||
* **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – PassManager options.
|
||
* **\*\*partial\_controller** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – Partially evaluated controller arguments in the form \{name:partial}
|
||
|
||
**Raises**
|
||
|
||
[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – When partial\_controller is not well-formed.
|
||
|
||
**Returns**
|
||
|
||
A FlowController instance.
|
||
|
||
**Return type**
|
||
|
||
[FlowController](#qiskit.transpiler.FlowController "qiskit.transpiler.FlowController")
|
||
</Function>
|
||
|
||
### dump\_passes
|
||
|
||
<Function id="qiskit.transpiler.FlowController.dump_passes" signature="dump_passes()">
|
||
Fetches the passes added to this flow controller.
|
||
|
||
**Returns**
|
||
|
||
\{‘options’: self.options, ‘passes’: \[passes], ‘type’: type(self)}
|
||
|
||
**Return type**
|
||
|
||
[dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### remove\_flow\_controller
|
||
|
||
<Function id="qiskit.transpiler.FlowController.remove_flow_controller" signature="remove_flow_controller(name)" modifiers="classmethod">
|
||
Removes a flow controller.
|
||
|
||
**Parameters**
|
||
|
||
**name** (*string*) – Name of the controller to remove.
|
||
|
||
**Raises**
|
||
|
||
[**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.12)") – If the controller to remove was not registered.
|
||
</Function>
|
||
</Class>
|
||
|