UnrollForLoops
class qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)
Bases: TransformationPass
UnrollForLoops
transpilation pass unrolls for-loops when possible.
Things like for x in {0, 3, 4} {rx(x) qr[1];}
will turn into rx(0) qr[1]; rx(3) qr[1]; rx(4) qr[1];
.
The UnrollForLoops
unrolls only one level of block depth. No inner loop will be considered by max_target_depth
.
Parameters
max_target_depth (int) – Optional. Checks if the unrolled block is over a particular subcircuit depth. To disable the check, use -1
(Default).
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 UnrollForLoops pass on dag
.
Parameters
dag (DAGCircuit) – the directed acyclic graph to run on.
Returns
Transformed 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