CollectOpColor

class CollectOpColor(*args, **kwargs)[source]

Bases: CollectAndCollapse

Collects blocks of operations which act on the provided edges.

The collected operations are replaced by a single block instruction.

Initialize a CollectOpColor object.

Warning

The do_commutative_analysis keyword currently does not work as intended due to an open issue. Thus, setting it to True will not work.

Parameters:

  • color_name – The name of the color to consolidate into blocks. This is used to prefix the labels on the produced block instructions such that each block is labeled "{color_name}_slice".

  • edges – The set of edges belonging to this color.

  • do_commutative_analysis – If True, exploits commutativity relations between nodes. Note also the warning above.

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(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, PassManagerState]

name()

Name of the pass.

Return type:

str

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

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:

PassManagerState