UnrollCustomDefinitions

class qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)[source]

Bases: TransformationPass

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 (Optional[list[str]]) – Target basis names to unroll to, e.g. ['u3', 'cx']. Ignored if target is also specified.

  • target (Optional[Target]) –

    The Target object corresponding to the compilation

    target. When specified, any argument specified for basis_gates is ignored.

    min_qubits (int): The minimum number of qubits for operations in the input

    dag to translate.

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

Name of the pass.

Return type:

str

run(dag)[source]

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

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