qiskit.transpiler.passes.UnrollCustomDefinitions

class UnrollCustomDefinitions(*args, **kwargs)

Unrolls instructions with custom definitions.

Unrolls instructions with custom definitions.

Parameters

• equivalence_library (EquivalenceLibrary) – The equivalence library which will be used by the BasisTranslator pass. (Instructions in this library will not be unrolled by this pass.)

• basis_gates (list[str]) – Target basis names to unroll to, e.g. [‘u3’, ‘cx’].

__init__(equivalence_library, basis_gates)

Unrolls instructions with custom definitions.

Parameters

• equivalence_library (EquivalenceLibrary) – The equivalence library which will be used by the BasisTranslator pass. (Instructions in this library will not be unrolled by this pass.)

• basis_gates (list[str]) – Target basis names to unroll to, e.g. [‘u3’, ‘cx’].

Methods

__init__(equivalence_library, basis_gates)	Unrolls instructions with custom definitions.
name()	Return the name of the pass.
run(dag)	Run the UnrollCustomDefinitions pass on dag.

Attributes

is_analysis_pass	Check if the pass is an analysis pass.
is_transformation_pass	Check if the pass is a transformation pass.

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

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

name()

Return the name of the pass.

run(dag)

Run the UnrollCustomDefinitions 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