66 lines
2.6 KiB
Plaintext
66 lines
2.6 KiB
Plaintext
---
|
||
title: AncillaQubit
|
||
description: API reference for qiskit.circuit.AncillaQubit
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.circuit.AncillaQubit
|
||
---
|
||
|
||
# qiskit.circuit.AncillaQubit
|
||
|
||
<Class id="qiskit.circuit.AncillaQubit" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/circuit/quantumregister.py" signature="AncillaQubit(register=None, index=None)" modifiers="class">
|
||
A qubit used as ancillary qubit.
|
||
|
||
Creates a qubit.
|
||
|
||
**Parameters**
|
||
|
||
* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – Optional. A quantum register containing the bit.
|
||
* **index** (*int*) – Optional. The index of the bit in its containing register.
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – if the provided register is not a valid [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.circuit.AncillaQubit.__init__" signature="__init__(register=None, index=None)">
|
||
Creates a qubit.
|
||
|
||
**Parameters**
|
||
|
||
* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – Optional. A quantum register containing the bit.
|
||
* **index** (*int*) – Optional. The index of the bit in its containing register.
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – if the provided register is not a valid [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------- | ---------------- |
|
||
| [`__init__`](#qiskit.circuit.AncillaQubit.__init__ "qiskit.circuit.AncillaQubit.__init__")(\[register, index]) | Creates a qubit. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------ | ------------------- |
|
||
| [`index`](#qiskit.circuit.AncillaQubit.index "qiskit.circuit.AncillaQubit.index") | Get bit’s index. |
|
||
| [`register`](#qiskit.circuit.AncillaQubit.register "qiskit.circuit.AncillaQubit.register") | Get bit’s register. |
|
||
|
||
### index
|
||
|
||
<Attribute id="qiskit.circuit.AncillaQubit.index">
|
||
Get bit’s index.
|
||
</Attribute>
|
||
|
||
### register
|
||
|
||
<Attribute id="qiskit.circuit.AncillaQubit.register">
|
||
Get bit’s register.
|
||
</Attribute>
|
||
</Class>
|
||
|