78 lines
3.7 KiB
Plaintext
78 lines
3.7 KiB
Plaintext
---
|
||
title: FixedPoint
|
||
description: API reference for qiskit.transpiler.passes.FixedPoint
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.transpiler.passes.FixedPoint
|
||
---
|
||
|
||
<span id="qiskit-transpiler-passes-fixedpoint" />
|
||
|
||
# qiskit.transpiler.passes.FixedPoint
|
||
|
||
<Class id="qiskit.transpiler.passes.FixedPoint" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/transpiler/passes/utils/fixed_point.py" signature="FixedPoint(*args, **kwargs)" modifiers="class">
|
||
Check if a property reached a fixed point.
|
||
|
||
A dummy analysis pass that checks if a property reached a fixed point. The results is saved in `property_set['<property>_fixed_point']` as a boolean.
|
||
|
||
FixedPoint initializer.
|
||
|
||
**Parameters**
|
||
|
||
**property\_to\_check** (*str*) – The property to check if a fixed point was reached.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.transpiler.passes.FixedPoint.__init__" signature="__init__(property_to_check)">
|
||
FixedPoint initializer.
|
||
|
||
**Parameters**
|
||
|
||
**property\_to\_check** (*str*) – The property to check if a fixed point was reached.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
|
||
| [`__init__`](#qiskit.transpiler.passes.FixedPoint.__init__ "qiskit.transpiler.passes.FixedPoint.__init__")(property\_to\_check) | FixedPoint initializer. |
|
||
| [`name`](#qiskit.transpiler.passes.FixedPoint.name "qiskit.transpiler.passes.FixedPoint.name")() | Return the name of the pass. |
|
||
| [`run`](#qiskit.transpiler.passes.FixedPoint.run "qiskit.transpiler.passes.FixedPoint.run")(dag) | Run the FixedPoint pass on dag. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
|
||
| [`is_analysis_pass`](#qiskit.transpiler.passes.FixedPoint.is_analysis_pass "qiskit.transpiler.passes.FixedPoint.is_analysis_pass") | Check if the pass is an analysis pass. |
|
||
| [`is_transformation_pass`](#qiskit.transpiler.passes.FixedPoint.is_transformation_pass "qiskit.transpiler.passes.FixedPoint.is_transformation_pass") | Check if the pass is a transformation pass. |
|
||
|
||
### is\_analysis\_pass
|
||
|
||
<Attribute id="qiskit.transpiler.passes.FixedPoint.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.
|
||
</Attribute>
|
||
|
||
### is\_transformation\_pass
|
||
|
||
<Attribute id="qiskit.transpiler.passes.FixedPoint.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).
|
||
</Attribute>
|
||
|
||
### name
|
||
|
||
<Function id="qiskit.transpiler.passes.FixedPoint.name" signature="name()">
|
||
Return the name of the pass.
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.transpiler.passes.FixedPoint.run" signature="run(dag)">
|
||
Run the FixedPoint pass on dag.
|
||
</Function>
|
||
</Class>
|
||
|