Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

Unroller

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

Bases: TransformationPass

Unroll a circuit to a given basis.

Unroll (expand) non-basis, non-opaque instructions recursively to a desired basis, using decomposition rules defined for each instruction.

Unroller initializer.

Deprecated since version 0.45.0

The class qiskit.transpiler.passes.basis.unroller.Unroller is deprecated as of qiskit 0.45.0. It will be removed no earlier than 3 months after the release date. This has been replaced by the BasisTranslator pass and is going to be removed in Qiskit 1.0.

Parameters

  • basis (list(opens in a new tab)[str(opens in a new tab)] or None) – Target basis names to unroll to, e.g. [‘u3’, ‘cx’] . If None, does not unroll any gate.
  • target (Target) – The Target representing the target backend, if both basis and this are specified then this argument will take precedence and basis will be ignored.

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 Unroller pass on dag.

Parameters

dag (DAGCircuit) – input dag

Raises

  • QiskitError – if unable to unroll given the basis due to undefined
  • decomposition rules** (such as a bad basis) or **excessive recursion.

Returns

output unrolled 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?
Report a bug or request content on GitHub.