qiskit.transpiler.passes.FullAncillaAllocation

class FullAncillaAllocation(*args, **kwargs)

Allocate all idle nodes from the coupling map as ancilla on the layout.

A pass for allocating all idle physical qubits (those that exist in coupling map but not the dag circuit) as ancilla. It will also choose new virtual qubits to correspond to those physical ancilla.

Note

This is an analysis pass, and only responsible for choosing physical ancilla locations and their corresponding virtual qubits. A separate transformation pass must add those virtual qubits to the circuit.

FullAncillaAllocation initializer.

Parameters

coupling_map (Coupling) – directed graph representing a coupling map.

__init__(coupling_map)

FullAncillaAllocation initializer.

Parameters

coupling_map (Coupling) – directed graph representing a coupling map.

Methods

__init__(coupling_map)	FullAncillaAllocation initializer.
name()	Return the name of the pass.
run(dag)	Run the FullAncillaAllocation pass on dag.
validate_layout(layout_qubits, dag_qubits)	Checks if all the qregs in layout_qregs already exist in dag_qregs.

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

Extend the layout with new (physical qubit, virtual qubit) pairs. The dag signals which virtual qubits are already in the circuit. This pass will allocate new virtual qubits such that no collision occurs (i.e. Layout bijectivity is preserved)

The coupling_map and layout together determine which physical qubits are free.

Parameters

dag (DAGCircuit) – circuit to analyze

Returns

returns the same dag circuit, unmodified

Return type

DAGCircuit

Raises

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

static validate_layout(layout_qubits, dag_qubits)

Checks if all the qregs in layout_qregs already exist in dag_qregs. Otherwise, raise.