Skip to main contentIBM Quantum Documentation

CollectLinearFunctions

qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs) GitHub(opens in a new tab)

Bases: CollectAndCollapse

Collect blocks of linear gates (CXGate and SwapGate gates) and replaces them by linear functions (LinearFunction).

CollectLinearFunctions initializer.

Parameters

  • do_commutative_analysis (bool(opens in a new tab)) – if True, exploits commutativity relations between nodes.
  • split_blocks (bool(opens in a new tab)) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets.
  • min_block_size (int(opens in a new tab)) – specifies the minimum number of gates in the block for the block to be collected.
  • split_layers (bool(opens in a new tab)) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets.
  • collect_from_back (bool(opens in a new tab)) – specifies if blocks should be collected started from the end of the circuit.

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

Returns

Optimized Qiskit IR and state of the workflow.

Return type

tuple(opens in a new tab)[Any(opens in a new tab), qiskit.passmanager.compilation_status.PassManagerState]

name

name()

Name of the pass.

Return type

str(opens in a new tab)

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

DAGCircuit

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

PassManagerState

Was this page helpful?