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

Unroller

class Unroller(*args, **kwargs)

GitHub(opens in a new tab)

Bases: qiskit.transpiler.basepasses.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.

Parameters

basis (list[str] or None) – Target basis names to unroll to, e.g. [‘u3’, ‘cx’] . If None, does not unroll any gate.


Methods

name

Unroller.name()

Return the name of the pass.

run

Unroller.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


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).

Was this page helpful?
Report a bug or request content on GitHub.