84 lines
4.2 KiB
Plaintext
84 lines
4.2 KiB
Plaintext
---
|
||
title: EnlargeWithAncilla (v0.26)
|
||
description: API reference for qiskit.transpiler.passes.EnlargeWithAncilla in qiskit v0.26
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla
|
||
---
|
||
|
||
<span id="qiskit-transpiler-passes-enlargewithancilla" />
|
||
|
||
# qiskit.transpiler.passes.EnlargeWithAncilla
|
||
|
||
<Class id="qiskit.transpiler.passes.EnlargeWithAncilla" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py" signature="EnlargeWithAncilla(*args, **kwargs)" modifiers="class">
|
||
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.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.transpiler.passes.EnlargeWithAncilla.__init__" signature="__init__()">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||
| [`__init__`](#qiskit.transpiler.passes.EnlargeWithAncilla.__init__ "qiskit.transpiler.passes.EnlargeWithAncilla.__init__")() | Initialize self. |
|
||
| [`name`](#qiskit.transpiler.passes.EnlargeWithAncilla.name "qiskit.transpiler.passes.EnlargeWithAncilla.name")() | Return the name of the pass. |
|
||
| [`run`](#qiskit.transpiler.passes.EnlargeWithAncilla.run "qiskit.transpiler.passes.EnlargeWithAncilla.run")(dag) | Run the EnlargeWithAncilla pass on dag. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
|
||
| [`is_analysis_pass`](#qiskit.transpiler.passes.EnlargeWithAncilla.is_analysis_pass "qiskit.transpiler.passes.EnlargeWithAncilla.is_analysis_pass") | Check if the pass is an analysis pass. |
|
||
| [`is_transformation_pass`](#qiskit.transpiler.passes.EnlargeWithAncilla.is_transformation_pass "qiskit.transpiler.passes.EnlargeWithAncilla.is_transformation_pass") | Check if the pass is a transformation pass. |
|
||
|
||
### is\_analysis\_pass
|
||
|
||
<Attribute id="qiskit.transpiler.passes.EnlargeWithAncilla.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.
|
||
</Attribute>
|
||
|
||
### is\_transformation\_pass
|
||
|
||
<Attribute id="qiskit.transpiler.passes.EnlargeWithAncilla.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).
|
||
</Attribute>
|
||
|
||
### name
|
||
|
||
<Function id="qiskit.transpiler.passes.EnlargeWithAncilla.name" signature="name()">
|
||
Return the name of the pass.
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.transpiler.passes.EnlargeWithAncilla.run" signature="run(dag)">
|
||
Run the EnlargeWithAncilla pass on dag.
|
||
|
||
**Parameters**
|
||
|
||
**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to extend.
|
||
|
||
**Returns**
|
||
|
||
An extended DAG.
|
||
|
||
**Return type**
|
||
|
||
[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If there is not layout in the property set or not set at init time.
|
||
</Function>
|
||
</Class>
|
||
|