CollectCliffords
class qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)
Bases: CollectAndCollapse
Collects blocks of Clifford gates and replaces them by a Clifford object.
CollectCliffords initializer.
Parameters
- do_commutative_analysis (bool) – if True, exploits commutativity relations between nodes.
- split_blocks (bool) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets.
- min_block_size (int) – specifies the minimum number of gates in the block for the block to be collected.
- split_layers (bool) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets.
- collect_from_back (bool) – specifies if blocks should be collected started from the end of the circuit.
- matrix_based (bool) – specifies whether to collect unitary gates which are Clifford gates only for certain parameters (based on their unitary matrix).
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