CollectAndCollapse
class qiskit.transpiler.passes.CollectAndCollapse(*args, **kwargs)
Bases: TransformationPass
A general transpiler pass to collect and to consolidate blocks of nodes in a circuit.
This transpiler pass depends on two functions: the collection function and the collapsing function. The collection function collect_function takes a DAG and returns a list of blocks. The collapsing function collapse_function takes a DAG and a list of blocks, consolidates each block, and returns the modified DAG.
The input and the output DAGs are of type DAGCircuit, however when exploiting commutativity analysis to collect blocks, the DAGDependency representation is used internally. To support this, the collect_function and collapse_function should work with both types of DAGs and DAG nodes.
Other collection and consolidation transpiler passes, for instance CollectLinearFunctions, may derive from this pass, fixing collect_function and collapse_function to specific functions.
Parameters
- collect_function (callable) – a function that takes a DAG and returns a list of “collected” blocks of nodes
- collapse_function (callable) – a function that takes a DAG and a list of “collected” blocks, and consolidates each block.
- do_commutative_analysis (bool) – if True, exploits commutativity relations between nodes.
Attributes
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.
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).
Methods
execute
execute(passmanager_ir, state, callback=None)
Execute optimization task for input Qiskit IR.
Parameters
- passmanager_ir (Any) – Qiskit IR to optimize.
- state (PassManagerState) – State associated with workflow execution by the pass manager itself.
- callback (Callable | None) – A callback function which is caller per execution of optimization task.
Returns
Optimized Qiskit IR and state of the workflow.
Return type
tuple[Any, qiskit.passmanager.compilation_status.PassManagerState]
name
run
run(dag)
Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit
Returns
the optimized DAG.
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