111 lines
4.3 KiB
Plaintext
111 lines
4.3 KiB
Plaintext
---
|
||
title: CollectOpSize (latest version)
|
||
description: API reference for qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize in the latest version of qiskit-addon-utils
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize
|
||
---
|
||
|
||
# CollectOpSize
|
||
|
||
<Class id="qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-addon-utils/tree/main/qiskit_addon_utils/slicing/transpiler/passes/collect_op_size.py#L28-L58" signature="CollectOpSize(*args, **kwargs)" modifiers="class">
|
||
Bases: [`CollectAndCollapse`](/api/qiskit/qiskit.transpiler.passes.CollectAndCollapse "(in Qiskit v1.2)")
|
||
|
||
Collects blocks of the specified size and replaces them by a single block instruction.
|
||
|
||
Initialize a `CollectOpSize` object.
|
||
|
||
<Admonition title="Warning" type="caution">
|
||
The `do_commutative_analysis` keyword currently does not work as intended due to an open issue. Thus, setting it to `True` will not work.
|
||
</Admonition>
|
||
|
||
**Parameters**
|
||
|
||
* **size** – The size of operations to collect.
|
||
* **do\_commutative\_analysis** – If `True`, exploits commutativity relations between nodes. Note also the warning above.
|
||
|
||
## Attributes
|
||
|
||
### is\_analysis\_pass
|
||
|
||
<Attribute id="qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize.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_addon_utils.slicing.transpiler.passes.CollectOpSize.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>
|
||
|
||
## Methods
|
||
|
||
### execute
|
||
|
||
<Function id="qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize.execute" signature="execute(passmanager_ir, state, callback=None)">
|
||
Execute optimization task for input Qiskit IR.
|
||
|
||
**Parameters**
|
||
|
||
* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize.
|
||
* **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself.
|
||
* **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task.
|
||
|
||
**Returns**
|
||
|
||
Optimized Qiskit IR and state of the workflow.
|
||
|
||
**Return type**
|
||
|
||
[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")]
|
||
</Function>
|
||
|
||
### name
|
||
|
||
<Function id="qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize.name" signature="name()">
|
||
Name of the pass.
|
||
|
||
**Return type**
|
||
|
||
[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize.run" signature="run(dag)">
|
||
Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit
|
||
|
||
**Returns**
|
||
|
||
the optimized DAG.
|
||
|
||
**Return type**
|
||
|
||
DAGCircuit
|
||
</Function>
|
||
|
||
### update\_status
|
||
|
||
<Function id="qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize.update_status" signature="update_status(state, run_state)">
|
||
Update workflow status.
|
||
|
||
**Parameters**
|
||
|
||
* **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update.
|
||
* **run\_state** (*RunState*) – Completion status of current task.
|
||
|
||
**Returns**
|
||
|
||
Updated pass manager state.
|
||
|
||
**Return type**
|
||
|
||
[*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")
|
||
</Function>
|
||
</Class>
|
||
|