EnlargeWithAncilla

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

Bases: TransformationPass

Extend the dag with virtual qubits that are in layout but not in the circuit yet.

Extend the DAG circuit with new virtual qubits (ancilla) that are specified in the layout, but not present in the circuit. Which qubits to add are previously allocated in the layout property, by a previous pass.

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

Parameters:

dag (DAGCircuit) – DAG to extend.

Returns:

An extended DAG.

Return type:

DAGCircuit

Raises:

TranspilerError – If there is no layout in the property set or not set at init time.

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