3573 lines
204 KiB
Plaintext
3573 lines
204 KiB
Plaintext
---
|
||
title: QuantumCircuit
|
||
description: API reference for qiskit.circuit.QuantumCircuit
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.circuit.QuantumCircuit
|
||
---
|
||
|
||
# QuantumCircuit
|
||
|
||
<Class id="qiskit.circuit.QuantumCircuit" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/circuit/quantumcircuit.py" signature="qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)" modifiers="class">
|
||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||
|
||
Create a new circuit.
|
||
|
||
A circuit is a list of instructions bound to some registers.
|
||
|
||
**Parameters**
|
||
|
||
* **regs** (list([`Register`](qiskit.circuit.Register "qiskit.circuit.Register")) or list(`int`) or list(list([`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit")))) –
|
||
|
||
The registers to be included in the circuit.
|
||
|
||
* If a list of [`Register`](qiskit.circuit.Register "qiskit.circuit.Register") objects, represents the [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") and/or [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") objects to include in the circuit.
|
||
|
||
For example:
|
||
|
||
> * `QuantumCircuit(QuantumRegister(4))`
|
||
> * `QuantumCircuit(QuantumRegister(4), ClassicalRegister(3))`
|
||
> * `QuantumCircuit(QuantumRegister(4, 'qr0'), QuantumRegister(2, 'qr1'))`
|
||
|
||
* If a list of `int`, the amount of qubits and/or classical bits to include in the circuit. It can either be a single int for just the number of quantum bits, or 2 ints for the number of quantum bits and classical bits, respectively.
|
||
|
||
For example:
|
||
|
||
> * `QuantumCircuit(4) # A QuantumCircuit with 4 qubits`
|
||
> * `QuantumCircuit(4, 3) # A QuantumCircuit with 4 qubits and 3 classical bits`
|
||
|
||
* If a list of python lists containing [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit") objects, a collection of [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit") s to be added to the circuit.
|
||
|
||
* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – the name of the quantum circuit. If not set, an automatically generated string will be assigned.
|
||
|
||
* **global\_phase** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") *or*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – The global phase of the circuit in radians.
|
||
|
||
* **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – Arbitrary key value metadata to associate with the circuit. This gets stored as free-form data in a dict in the [`metadata`](#qiskit.circuit.QuantumCircuit.metadata "qiskit.circuit.QuantumCircuit.metadata") attribute. It will not be directly used in the circuit.
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if the circuit name, if given, is not valid.
|
||
|
||
**Examples**
|
||
|
||
Construct a simple Bell state circuit.
|
||
|
||
```python
|
||
from qiskit import QuantumCircuit
|
||
|
||
qc = QuantumCircuit(2, 2)
|
||
qc.h(0)
|
||
qc.cx(0, 1)
|
||
qc.measure([0, 1], [0, 1])
|
||
qc.draw('mpl')
|
||
```
|
||
|
||
|
||
|
||
Construct a 5-qubit GHZ circuit.
|
||
|
||
```python
|
||
from qiskit import QuantumCircuit
|
||
|
||
qc = QuantumCircuit(5)
|
||
qc.h(0)
|
||
qc.cx(0, range(1, 5))
|
||
qc.measure_all()
|
||
```
|
||
|
||
Construct a 4-qubit Bernstein-Vazirani circuit using registers.
|
||
|
||
```python
|
||
from qiskit import QuantumRegister, ClassicalRegister, QuantumCircuit
|
||
|
||
qr = QuantumRegister(3, 'q')
|
||
anc = QuantumRegister(1, 'ancilla')
|
||
cr = ClassicalRegister(3, 'c')
|
||
qc = QuantumCircuit(qr, anc, cr)
|
||
|
||
qc.x(anc[0])
|
||
qc.h(anc[0])
|
||
qc.h(qr[0:3])
|
||
qc.cx(qr[0:3], anc[0])
|
||
qc.h(qr[0:3])
|
||
qc.barrier(qr)
|
||
qc.measure(qr, cr)
|
||
|
||
qc.draw('mpl')
|
||
```
|
||
|
||
|
||
|
||
## Attributes
|
||
|
||
### ancillas
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.ancillas">
|
||
Returns a list of ancilla bits in the order that the registers were added.
|
||
</Attribute>
|
||
|
||
### calibrations
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.calibrations">
|
||
Return calibration dictionary.
|
||
|
||
The custom pulse definition of a given gate is of the form `{'gate_name': {(qubits, params): schedule}}`
|
||
</Attribute>
|
||
|
||
### clbits
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.clbits">
|
||
Returns a list of classical bits in the order that the registers were added.
|
||
</Attribute>
|
||
|
||
### data
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.data">
|
||
Return the circuit data (instructions and context).
|
||
|
||
**Returns**
|
||
|
||
a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction.
|
||
|
||
**Return type**
|
||
|
||
QuantumCircuitData
|
||
</Attribute>
|
||
|
||
### extension\_lib
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.extension_lib" attributeValue="'include "qelib1.inc";'" />
|
||
|
||
### global\_phase
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.global_phase">
|
||
Return the global phase of the circuit in radians.
|
||
</Attribute>
|
||
|
||
### header
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.header" attributeValue="'OPENQASM 2.0;'" />
|
||
|
||
### instances
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.instances" attributeValue="153" />
|
||
|
||
### layout
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.layout">
|
||
Return any associated layout information about the circuit
|
||
|
||
This attribute contains an optional [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") object. This is typically set on the output from [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or [`PassManager.run()`](qiskit.transpiler.PassManager#run "qiskit.transpiler.PassManager.run") to retain information about the permutations caused on the input circuit by transpilation.
|
||
|
||
There are two types of permutations caused by the [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") function, an initial layout which permutes the qubits based on the selected physical qubits on the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"), and a final layout which is an output permutation caused by [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s inserted during routing.
|
||
</Attribute>
|
||
|
||
### metadata
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.metadata">
|
||
The user provided metadata associated with the circuit.
|
||
|
||
The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit.
|
||
</Attribute>
|
||
|
||
### num\_ancillas
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.num_ancillas">
|
||
Return the number of ancilla qubits.
|
||
</Attribute>
|
||
|
||
### num\_clbits
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.num_clbits">
|
||
Return number of classical bits.
|
||
</Attribute>
|
||
|
||
### num\_parameters
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.num_parameters">
|
||
The number of parameter objects in the circuit.
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.num_qubits">
|
||
Return number of qubits.
|
||
</Attribute>
|
||
|
||
### op\_start\_times
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.op_start_times">
|
||
Return a list of operation start times.
|
||
|
||
This attribute is enabled once one of scheduling analysis passes runs on the quantum circuit.
|
||
|
||
**Returns**
|
||
|
||
List of integers representing instruction start times. The index corresponds to the index of instruction in [`QuantumCircuit.data`](#qiskit.circuit.QuantumCircuit.data "qiskit.circuit.QuantumCircuit.data").
|
||
|
||
**Raises**
|
||
|
||
[**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.12)") – When circuit is not scheduled.
|
||
</Attribute>
|
||
|
||
### parameters
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.parameters">
|
||
The parameters defined in the circuit.
|
||
|
||
This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically.
|
||
|
||
**Examples**
|
||
|
||
The snippet below shows that insertion order of parameters does not matter.
|
||
|
||
```python
|
||
>>> from qiskit.circuit import QuantumCircuit, Parameter
|
||
>>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant")
|
||
>>> circuit = QuantumCircuit(1)
|
||
>>> circuit.rx(b, 0)
|
||
>>> circuit.rz(elephant, 0)
|
||
>>> circuit.ry(a, 0)
|
||
>>> circuit.parameters # sorted alphabetically!
|
||
ParameterView([Parameter(a), Parameter(b), Parameter(elephant)])
|
||
```
|
||
|
||
Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting.
|
||
|
||
```python
|
||
>>> from qiskit.circuit import QuantumCircuit, Parameter
|
||
>>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")]
|
||
>>> circuit = QuantumCircuit(1)
|
||
>>> circuit.u(*angles, 0)
|
||
>>> circuit.draw()
|
||
┌─────────────────────────────┐
|
||
q: ┤ U(angle_1,angle_2,angle_10) ├
|
||
└─────────────────────────────┘
|
||
>>> circuit.parameters
|
||
ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)])
|
||
```
|
||
|
||
To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used.
|
||
|
||
```python
|
||
```
|
||
|
||
```python
|
||
>>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector
|
||
>>> x = ParameterVector("x", 12)
|
||
>>> circuit = QuantumCircuit(1)
|
||
>>> for x_i in x:
|
||
... circuit.rx(x_i, 0)
|
||
>>> circuit.parameters
|
||
ParameterView([
|
||
ParameterVectorElement(x[0]), ParameterVectorElement(x[1]),
|
||
ParameterVectorElement(x[2]), ParameterVectorElement(x[3]),
|
||
..., ParameterVectorElement(x[11])
|
||
])
|
||
```
|
||
|
||
**Returns**
|
||
|
||
The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit.
|
||
</Attribute>
|
||
|
||
### prefix
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.prefix" attributeValue="'circuit'" />
|
||
|
||
### qubits
|
||
|
||
<Attribute id="qiskit.circuit.QuantumCircuit.qubits">
|
||
Returns a list of quantum bits in the order that the registers were added.
|
||
</Attribute>
|
||
|
||
## Methods
|
||
|
||
### add\_bits
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.add_bits" signature="add_bits(bits)">
|
||
Add Bits to the circuit.
|
||
</Function>
|
||
|
||
### add\_calibration
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.add_calibration" signature="add_calibration(gate, qubits, schedule, params=None)">
|
||
Register a low-level, custom pulse definition for the given gate.
|
||
|
||
**Parameters**
|
||
|
||
* **gate** (*Union\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]*) – Gate information.
|
||
* **qubits** (*Union\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, Tuple\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – List of qubits to be measured.
|
||
* **schedule** ([*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")) – Schedule information.
|
||
* **params** (*Optional\[List\[Union\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")*,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]]]*) – A list of parameters.
|
||
|
||
**Raises**
|
||
|
||
[**Exception**](https://docs.python.org/3/library/exceptions.html#Exception "(in Python v3.12)") – if the gate is of type string and params is None.
|
||
</Function>
|
||
|
||
### add\_register
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.add_register" signature="add_register(*regs)">
|
||
Add registers.
|
||
</Function>
|
||
|
||
### append
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.append" signature="append(instruction, qargs=None, cargs=None)">
|
||
Append one or more instructions to the end of the circuit, modifying the circuit in place.
|
||
|
||
The `qargs` and `cargs` will be expanded and broadcast according to the rules of the given [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"), and any non-[`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit") specifiers (such as integer indices) will be resolved into the relevant instances.
|
||
|
||
If a [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") is given, it will be unwrapped, verified in the context of this circuit, and a new object will be appended to the circuit. In this case, you may not pass `qargs` or `cargs` separately.
|
||
|
||
**Parameters**
|
||
|
||
* **instruction** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation") *|*[*CircuitInstruction*](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")) – [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance to append, or a [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with all its context.
|
||
* **qargs** (*Sequence\[QubitSpecifier] | None*) – specifiers of the [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.Qubit")s to attach instruction to.
|
||
* **cargs** (*Sequence\[ClbitSpecifier] | None*) – specifiers of the [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit")s to attach instruction to.
|
||
|
||
**Returns**
|
||
|
||
a handle to the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s that were actually added to the circuit.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if the operation passed is not an instance of [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") .
|
||
</Function>
|
||
|
||
### assign\_parameters
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.assign_parameters" signature="assign_parameters(parameters: Mapping[Parameter, ParameterExpression | float] | Sequence[ParameterExpression | float], inplace: Literal[False] = False, *, flat_input: bool = False, strict: bool = True) → QuantumCircuit" extraSignatures={["assign_parameters(parameters: Mapping[Parameter, ParameterExpression | float] | Sequence[ParameterExpression | float], inplace: Literal[True] = False, *, flat_input: bool = False, strict: bool = True) → None"]}>
|
||
Assign parameters to new parameters or values.
|
||
|
||
If `parameters` is passed as a dictionary, the keys must be [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances in the current circuit. The values of the dictionary can either be numeric values or new parameter objects.
|
||
|
||
If `parameters` is passed as a list or array, the elements are assigned to the current parameters in the order of [`parameters`](#qiskit.circuit.QuantumCircuit.parameters "qiskit.circuit.QuantumCircuit.parameters") which is sorted alphabetically (while respecting the ordering in [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") objects).
|
||
|
||
The values can be assigned to the current circuit object or to a copy of it.
|
||
|
||
**Parameters**
|
||
|
||
* **parameters** – Either a dictionary or iterable specifying the new parameter values.
|
||
* **inplace** – If False, a copy of the circuit with the bound parameters is returned. If True the circuit instance itself is modified.
|
||
* **flat\_input** – If `True` and `parameters` is a mapping type, it is assumed to be exactly a mapping of `{parameter: value}`. By default (`False`), the mapping may also contain [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") keys that point to a corresponding sequence of values, and these will be unrolled during the mapping.
|
||
* **strict** – If `False`, any parameters given in the mapping that are not used in the circuit will be ignored. If `True` (the default), an error will be raised indicating a logic error.
|
||
|
||
**Raises**
|
||
|
||
* [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If parameters is a dict and contains parameters not present in the circuit.
|
||
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – If parameters is a list/array and the length mismatches the number of free parameters in the circuit.
|
||
|
||
**Returns**
|
||
|
||
A copy of the circuit with bound parameters if `inplace` is False, otherwise None.
|
||
|
||
**Examples**
|
||
|
||
Create a parameterized circuit and assign the parameters in-place.
|
||
|
||
```python
|
||
from qiskit.circuit import QuantumCircuit, Parameter
|
||
|
||
circuit = QuantumCircuit(2)
|
||
params = [Parameter('A'), Parameter('B'), Parameter('C')]
|
||
circuit.ry(params[0], 0)
|
||
circuit.crx(params[1], 0, 1)
|
||
circuit.draw('mpl')
|
||
circuit.assign_parameters({params[0]: params[2]}, inplace=True)
|
||
circuit.draw('mpl')
|
||
```
|
||
|
||
|
||
|
||
|
||
|
||
Bind the values out-of-place by list and get a copy of the original circuit.
|
||
|
||
```python
|
||
from qiskit.circuit import QuantumCircuit, ParameterVector
|
||
|
||
circuit = QuantumCircuit(2)
|
||
params = ParameterVector('P', 2)
|
||
circuit.ry(params[0], 0)
|
||
circuit.crx(params[1], 0, 1)
|
||
|
||
bound_circuit = circuit.assign_parameters([1, 2])
|
||
bound_circuit.draw('mpl')
|
||
|
||
circuit.draw('mpl')
|
||
```
|
||
|
||
|
||
|
||
|
||
</Function>
|
||
|
||
### barrier
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.barrier" signature="barrier(*qargs, label=None)">
|
||
Apply [`Barrier`](qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier"). If `qargs` is empty, applies to all qubits in the circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **qargs** (*QubitSpecifier*) – Specification for one or more qubit arguments.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – The string label of the barrier.
|
||
|
||
**Returns**
|
||
|
||
handle to the added instructions.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### bind\_parameters
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.bind_parameters" signature="bind_parameters(values)">
|
||
Assign numeric parameters to values yielding a new circuit.
|
||
|
||
If the values are given as list or array they are bound to the circuit in the order of [`parameters`](#qiskit.circuit.QuantumCircuit.parameters "qiskit.circuit.QuantumCircuit.parameters") (see the docstring for more details).
|
||
|
||
To assign new Parameter objects or bind the values in-place, without yielding a new circuit, use the [`assign_parameters()`](#qiskit.circuit.QuantumCircuit.assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters") method.
|
||
|
||
**Parameters**
|
||
|
||
**values** ([*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping "(in Python v3.12)")*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.parameter.Parameter")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")*] |* [*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")*]*) – `{parameter: value, ...}` or `[value1, value2, ...]`
|
||
|
||
**Raises**
|
||
|
||
* [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If values is a dict and contains parameters not present in the circuit.
|
||
* [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.12)") – If values contains a ParameterExpression.
|
||
|
||
**Returns**
|
||
|
||
Copy of self with assignment substitution.
|
||
|
||
**Return type**
|
||
|
||
[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### break\_loop
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.break_loop" signature="break_loop()">
|
||
Apply [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp").
|
||
|
||
<Admonition title="Warning" type="caution">
|
||
If you are using the context-manager “builder” forms of [`if_test()`](#qiskit.circuit.QuantumCircuit.if_test "qiskit.circuit.QuantumCircuit.if_test"), [`for_loop()`](#qiskit.circuit.QuantumCircuit.for_loop "qiskit.circuit.QuantumCircuit.for_loop") or [`while_loop()`](#qiskit.circuit.QuantumCircuit.while_loop "qiskit.circuit.QuantumCircuit.while_loop"), you can only call this method if you are within a loop context, because otherwise the “resource width” of the operation cannot be determined. This would quickly lead to invalid circuits, and so if you are trying to construct a reusable loop body (without the context managers), you must also use the non-context-manager form of [`if_test()`](#qiskit.circuit.QuantumCircuit.if_test "qiskit.circuit.QuantumCircuit.if_test") and [`if_else()`](#qiskit.circuit.QuantumCircuit.if_else "qiskit.circuit.QuantumCircuit.if_else"). Take care that the [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp") instruction must span all the resources of its containing loop, not just the immediate scope.
|
||
</Admonition>
|
||
|
||
**Returns**
|
||
|
||
A handle to the instruction created.
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if this method was called within a builder context, but not contained within a loop.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### cast
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cast" signature="cast(value, type_)" modifiers="static">
|
||
Best effort to cast value to type. Otherwise, returns the value.
|
||
|
||
**Return type**
|
||
|
||
*S* | *T*
|
||
</Function>
|
||
|
||
### cbit\_argument\_conversion
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cbit_argument_conversion" signature="cbit_argument_conversion(clbit_representation)">
|
||
Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits.
|
||
|
||
**Parameters**
|
||
|
||
**clbit\_representation** (*Object*) – representation to expand
|
||
|
||
**Returns**
|
||
|
||
Where each tuple is a classical bit.
|
||
|
||
**Return type**
|
||
|
||
List([tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)"))
|
||
</Function>
|
||
|
||
### ccx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ccx" signature="ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)">
|
||
Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit1** (*QubitSpecifier*) – The qubit(s) used as the first control.
|
||
* **control\_qubit2** (*QubitSpecifier*) – The qubit(s) used as the second control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### ccz
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ccz" signature="ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit1** (*QubitSpecifier*) – The qubit(s) used as the first control.
|
||
* **control\_qubit2** (*QubitSpecifier*) – The qubit(s) used as the second control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘10’). Defaults to controlling on the ‘11’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### ch
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ch" signature="ch(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### clear
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.clear" signature="clear()">
|
||
Clear all instructions in self.
|
||
|
||
Clearing the circuits will keep the metadata and calibrations.
|
||
</Function>
|
||
|
||
### cls\_instances
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cls_instances" signature="cls_instances()" modifiers="classmethod">
|
||
Return the current number of instances of this class, useful for auto naming.
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### cls\_prefix
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cls_prefix" signature="cls_prefix()" modifiers="classmethod">
|
||
Return the prefix to use for auto naming.
|
||
|
||
**Return type**
|
||
|
||
[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### cnot
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cnot" signature="cnot(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
|
||
<Admonition title="See also" type="note">
|
||
QuantumCircuit.cx: the same function with a different name.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### compose
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.compose" signature="compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)">
|
||
Compose circuit with `other` circuit or instruction, optionally permuting wires.
|
||
|
||
`other` can be narrower or of equal width to `self`.
|
||
|
||
**Parameters**
|
||
|
||
* **other** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *or*[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – (sub)circuit or instruction to compose onto self. If not a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), this can be anything that [`append`](#qiskit.circuit.QuantumCircuit.append "qiskit.circuit.QuantumCircuit.append") will accept.
|
||
* **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – qubits of self to compose onto.
|
||
* **clbits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – clbits of self to compose onto.
|
||
* **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True, front composition will be performed. This is not possible within control-flow builder context managers.
|
||
* **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True, modify the object. Otherwise return composed circuit.
|
||
* **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True, wraps the other circuit into a gate (or instruction, depending on whether it contains only unitary instructions) before composing it onto self.
|
||
|
||
**Returns**
|
||
|
||
the composed circuit (returns None if inplace==True).
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
* [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if no correct wire mapping can be made between the two circuits, such as if `other` is wider than `self`.
|
||
* [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if trying to emit a new circuit while `self` has a partially built control-flow context active, such as the context-manager forms of [`if_test()`](#qiskit.circuit.QuantumCircuit.if_test "qiskit.circuit.QuantumCircuit.if_test"), [`for_loop()`](#qiskit.circuit.QuantumCircuit.for_loop "qiskit.circuit.QuantumCircuit.for_loop") and [`while_loop()`](#qiskit.circuit.QuantumCircuit.while_loop "qiskit.circuit.QuantumCircuit.while_loop").
|
||
* [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if trying to compose to the front of a circuit when a control-flow builder block is active; there is no clear meaning to this action.
|
||
|
||
**Examples**
|
||
|
||
```python
|
||
>>> lhs.compose(rhs, qubits=[3, 2], inplace=True)
|
||
```
|
||
|
||
```python
|
||
┌───┐ ┌─────┐ ┌───┐
|
||
lqr_1_0: ───┤ H ├─── rqr_0: ──■──┤ Tdg ├ lqr_1_0: ───┤ H ├───────────────
|
||
├───┤ ┌─┴─┐└─────┘ ├───┤
|
||
lqr_1_1: ───┤ X ├─── rqr_1: ┤ X ├─────── lqr_1_1: ───┤ X ├───────────────
|
||
┌──┴───┴──┐ └───┘ ┌──┴───┴──┐┌───┐
|
||
lqr_1_2: ┤ U1(0.1) ├ + = lqr_1_2: ┤ U1(0.1) ├┤ X ├───────
|
||
└─────────┘ └─────────┘└─┬─┘┌─────┐
|
||
lqr_2_0: ─────■───── lqr_2_0: ─────■───────■──┤ Tdg ├
|
||
┌─┴─┐ ┌─┴─┐ └─────┘
|
||
lqr_2_1: ───┤ X ├─── lqr_2_1: ───┤ X ├───────────────
|
||
└───┘ └───┘
|
||
lcr_0: 0 ═══════════ lcr_0: 0 ═══════════════════════
|
||
|
||
lcr_1: 0 ═══════════ lcr_1: 0 ═══════════════════════
|
||
```
|
||
</Function>
|
||
|
||
### continue\_loop
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.continue_loop" signature="continue_loop()">
|
||
Apply [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp").
|
||
|
||
<Admonition title="Warning" type="caution">
|
||
If you are using the context-manager “builder” forms of [`if_test()`](#qiskit.circuit.QuantumCircuit.if_test "qiskit.circuit.QuantumCircuit.if_test"), [`for_loop()`](#qiskit.circuit.QuantumCircuit.for_loop "qiskit.circuit.QuantumCircuit.for_loop") or [`while_loop()`](#qiskit.circuit.QuantumCircuit.while_loop "qiskit.circuit.QuantumCircuit.while_loop"), you can only call this method if you are within a loop context, because otherwise the “resource width” of the operation cannot be determined. This would quickly lead to invalid circuits, and so if you are trying to construct a reusable loop body (without the context managers), you must also use the non-context-manager form of [`if_test()`](#qiskit.circuit.QuantumCircuit.if_test "qiskit.circuit.QuantumCircuit.if_test") and [`if_else()`](#qiskit.circuit.QuantumCircuit.if_else "qiskit.circuit.QuantumCircuit.if_else"). Take care that the [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp") instruction must span all the resources of its containing loop, not just the immediate scope.
|
||
</Admonition>
|
||
|
||
**Returns**
|
||
|
||
A handle to the instruction created.
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if this method was called within a builder context, but not contained within a loop.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### control
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None)">
|
||
Control this circuit on `num_ctrl_qubits` qubits.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – The number of control qubits.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – An optional label to give the controlled operation for visualization.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use `2**num_ctrl_qubits - 1`.
|
||
|
||
**Returns**
|
||
|
||
The controlled version of this circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If the circuit contains a non-unitary operation and cannot be controlled.
|
||
</Function>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.copy" signature="copy(name=None)">
|
||
Copy the circuit.
|
||
|
||
**Parameters**
|
||
|
||
**name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – name to be given to the copied circuit. If None, then the name stays the same
|
||
|
||
**Returns**
|
||
|
||
a deepcopy of the current circuit, with the specified name
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### copy\_empty\_like
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.copy_empty_like" signature="copy_empty_like(name=None)">
|
||
Return a copy of self with the same structure but empty.
|
||
|
||
**That structure includes:**
|
||
|
||
* name, calibrations and other metadata
|
||
* global phase
|
||
* all the qubits and clbits, including the registers
|
||
|
||
**Parameters**
|
||
|
||
**name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name for the copied circuit. If None, then the name stays the same.
|
||
|
||
**Returns**
|
||
|
||
An empty copy of self.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### count\_ops
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.count_ops" signature="count_ops()">
|
||
Count each operation kind in the circuit.
|
||
|
||
**Returns**
|
||
|
||
a breakdown of how many operations of each kind, sorted by amount.
|
||
|
||
**Return type**
|
||
|
||
OrderedDict
|
||
</Function>
|
||
|
||
### cp
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cp" signature="cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** (*ParameterValueType*) – The angle of the rotation.
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### crx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.crx" signature="crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** (*ParameterValueType*) – The angle of the rotation.
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### cry
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cry" signature="cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** (*ParameterValueType*) – The angle of the rotation.
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### crz
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.crz" signature="crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** (*ParameterValueType*) – The angle of the rotation.
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### cs
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cs" signature="cs(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### csdg
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.csdg" signature="csdg(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### cswap
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cswap" signature="cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)">
|
||
Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit1** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **target\_qubit2** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. `'1'`). Defaults to controlling on the `'1'` state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### csx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.csx" signature="csx(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### cu
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cu" signature="cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** (*ParameterValueType*) – The $\theta$ rotation angle of the gate.
|
||
* **phi** (*ParameterValueType*) – The $\phi$ rotation angle of the gate.
|
||
* **lam** (*ParameterValueType*) – The $\lambda$ rotation angle of the gate.
|
||
* **gamma** (*ParameterValueType*) – The global phase applied of the U gate, if applied.
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### cx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cx" signature="cx(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### cy
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cy" signature="cy(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the controls.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### cz
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.cz" signature="cz(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the controls.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### dcx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.dcx" signature="dcx(qubit1, qubit2)">
|
||
Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
* **qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### decompose
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.decompose" signature="decompose(gates_to_decompose=None, reps=1)">
|
||
Call a decomposition pass on this circuit, to decompose one level (shallow decompose).
|
||
|
||
**Parameters**
|
||
|
||
* **gates\_to\_decompose** ([*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*(*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.12)")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*)*) – Optional subset of gates to decompose. Can be a gate type, such as `HGate`, or a gate name, such as ‘h’, or a gate label, such as ‘My H Gate’, or a list of any combination of these. If a gate name is entered, it will decompose all gates with that name, whether the gates have labels or not. Defaults to all gates in circuit.
|
||
* **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – Optional number of times the circuit should be decomposed. For instance, `reps=2` equals calling `circuit.decompose().decompose()`. can decompose specific gates specific time
|
||
|
||
**Returns**
|
||
|
||
a circuit one level decomposed
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### delay
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.delay" signature="delay(duration, qarg=None, unit='dt')">
|
||
Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is `None`, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created.
|
||
|
||
**Parameters**
|
||
|
||
* **duration** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") *or*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – duration of the delay.
|
||
* **qarg** (*Object*) – qubit argument to apply this delay.
|
||
* **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – unit of the duration. Supported units: `'s'`, `'ms'`, `'us'`, `'ns'`, `'ps'`, and `'dt'`. Default is `'dt'`, i.e. integer time unit depending on the target backend.
|
||
|
||
**Returns**
|
||
|
||
handle to the added instructions.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if arguments have bad format.
|
||
</Function>
|
||
|
||
### depth
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.depth" signature="depth(filter_function=<function QuantumCircuit.<lambda>>)">
|
||
Return circuit depth (i.e., length of critical path).
|
||
|
||
**Parameters**
|
||
|
||
**filter\_function** (*callable*) – A function to filter instructions. Should take as input a tuple of (Instruction, list(Qubit), list(Clbit)). Instructions for which the function returns False are ignored in the computation of the circuit depth. By default filters out “directives”, such as barrier or snapshot.
|
||
|
||
**Returns**
|
||
|
||
Depth of circuit.
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")
|
||
|
||
**Notes**
|
||
|
||
The circuit depth and the DAG depth need not be the same.
|
||
</Function>
|
||
|
||
### diagonal
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.diagonal" signature="diagonal(diag, qubit)">
|
||
Attach a diagonal gate to a circuit.
|
||
|
||
The decomposition is based on Theorem 7 given in “Synthesis of Quantum Logic Circuits” by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)).
|
||
|
||
**Parameters**
|
||
|
||
* **diag** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – list of the 2^k diagonal entries (for a diagonal gate on k qubits). Must contain at least two entries
|
||
* **qubit** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – list of k qubits the diagonal is acting on (the order of the qubits specifies the computational basis in which the diagonal gate is provided: the first element in diag acts on the state where all the qubits in q are in the state 0, the second entry acts on the state where all the qubits q\[1],…,q\[k-1] are in the state zero and q\[0] is in the state 1, and so on)
|
||
|
||
**Returns**
|
||
|
||
the diagonal gate which was attached to the circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the list of the diagonal entries or the qubit list is in bad format; if the number of diagonal entries is not 2^k, where k denotes the number of qubits
|
||
</Function>
|
||
|
||
### draw
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.draw" signature="draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)">
|
||
Draw the quantum circuit. Use the output parameter to choose the drawing format:
|
||
|
||
**text**: ASCII art TextDrawing that can be printed in the console.
|
||
|
||
**mpl**: images with color rendered purely in Python using matplotlib.
|
||
|
||
**latex**: high-quality images compiled via latex.
|
||
|
||
**latex\_source**: raw uncompiled latex output.
|
||
|
||
<Admonition title="Warning" type="caution">
|
||
Support for [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") nodes in conditions and `SwitchCaseOp.target` fields is preliminary and incomplete. The `text` and `mpl` drawers will make a best-effort attempt to show data dependencies, but the LaTeX-based drawers will skip these completely.
|
||
</Admonition>
|
||
|
||
**Parameters**
|
||
|
||
* **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – select the output method to use for drawing the circuit. Valid choices are `text`, `mpl`, `latex`, `latex_source`. By default the text drawer is used unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative backend set as the default. For example, `circuit_drawer = latex`. If the output kwarg is set, that backend will always be used over the default in the user config file.
|
||
* **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – scale of image to draw (shrink if \< 1.0). Only used by the mpl, latex and latex\_source outputs. Defaults to 1.0.
|
||
* **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – file path to save image to. Defaults to None.
|
||
* **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – dictionary of style or file name of style json file. This option is only used by the mpl or latex output type. If style is a str, it is used as the path to a json file which contains a style dict. The file will be opened, parsed, and then any style elements in the dict will replace the default values in the input dict. A file to be loaded must end in `.json`, but the name entered here can omit `.json`. For example, `style='iqx.json'` or `style='iqx'`. If style is a dict and the `'name'` key is set, that name will be used to load a json file, followed by loading the other items in the style dict. For example, `style={'name': 'iqx'}`. If style is not a str and name is not a key in the style dict, then the default value from the user config file (usually `~/.qiskit/settings.conf`) will be used, for example, `circuit_mpl_style = iqx`. If none of these are set, the default style will be used. The search path for style json files can be specified in the user config, for example, `circuit_mpl_style_path = /home/user/styles:/home/user`. See: [`DefaultStyle`](qiskit.visualization.qcstyle.DefaultStyle "qiskit.visualization.qcstyle.DefaultStyle") for more information on the contents.
|
||
* **interactive** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to true, show the circuit in a new window (for mpl this depends on the matplotlib backend being used supporting this). Note when used with either the text or the latex\_source output type this has no effect and will be silently ignored. Defaults to False.
|
||
* **reverse\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to True, reverse the bit order inside registers for the output visualization. Defaults to False unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_reverse_bits = True`.
|
||
* **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – enable/disable drawing barriers in the output circuit. Defaults to True.
|
||
* **justify** (*string*) – options are `left`, `right` or `none`. If anything else is supplied, it defaults to left justified. It refers to where gates should be placed in the output circuit if there is an option. `none` results in each gate being placed in its own column.
|
||
* **vertical\_compression** (*string*) – `high`, `medium` or `low`. It merges the lines generated by the text output so the drawing will take less vertical room. Default is `medium`. Only used by the text output, will be silently ignored otherwise.
|
||
* **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – include idle wires (wires with no circuit elements) in output visualization. Default is True.
|
||
* **with\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – include layout information, with labels on the physical layout. Default is True.
|
||
* **fold** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – sets pagination. It can be disabled using -1. In text, sets the length of the lines. This is useful when the drawing does not fit in the console. If None (default), it will try to guess the console width using `shutil.get_terminal_size()`. However, if running in jupyter, the default line length is set to 80 characters. In mpl, it is the number of (visual) layers before folding. Default is 25.
|
||
* **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.8.0)")) – Only used by the mpl backend. An optional Axes object to be used for the visualization output. If none is specified, a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant.
|
||
* **initial\_state** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Optional. Adds `|0>` in the beginning of the wire. Default is False.
|
||
* **cregbundle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Optional. If set True, bundle classical registers. Default is True, except for when `output` is set to `"text"`.
|
||
* **wire\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – Optional. A list of integers used to reorder the display of the bits. The list must have an entry for every bit with the bits in the range 0 to (`num_qubits` + `num_clbits`).
|
||
|
||
**Returns**
|
||
|
||
`TextDrawing` or `matplotlib.figure` or `PIL.Image` or [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)"):
|
||
|
||
* **TextDrawing (output=’text’)**
|
||
|
||
A drawing that can be printed as ascii art.
|
||
|
||
* **matplotlib.figure.Figure (output=’mpl’)**
|
||
|
||
A matplotlib figure object for the circuit diagram.
|
||
|
||
* **PIL.Image (output=’latex’)**
|
||
|
||
An in-memory representation of the image of the circuit diagram.
|
||
|
||
* **str (output=’latex\_source’)**
|
||
|
||
The LaTeX source code for visualizing the circuit diagram.
|
||
|
||
**Raises**
|
||
|
||
* [**VisualizationError**](visualization#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when an invalid output method is selected
|
||
* [**ImportError**](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.12)") – when the output methods requires non-installed libraries.
|
||
|
||
**Example**
|
||
|
||
```python
|
||
from qiskit import QuantumRegister, ClassicalRegister, QuantumCircuit
|
||
q = QuantumRegister(1)
|
||
c = ClassicalRegister(1)
|
||
qc = QuantumCircuit(q, c)
|
||
qc.h(q)
|
||
qc.measure(q, c)
|
||
qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'})
|
||
```
|
||
|
||
|
||
</Function>
|
||
|
||
### ecr
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ecr" signature="ecr(qubit1, qubit2)">
|
||
Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubits to apply the gate to.
|
||
* **qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubits to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### find\_bit
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.find_bit" signature="find_bit(bit)">
|
||
Find locations in the circuit which can be used to reference a given [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit").
|
||
|
||
**Parameters**
|
||
|
||
**bit** ([*Bit*](qiskit.circuit.Bit "qiskit.circuit.Bit")) – The bit to locate.
|
||
|
||
**Returns**
|
||
|
||
**A 2-tuple. The first element (`index`)**
|
||
|
||
contains the index at which the `Bit` can be found (in either [`qubits`](#qiskit.circuit.QuantumCircuit.qubits "qiskit.circuit.QuantumCircuit.qubits"), [`clbits`](#qiskit.circuit.QuantumCircuit.clbits "qiskit.circuit.QuantumCircuit.clbits"), depending on its type). The second element (`registers`) is a list of `(register, index)` pairs with an entry for each [`Register`](qiskit.circuit.Register "qiskit.circuit.Register") in the circuit which contains the [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit") (and the index in the [`Register`](qiskit.circuit.Register "qiskit.circuit.Register") at which it can be found).
|
||
|
||
**Return type**
|
||
|
||
namedtuple([int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)"), List\[Tuple([Register](qiskit.circuit.Register "qiskit.circuit.Register"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)"))])
|
||
|
||
**Notes**
|
||
|
||
The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.circuit.AncillaQubit") will be its index in [`qubits`](#qiskit.circuit.QuantumCircuit.qubits "qiskit.circuit.QuantumCircuit.qubits"), not [`ancillas`](#qiskit.circuit.QuantumCircuit.ancillas "qiskit.circuit.QuantumCircuit.ancillas").
|
||
|
||
**Raises**
|
||
|
||
* [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If the supplied [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit") was of an unknown type.
|
||
* [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If the supplied [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit") could not be found on the circuit.
|
||
|
||
**Return type**
|
||
|
||
*BitLocations*
|
||
</Function>
|
||
|
||
### for\_loop
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.for_loop" signature="for_loop(indexset: Iterable[int], loop_parameter: Parameter | None, body: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.for_loop.ForLoopContext" extraSignatures={["for_loop(indexset: Iterable[int], loop_parameter: Parameter | None, body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet"]}>
|
||
Create a `for` loop on this circuit.
|
||
|
||
There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which, when entered, provides a loop variable (unless one is given, in which case it will be reused) and will automatically build a [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you.
|
||
|
||
For example:
|
||
|
||
```python
|
||
from qiskit import QuantumCircuit
|
||
qc = QuantumCircuit(2, 1)
|
||
|
||
with qc.for_loop(range(5)) as i:
|
||
qc.h(0)
|
||
qc.cx(0, 1)
|
||
qc.measure(0, 0)
|
||
qc.break_loop().c_if(0, True)
|
||
```
|
||
|
||
**Parameters**
|
||
|
||
* **indexset** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – A collection of integers to loop over. Always necessary.
|
||
|
||
* **loop\_parameter** (*Optional\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]*) –
|
||
|
||
The parameter used within `body` to which the values from `indexset` will be assigned. In the context-manager form, if this argument is not supplied, then a loop parameter will be allocated for you and returned as the value of the `with` statement. This will only be bound into the circuit if it is used within the body.
|
||
|
||
If this argument is `None` in the manual form of this method, `body` will be repeated once for each of the items in `indexset` but their values will be ignored.
|
||
|
||
* **body** (*Optional\[*[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – The loop body to be repeatedly executed. Omit this to use the context-manager mode.
|
||
|
||
* **qubits** (*Optional\[Sequence\[QubitSpecifier]]*) – The circuit qubits over which the loop body should be run. Omit this to use the context-manager mode.
|
||
|
||
* **clbits** (*Optional\[Sequence\[ClbitSpecifier]]*) – The circuit clbits over which the loop body should be run. Omit this to use the context-manager mode.
|
||
|
||
* **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]*) – The string label of the instruction in the circuit.
|
||
|
||
**Returns**
|
||
|
||
depending on the call signature, either a context manager for creating the for loop (it will automatically be added to the circuit at the end of the block), or an [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet") handle to the appended loop operation.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet") or ForLoopContext
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if an incorrect calling convention is used.
|
||
</Function>
|
||
|
||
### fredkin
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.fredkin" signature="fredkin(control_qubit, target_qubit1, target_qubit2)">
|
||
Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) used as the control.
|
||
* **target\_qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) targeted by the gate.
|
||
* **target\_qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) targeted by the gate.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
|
||
<Admonition title="See also" type="note">
|
||
QuantumCircuit.cswap: the same function with a different name.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### from\_instructions
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.from_instructions" signature="from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)" modifiers="static">
|
||
Construct a circuit from an iterable of CircuitInstructions.
|
||
|
||
**Parameters**
|
||
|
||
* **instructions** (*Iterable\[*[*CircuitInstruction*](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*, Iterable\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*, Iterable\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*], Iterable\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]]]*) – The instructions to add to the circuit.
|
||
* **qubits** (*Iterable\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – Any qubits to add to the circuit. This argument can be used, for example, to enforce a particular ordering of qubits.
|
||
* **clbits** (*Iterable\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – Any classical bits to add to the circuit. This argument can be used, for example, to enforce a particular ordering of classical bits.
|
||
* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The name of the circuit.
|
||
* **global\_phase** (*ParameterValueType*) – The global phase of the circuit in radians.
|
||
* **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") *| None*) – Arbitrary key value metadata to associate with the circuit.
|
||
|
||
**Returns**
|
||
|
||
The quantum circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### from\_qasm\_file
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.from_qasm_file" signature="from_qasm_file(path)" modifiers="static">
|
||
Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||
|
||
**Parameters**
|
||
|
||
**path** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Path to the file for an OpenQASM 2 program
|
||
|
||
**Returns**
|
||
|
||
The QuantumCircuit object for the input OpenQASM 2.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
<Admonition title="See also" type="note">
|
||
[`qasm2.load()`](qasm2#qiskit.qasm2.load "qiskit.qasm2.load"): the complete interface to the OpenQASM 2 importer.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### from\_qasm\_str
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.from_qasm_str" signature="from_qasm_str(qasm_str)" modifiers="static">
|
||
Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||
|
||
**Parameters**
|
||
|
||
**qasm\_str** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – A string containing an OpenQASM 2.0 program.
|
||
|
||
**Returns**
|
||
|
||
The QuantumCircuit object for the input OpenQASM 2
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
<Admonition title="See also" type="note">
|
||
[`qasm2.loads()`](qasm2#qiskit.qasm2.loads "qiskit.qasm2.loads"): the complete interface to the OpenQASM 2 importer.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### get\_instructions
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.get_instructions" signature="get_instructions(name)">
|
||
Get instructions matching name.
|
||
|
||
**Parameters**
|
||
|
||
**name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – The name of instruction to.
|
||
|
||
**Returns**
|
||
|
||
list of (instruction, qargs, cargs).
|
||
|
||
**Return type**
|
||
|
||
[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")([tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)"))
|
||
</Function>
|
||
|
||
### h
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.h" signature="h(qubit)">
|
||
Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### hamiltonian
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.hamiltonian" signature="hamiltonian(operator, time, qubits, label=None)">
|
||
Apply hamiltonian evolution to qubits.
|
||
|
||
This gate resolves to a [`UnitaryGate`](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate") as $U(t) = exp(-i t H)$, which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits.
|
||
|
||
**Parameters**
|
||
|
||
* **operator** (*matrix or* [*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a hermitian operator.
|
||
* **time** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") *or*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – time evolution parameter.
|
||
* **qubits** (*Union\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, Tuple\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – The circuit qubits to apply the transformation to.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – unitary name for backend \[Default: None].
|
||
|
||
**Returns**
|
||
|
||
The quantum circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**ExtensionError**](extensions#qiskit.extensions.ExtensionError "qiskit.extensions.ExtensionError") – if input data is not an N-qubit unitary operator.
|
||
</Function>
|
||
|
||
### has\_calibration\_for
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.has_calibration_for" signature="has_calibration_for(instruction)">
|
||
Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis.
|
||
</Function>
|
||
|
||
### has\_register
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.has_register" signature="has_register(register)">
|
||
Test if this circuit has the register r.
|
||
|
||
**Parameters**
|
||
|
||
**register** ([*Register*](qiskit.circuit.Register "qiskit.circuit.Register")) – a quantum or classical register.
|
||
|
||
**Returns**
|
||
|
||
True if the register is contained in this circuit.
|
||
|
||
**Return type**
|
||
|
||
[bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### i
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.i" signature="i(qubit)">
|
||
Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### id
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.id" signature="id(qubit)">
|
||
Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
|
||
<Admonition title="See also" type="note">
|
||
QuantumCircuit.i: the same function.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### if\_else
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.if_else" signature="if_else(condition, true_body, false_body, qubits, clbits, label=None)">
|
||
Apply [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp").
|
||
|
||
<Admonition title="Note" type="note">
|
||
This method does not have an associated context-manager form, because it is already handled by the [`if_test()`](#qiskit.circuit.QuantumCircuit.if_test "qiskit.circuit.QuantumCircuit.if_test") method. You can use the `else` part of that with something such as:
|
||
|
||
```python
|
||
from qiskit.circuit import QuantumCircuit, Qubit, Clbit
|
||
bits = [Qubit(), Qubit(), Clbit()]
|
||
qc = QuantumCircuit(bits)
|
||
qc.h(0)
|
||
qc.cx(0, 1)
|
||
qc.measure(0, 0)
|
||
with qc.if_test((bits[2], 0)) as else_:
|
||
qc.h(0)
|
||
with else_:
|
||
qc.x(0)
|
||
```
|
||
</Admonition>
|
||
|
||
**Parameters**
|
||
|
||
* **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")*\[*[*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")*\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")*\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*]*) – A condition to be evaluated at circuit runtime which, if true, will trigger the evaluation of `true_body`. Can be specified as either a tuple of a `ClassicalRegister` to be tested for equality with a given `int`, or as a tuple of a `Clbit` to be compared to either a `bool` or an `int`.
|
||
* **true\_body** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The circuit body to be run if `condition` is true.
|
||
* **false\_body** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The circuit to be run if `condition` is false.
|
||
* **qubits** (*Sequence\[QubitSpecifier]*) – The circuit qubits over which the if/else should be run.
|
||
* **clbits** (*Sequence\[ClbitSpecifier]*) – The circuit clbits over which the if/else should be run.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the instruction in the circuit.
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If the provided condition references Clbits outside the enclosing circuit.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instruction created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### if\_test
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.if_test" signature="if_test(condition: tuple[ClassicalRegister | Clbit, int], true_body: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.if_else.IfContext" extraSignatures={["if_test(condition: tuple[ClassicalRegister | Clbit, int], true_body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None = None) → InstructionSet"]}>
|
||
Create an `if` statement on this circuit.
|
||
|
||
There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") with the given `true_body`, and there will be no branch for the `false` condition (see also the [`if_else()`](#qiskit.circuit.QuantumCircuit.if_else "qiskit.circuit.QuantumCircuit.if_else") method). However, if `true_body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which can be used to build `if` statements. The return value of the `with` statement is a chainable context manager, which can be used to create subsequent `else` blocks. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you.
|
||
|
||
For example:
|
||
|
||
```python
|
||
from qiskit.circuit import QuantumCircuit, Qubit, Clbit
|
||
bits = [Qubit(), Qubit(), Qubit(), Clbit(), Clbit()]
|
||
qc = QuantumCircuit(bits)
|
||
|
||
qc.h(0)
|
||
qc.cx(0, 1)
|
||
qc.measure(0, 0)
|
||
qc.h(0)
|
||
qc.cx(0, 1)
|
||
qc.measure(0, 1)
|
||
|
||
with qc.if_test((bits[3], 0)) as else_:
|
||
qc.x(2)
|
||
with else_:
|
||
qc.h(2)
|
||
qc.z(2)
|
||
```
|
||
|
||
**Parameters**
|
||
|
||
* **condition** (*Tuple\[Union\[*[*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*],* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – A condition to be evaluated at circuit runtime which, if true, will trigger the evaluation of `true_body`. Can be specified as either a tuple of a `ClassicalRegister` to be tested for equality with a given `int`, or as a tuple of a `Clbit` to be compared to either a `bool` or an `int`.
|
||
* **true\_body** (*Optional\[*[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – The circuit body to be run if `condition` is true.
|
||
* **qubits** (*Optional\[Sequence\[QubitSpecifier]]*) – The circuit qubits over which the if/else should be run.
|
||
* **clbits** (*Optional\[Sequence\[ClbitSpecifier]]*) – The circuit clbits over which the if/else should be run.
|
||
* **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]*) – The string label of the instruction in the circuit.
|
||
|
||
**Returns**
|
||
|
||
depending on the call signature, either a context manager for creating the `if` block (it will automatically be added to the circuit at the end of the block), or an [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet") handle to the appended conditional operation.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet") or IfContext
|
||
|
||
**Raises**
|
||
|
||
* [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If the provided condition references Clbits outside the enclosing circuit.
|
||
* [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if an incorrect calling convention is used.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instruction created.
|
||
</Function>
|
||
|
||
### initialize
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.initialize" signature="initialize(params, qubits=None, normalize=False)">
|
||
Initialize qubits in a specific state.
|
||
|
||
Qubit initialization is done by first resetting the qubits to $|0\rangle$ followed by calling `qiskit.extensions.StatePreparation` class to prepare the qubits in a specified state. Both these steps are included in the [`qiskit.extensions.Initialize`](qiskit.extensions.Initialize "qiskit.extensions.Initialize") instruction.
|
||
|
||
**Parameters**
|
||
|
||
* **params** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) –
|
||
|
||
* str: labels of basis states of the Pauli eigenstates Z, X, Y. See [`Statevector.from_label()`](qiskit.quantum_info.Statevector#from_label "qiskit.quantum_info.Statevector.from_label"). Notice the order of the labels is reversed with respect to the qubit index to be applied to. Example label ‘01’ initializes the qubit zero to $|1\rangle$ and the qubit one to $|0\rangle$.
|
||
* list: vector of complex amplitudes to initialize to.
|
||
* int: an integer that is used as a bitmap indicating which qubits to initialize to $|1\rangle$. Example: setting params to 5 would initialize qubit 0 and qubit 2 to $|1\rangle$ and qubit 1 to $|0\rangle$.
|
||
|
||
* **qubits** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *or*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) –
|
||
|
||
* QuantumRegister: A list of qubits to be initialized \[Default: None].
|
||
* Qubit: Single qubit to be initialized \[Default: None].
|
||
* int: Index of qubit to be initialized \[Default: None].
|
||
* list: Indexes of qubits to be initialized \[Default: None].
|
||
|
||
* **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – whether to normalize an input array to a unit vector.
|
||
|
||
**Returns**
|
||
|
||
a handle to the instruction that was just initialized
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
|
||
**Examples**
|
||
|
||
Prepare a qubit in the state $(|0\rangle - |1\rangle) / \sqrt{2}$.
|
||
|
||
```python
|
||
import numpy as np
|
||
from qiskit import QuantumCircuit
|
||
|
||
circuit = QuantumCircuit(1)
|
||
circuit.initialize([1/np.sqrt(2), -1/np.sqrt(2)], 0)
|
||
circuit.draw()
|
||
```
|
||
|
||
output:
|
||
|
||
```python
|
||
┌──────────────────────────────┐
|
||
q_0: ┤ Initialize(0.70711,-0.70711) ├
|
||
└──────────────────────────────┘
|
||
```
|
||
|
||
Initialize from a string two qubits in the state $|10\rangle$. The order of the labels is reversed with respect to qubit index. More information about labels for basis states are in [`Statevector.from_label()`](qiskit.quantum_info.Statevector#from_label "qiskit.quantum_info.Statevector.from_label").
|
||
|
||
```python
|
||
import numpy as np
|
||
from qiskit import QuantumCircuit
|
||
|
||
circuit = QuantumCircuit(2)
|
||
circuit.initialize('01', circuit.qubits)
|
||
circuit.draw()
|
||
```
|
||
|
||
output:
|
||
|
||
```python
|
||
┌──────────────────┐
|
||
q_0: ┤0 ├
|
||
│ Initialize(0,1) │
|
||
q_1: ┤1 ├
|
||
└──────────────────┘
|
||
```
|
||
|
||
Initialize two qubits from an array of complex amplitudes.
|
||
|
||
```python
|
||
import numpy as np
|
||
from qiskit import QuantumCircuit
|
||
|
||
circuit = QuantumCircuit(2)
|
||
circuit.initialize([0, 1/np.sqrt(2), -1.j/np.sqrt(2), 0], circuit.qubits)
|
||
circuit.draw()
|
||
```
|
||
|
||
output:
|
||
|
||
```python
|
||
┌────────────────────────────────────┐
|
||
q_0: ┤0 ├
|
||
│ Initialize(0,0.70711,-0.70711j,0) │
|
||
q_1: ┤1 ├
|
||
└────────────────────────────────────┘
|
||
```
|
||
</Function>
|
||
|
||
### inverse
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.inverse" signature="inverse()">
|
||
Invert (take adjoint of) this circuit.
|
||
|
||
This is done by recursively inverting all gates.
|
||
|
||
**Returns**
|
||
|
||
the inverted circuit
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if the circuit cannot be inverted.
|
||
|
||
**Examples**
|
||
|
||
input:
|
||
|
||
```python
|
||
┌───┐
|
||
q_0: ┤ H ├─────■──────
|
||
└───┘┌────┴─────┐
|
||
q_1: ─────┤ RX(1.57) ├
|
||
└──────────┘
|
||
```
|
||
|
||
output:
|
||
|
||
```python
|
||
┌───┐
|
||
q_0: ──────■──────┤ H ├
|
||
┌─────┴─────┐└───┘
|
||
q_1: ┤ RX(-1.57) ├─────
|
||
└───────────┘
|
||
```
|
||
</Function>
|
||
|
||
### iso
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.iso" signature="iso(isometry, q_input, q_ancillas_for_output, q_ancillas_zero=None, q_ancillas_dirty=None, epsilon=1e-10)">
|
||
Attach an arbitrary isometry from m to n qubits to a circuit. In particular, this allows to attach arbitrary unitaries on n qubits (m=n) or to prepare any state on n qubits (m=0). The decomposition used here was introduced by Iten et al. in [https://arxiv.org/abs/1501.06911](https://arxiv.org/abs/1501.06911).
|
||
|
||
**Parameters**
|
||
|
||
* **isometry** (*ndarray*) – an isometry from m to n qubits, i.e., a (complex) ndarray of dimension 2^n×2^m with orthonormal columns (given in the computational basis specified by the order of the ancillas and the input qubits, where the ancillas are considered to be more significant than the input qubits.).
|
||
* **q\_input** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of m qubits where the input to the isometry is fed in (empty list for state preparation).
|
||
* **q\_ancillas\_for\_output** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of n-m ancilla qubits that are used for the output of the isometry and which are assumed to start in the zero state. The qubits are listed with increasing significance.
|
||
* **q\_ancillas\_zero** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which are assumed to start in the zero state. Default is q\_ancillas\_zero = None.
|
||
* **q\_ancillas\_dirty** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which can start in an arbitrary state. Default is q\_ancillas\_dirty = None.
|
||
* **epsilon** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – error tolerance of calculations. Default is epsilon = \_EPS.
|
||
|
||
**Returns**
|
||
|
||
the isometry is attached to the quantum circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the array is not an isometry of the correct size corresponding to the provided number of qubits.
|
||
</Function>
|
||
|
||
### isometry
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.isometry" signature="isometry(isometry, q_input, q_ancillas_for_output, q_ancillas_zero=None, q_ancillas_dirty=None, epsilon=1e-10)">
|
||
Attach an arbitrary isometry from m to n qubits to a circuit. In particular, this allows to attach arbitrary unitaries on n qubits (m=n) or to prepare any state on n qubits (m=0). The decomposition used here was introduced by Iten et al. in [https://arxiv.org/abs/1501.06911](https://arxiv.org/abs/1501.06911).
|
||
|
||
**Parameters**
|
||
|
||
* **isometry** (*ndarray*) – an isometry from m to n qubits, i.e., a (complex) ndarray of dimension 2^n×2^m with orthonormal columns (given in the computational basis specified by the order of the ancillas and the input qubits, where the ancillas are considered to be more significant than the input qubits.).
|
||
* **q\_input** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of m qubits where the input to the isometry is fed in (empty list for state preparation).
|
||
* **q\_ancillas\_for\_output** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of n-m ancilla qubits that are used for the output of the isometry and which are assumed to start in the zero state. The qubits are listed with increasing significance.
|
||
* **q\_ancillas\_zero** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which are assumed to start in the zero state. Default is q\_ancillas\_zero = None.
|
||
* **q\_ancillas\_dirty** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which can start in an arbitrary state. Default is q\_ancillas\_dirty = None.
|
||
* **epsilon** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – error tolerance of calculations. Default is epsilon = \_EPS.
|
||
|
||
**Returns**
|
||
|
||
the isometry is attached to the quantum circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the array is not an isometry of the correct size corresponding to the provided number of qubits.
|
||
</Function>
|
||
|
||
### iswap
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.iswap" signature="iswap(qubit1, qubit2)">
|
||
Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubits to apply the gate to.
|
||
* **qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubits to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### mcp
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.mcp" signature="mcp(lam, control_qubits, target_qubit)">
|
||
Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The angle of the rotation.
|
||
* **control\_qubits** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – The qubits used as the controls.
|
||
* **target\_qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) targeted by the gate.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### mcrx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.mcrx" signature="mcrx(theta, q_controls, q_target, use_basis_gates=False)">
|
||
Apply Multiple-Controlled X rotation gate
|
||
|
||
**Parameters**
|
||
|
||
* **self** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The QuantumCircuit object to apply the mcrx gate on.
|
||
* **theta** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – angle theta
|
||
* **q\_controls** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*(*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*)*) – The list of control qubits
|
||
* **q\_target** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The target qubit
|
||
* **use\_basis\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – use p, u, cx
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – parameter errors
|
||
</Function>
|
||
|
||
### mcry
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.mcry" signature="mcry(theta, q_controls, q_target, q_ancillae=None, mode=None, use_basis_gates=False)">
|
||
Apply Multiple-Controlled Y rotation gate
|
||
|
||
**Parameters**
|
||
|
||
* **self** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The QuantumCircuit object to apply the mcry gate on.
|
||
* **theta** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – angle theta
|
||
* **q\_controls** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*(*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*)*) – The list of control qubits
|
||
* **q\_target** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The target qubit
|
||
* **q\_ancillae** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")*(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*)*) – The list of ancillary qubits.
|
||
* **mode** (*string*) – The implementation mode to use
|
||
* **use\_basis\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – use p, u, cx
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – parameter errors
|
||
</Function>
|
||
|
||
### mcrz
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.mcrz" signature="mcrz(lam, q_controls, q_target, use_basis_gates=False)">
|
||
Apply Multiple-Controlled Z rotation gate
|
||
|
||
**Parameters**
|
||
|
||
* **self** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The QuantumCircuit object to apply the mcrz gate on.
|
||
* **lam** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – angle lambda
|
||
* **q\_controls** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*(*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*)*) – The list of control qubits
|
||
* **q\_target** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The target qubit
|
||
* **use\_basis\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – use p, u, cx
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – parameter errors
|
||
</Function>
|
||
|
||
### mct
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.mct" signature="mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')">
|
||
Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate").
|
||
|
||
The multi-cX gate can be implemented using different techniques, which use different numbers of ancilla qubits and have varying circuit depth. These modes are:
|
||
|
||
* `'noancilla'`: Requires 0 ancilla qubits.
|
||
* `'recursion'`: Requires 1 ancilla qubit if more than 4 controls are used, otherwise 0.
|
||
* `'v-chain'`: Requires 2 less ancillas than the number of control qubits.
|
||
* `'v-chain-dirty'`: Same as for the clean ancillas (but the circuit will be longer).
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubits** (*Sequence\[QubitSpecifier]*) – The qubits used as the controls.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **ancilla\_qubits** (*QubitSpecifier | Sequence\[QubitSpecifier] | None*) – The qubits used as the ancillae, if the mode requires them.
|
||
* **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – The choice of mode, explained further above.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Raises**
|
||
|
||
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – if the given mode is not known, or if too few ancilla qubits are passed.
|
||
* [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.12)") – if no ancilla qubits are passed, but some are needed.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
|
||
<Admonition title="See also" type="note">
|
||
QuantumCircuit.mcx: the same gate with a different name.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### mcx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.mcx" signature="mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')">
|
||
Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate").
|
||
|
||
The multi-cX gate can be implemented using different techniques, which use different numbers of ancilla qubits and have varying circuit depth. These modes are:
|
||
|
||
* `'noancilla'`: Requires 0 ancilla qubits.
|
||
* `'recursion'`: Requires 1 ancilla qubit if more than 4 controls are used, otherwise 0.
|
||
* `'v-chain'`: Requires 2 less ancillas than the number of control qubits.
|
||
* `'v-chain-dirty'`: Same as for the clean ancillas (but the circuit will be longer).
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubits** (*Sequence\[QubitSpecifier]*) – The qubits used as the controls.
|
||
* **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate.
|
||
* **ancilla\_qubits** (*QubitSpecifier | Sequence\[QubitSpecifier] | None*) – The qubits used as the ancillae, if the mode requires them.
|
||
* **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – The choice of mode, explained further above.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Raises**
|
||
|
||
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – if the given mode is not known, or if too few ancilla qubits are passed.
|
||
* [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.12)") – if no ancilla qubits are passed, but some are needed.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### measure
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.measure" signature="measure(qubit, cbit)">
|
||
Measure a quantum bit (`qubit`) in the Z basis into a classical bit (`cbit`).
|
||
|
||
When a quantum state is measured, a qubit is projected in the computational (Pauli Z) basis to either $\lvert 0 \rangle$ or $\lvert 1 \rangle$. The classical bit `cbit` indicates the result of that projection as a `0` or a `1` respectively. This operation is non-reversible.
|
||
|
||
**Parameters**
|
||
|
||
* **qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – qubit(s) to measure.
|
||
* **cbit** ([*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.classicalregister.Clbit") *|*[*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.classicalregister.ClassicalRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.classicalregister.Clbit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – classical bit(s) to place the measurement result(s) in.
|
||
|
||
**Returns**
|
||
|
||
handle to the added instructions.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if arguments have bad format.
|
||
|
||
**Examples**
|
||
|
||
In this example, a qubit is measured and the result of that measurement is stored in the classical bit (usually expressed in diagrams as a double line):
|
||
|
||
```python
|
||
from qiskit import QuantumCircuit
|
||
circuit = QuantumCircuit(1, 1)
|
||
circuit.h(0)
|
||
circuit.measure(0, 0)
|
||
circuit.draw()
|
||
```
|
||
|
||
```python
|
||
┌───┐┌─┐
|
||
q: ┤ H ├┤M├
|
||
└───┘└╥┘
|
||
c: 1/══════╩═
|
||
0
|
||
```
|
||
|
||
It is possible to call `measure` with lists of `qubits` and `cbits` as a shortcut for one-to-one measurement. These two forms produce identical results:
|
||
|
||
```python
|
||
circuit = QuantumCircuit(2, 2)
|
||
circuit.measure([0,1], [0,1])
|
||
```
|
||
|
||
```python
|
||
circuit = QuantumCircuit(2, 2)
|
||
circuit.measure(0, 0)
|
||
circuit.measure(1, 1)
|
||
```
|
||
|
||
Instead of lists, you can use [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") and [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") under the same logic.
|
||
|
||
```python
|
||
from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister
|
||
qreg = QuantumRegister(2, "qreg")
|
||
creg = ClassicalRegister(2, "creg")
|
||
circuit = QuantumCircuit(qreg, creg)
|
||
circuit.measure(qreg, creg)
|
||
```
|
||
|
||
This is equivalent to:
|
||
|
||
```python
|
||
circuit = QuantumCircuit(qreg, creg)
|
||
circuit.measure(qreg[0], creg[0])
|
||
circuit.measure(qreg[1], creg[1])
|
||
```
|
||
</Function>
|
||
|
||
### measure\_active
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.measure_active" signature="measure_active(inplace=True)">
|
||
Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured.
|
||
|
||
Returns a new circuit with measurements if inplace=False.
|
||
|
||
**Parameters**
|
||
|
||
**inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – All measurements inplace or return new circuit.
|
||
|
||
**Returns**
|
||
|
||
Returns circuit with measurements when inplace = False.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### measure\_all
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.measure_all" signature="measure_all(inplace=True, add_bits=True)">
|
||
Adds measurement to all qubits.
|
||
|
||
By default, adds new classical bits in a [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") to store these measurements. If `add_bits=False`, the results of the measurements will instead be stored in the already existing classical bits, with qubit `n` being measured into classical bit `n`.
|
||
|
||
Returns a new circuit with measurements if `inplace=False`.
|
||
|
||
**Parameters**
|
||
|
||
* **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – All measurements inplace or return new circuit.
|
||
* **add\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Whether to add new bits to store the results.
|
||
|
||
**Returns**
|
||
|
||
Returns circuit with measurements when `inplace=False`.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if `add_bits=False` but there are not enough classical bits.
|
||
</Function>
|
||
|
||
### ms
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ms" signature="ms(theta, qubits)">
|
||
Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The angle of the rotation.
|
||
* **qubits** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – The qubits to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### num\_connected\_components
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.num_connected_components" signature="num_connected_components(unitary_only=False)">
|
||
How many non-entangled subcircuits can the circuit be factored to.
|
||
|
||
**Parameters**
|
||
|
||
**unitary\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Compute only unitary part of graph.
|
||
|
||
**Returns**
|
||
|
||
Number of connected components in circuit.
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### num\_nonlocal\_gates
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.num_nonlocal_gates" signature="num_nonlocal_gates()">
|
||
Return number of non-local gates (i.e. involving 2+ qubits).
|
||
|
||
Conditional nonlocal gates are also included.
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### num\_tensor\_factors
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.num_tensor_factors" signature="num_tensor_factors()">
|
||
Computes the number of tensor factors in the unitary (quantum) part of the circuit only.
|
||
|
||
**Notes**
|
||
|
||
This is here for backwards compatibility, and will be removed in a future release of Qiskit. You should call num\_unitary\_factors instead.
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### num\_unitary\_factors
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.num_unitary_factors" signature="num_unitary_factors()">
|
||
Computes the number of tensor factors in the unitary (quantum) part of the circuit only.
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### p
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.p" signature="p(theta, qubit)">
|
||
Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – THe angle of the rotation.
|
||
* **qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### pauli
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.pauli" signature="pauli(pauli_string, qubits)">
|
||
Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate").
|
||
|
||
**Parameters**
|
||
|
||
* **pauli\_string** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – A string representing the Pauli operator to apply, e.g. ‘XX’.
|
||
* **qubits** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – The qubits to apply this gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### power
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.power" signature="power(power, matrix_power=False)">
|
||
Raise this circuit to the power of `power`.
|
||
|
||
If `power` is a positive integer and `matrix_power` is `False`, this implementation defaults to calling `repeat`. Otherwise, if the circuit is unitary, the matrix is computed to calculate the matrix power.
|
||
|
||
**Parameters**
|
||
|
||
* **power** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The power to raise this circuit to.
|
||
* **matrix\_power** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True, the circuit is converted to a matrix and then the matrix power is computed. If False, and `power` is a positive integer, the implementation defaults to `repeat`.
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If the circuit needs to be converted to a gate but it is not unitary.
|
||
|
||
**Returns**
|
||
|
||
A circuit implementing this circuit raised to the power of `power`.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### prepare\_state
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.prepare_state" signature="prepare_state(state, qubits=None, label=None, normalize=False)">
|
||
Prepare qubits in a specific state.
|
||
|
||
This class implements a state preparing unitary. Unlike [`qiskit.extensions.Initialize`](qiskit.extensions.Initialize "qiskit.extensions.Initialize") it does not reset the qubits first.
|
||
|
||
**Parameters**
|
||
|
||
* **state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) –
|
||
|
||
* Statevector: Statevector to initialize to.
|
||
* str: labels of basis states of the Pauli eigenstates Z, X, Y. See [`Statevector.from_label()`](qiskit.quantum_info.Statevector#from_label "qiskit.quantum_info.Statevector.from_label"). Notice the order of the labels is reversed with respect to the qubit index to be applied to. Example label ‘01’ initializes the qubit zero to $|1\rangle$ and the qubit one to $|0\rangle$.
|
||
* list: vector of complex amplitudes to initialize to.
|
||
* int: an integer that is used as a bitmap indicating which qubits to initialize to $|1\rangle$. Example: setting params to 5 would initialize qubit 0 and qubit 2 to $|1\rangle$ and qubit 1 to $|0\rangle$.
|
||
|
||
* **qubits** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *or*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) –
|
||
|
||
* QuantumRegister: A list of qubits to be initialized \[Default: None].
|
||
* Qubit: Single qubit to be initialized \[Default: None].
|
||
* int: Index of qubit to be initialized \[Default: None].
|
||
* list: Indexes of qubits to be initialized \[Default: None].
|
||
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – An optional label for the gate
|
||
|
||
* **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Whether to normalize an input array to a unit vector.
|
||
|
||
**Returns**
|
||
|
||
a handle to the instruction that was just initialized
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
|
||
**Examples**
|
||
|
||
Prepare a qubit in the state $(|0\rangle - |1\rangle) / \sqrt{2}$.
|
||
|
||
```python
|
||
import numpy as np
|
||
from qiskit import QuantumCircuit
|
||
|
||
circuit = QuantumCircuit(1)
|
||
circuit.prepare_state([1/np.sqrt(2), -1/np.sqrt(2)], 0)
|
||
circuit.draw()
|
||
```
|
||
|
||
output:
|
||
|
||
```python
|
||
┌─────────────────────────────────────┐
|
||
q_0: ┤ State Preparation(0.70711,-0.70711) ├
|
||
└─────────────────────────────────────┘
|
||
```
|
||
|
||
Prepare from a string two qubits in the state $|10\rangle$. The order of the labels is reversed with respect to qubit index. More information about labels for basis states are in [`Statevector.from_label()`](qiskit.quantum_info.Statevector#from_label "qiskit.quantum_info.Statevector.from_label").
|
||
|
||
```python
|
||
import numpy as np
|
||
from qiskit import QuantumCircuit
|
||
|
||
circuit = QuantumCircuit(2)
|
||
circuit.prepare_state('01', circuit.qubits)
|
||
circuit.draw()
|
||
```
|
||
|
||
output:
|
||
|
||
```python
|
||
┌─────────────────────────┐
|
||
q_0: ┤0 ├
|
||
│ State Preparation(0,1) │
|
||
q_1: ┤1 ├
|
||
└─────────────────────────┘
|
||
```
|
||
|
||
Initialize two qubits from an array of complex amplitudes .. code-block:
|
||
|
||
```python
|
||
import numpy as np
|
||
from qiskit import QuantumCircuit
|
||
|
||
circuit = QuantumCircuit(2)
|
||
circuit.prepare_state([0, 1/np.sqrt(2), -1.j/np.sqrt(2), 0], circuit.qubits)
|
||
circuit.draw()
|
||
```
|
||
|
||
output:
|
||
|
||
```python
|
||
┌───────────────────────────────────────────┐
|
||
q_0: ┤0 ├
|
||
│ State Preparation(0,0.70711,-0.70711j,0) │
|
||
q_1: ┤1 ├
|
||
└───────────────────────────────────────────┘
|
||
```
|
||
</Function>
|
||
|
||
### qasm
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.qasm" signature="qasm(formatted=False, filename=None, encoding=None)">
|
||
Return OpenQASM string.
|
||
|
||
**Parameters**
|
||
|
||
* **formatted** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Return formatted OpenQASM 2.0 string.
|
||
* **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Save OpenQASM 2.0 to file with name ‘filename’.
|
||
* **encoding** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Optionally specify the encoding to use for the output file if `filename` is specified. By default this is set to the system’s default encoding (ie whatever `locale.getpreferredencoding()` returns) and can be set to any valid codec or alias from stdlib’s [codec module](https://docs.python.org/3/library/codecs.html#standard-encodings)
|
||
|
||
**Returns**
|
||
|
||
If formatted=False.
|
||
|
||
**Return type**
|
||
|
||
[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")
|
||
|
||
**Raises**
|
||
|
||
* [**MissingOptionalLibraryError**](exceptions#qiskit.exceptions.MissingOptionalLibraryError "qiskit.exceptions.MissingOptionalLibraryError") – If pygments is not installed and `formatted` is `True`.
|
||
* [**QASM2ExportError**](qasm2#qiskit.qasm2.QASM2ExportError "qiskit.qasm2.QASM2ExportError") – If circuit has free parameters.
|
||
* [**QASM2ExportError**](qasm2#qiskit.qasm2.QASM2ExportError "qiskit.qasm2.QASM2ExportError") – If an operation that has no OpenQASM 2 representation is encountered.
|
||
</Function>
|
||
|
||
### qbit\_argument\_conversion
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.qbit_argument_conversion" signature="qbit_argument_conversion(qubit_representation)">
|
||
Converts several qubit representations (such as indexes, range, etc.) into a list of qubits.
|
||
|
||
**Parameters**
|
||
|
||
**qubit\_representation** (*Object*) – representation to expand
|
||
|
||
**Returns**
|
||
|
||
the resolved instances of the qubits.
|
||
|
||
**Return type**
|
||
|
||
List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit"))
|
||
</Function>
|
||
|
||
### qubit\_duration
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.qubit_duration" signature="qubit_duration(*qubits)">
|
||
Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`.
|
||
|
||
**Parameters**
|
||
|
||
**\*qubits** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – Qubits within `self` to include.
|
||
|
||
**Returns**
|
||
|
||
Return the duration between the first start and last stop time of non-delay instructions
|
||
|
||
**Return type**
|
||
|
||
[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### qubit\_start\_time
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.qubit_start_time" signature="qubit_start_time(*qubits)">
|
||
Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`.
|
||
|
||
Return 0 if there are no instructions over qubits
|
||
|
||
**Parameters**
|
||
|
||
* **\*qubits** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – Qubits within `self` to include. Integers are allowed for qubits, indicating
|
||
* **self.qubits.** (*indices of*) –
|
||
|
||
**Returns**
|
||
|
||
Return the start time of the first instruction, excluding delays, over the qubits
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if `self` is a not-yet scheduled circuit.
|
||
|
||
**Return type**
|
||
|
||
[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### qubit\_stop\_time
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.qubit_stop_time" signature="qubit_stop_time(*qubits)">
|
||
Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`.
|
||
|
||
Return 0 if there are no instructions over qubits
|
||
|
||
**Parameters**
|
||
|
||
* **\*qubits** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – Qubits within `self` to include. Integers are allowed for qubits, indicating
|
||
* **self.qubits.** (*indices of*) –
|
||
|
||
**Returns**
|
||
|
||
Return the stop time of the last instruction, excluding delays, over the qubits
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if `self` is a not-yet scheduled circuit.
|
||
|
||
**Return type**
|
||
|
||
[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### r
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.r" signature="r(theta, phi, qubit)">
|
||
Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The angle of the rotation.
|
||
* **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The angle of the axis of rotation in the x-y plane.
|
||
* **qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### rcccx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.rcccx" signature="rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)">
|
||
Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) used as the first control.
|
||
* **control\_qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) used as the second control.
|
||
* **control\_qubit3** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) used as the third control.
|
||
* **target\_qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) targeted by the gate.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### rccx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.rccx" signature="rccx(control_qubit1, control_qubit2, target_qubit)">
|
||
Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) used as the first control.
|
||
* **control\_qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) used as the second control.
|
||
* **target\_qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) targeted by the gate.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### remove\_final\_measurements
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.remove_final_measurements" signature="remove_final_measurements(inplace=True)">
|
||
Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation.
|
||
|
||
Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.)
|
||
|
||
**Parameters**
|
||
|
||
**inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – All measurements removed inplace or return new circuit.
|
||
|
||
**Returns**
|
||
|
||
Returns the resulting circuit when `inplace=False`, else None.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### repeat
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.repeat" signature="repeat(reps)">
|
||
Repeat this circuit `reps` times.
|
||
|
||
**Parameters**
|
||
|
||
**reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – How often this circuit should be repeated.
|
||
|
||
**Returns**
|
||
|
||
A circuit containing `reps` repetitions of this circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### reset
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.reset" signature="reset(qubit)">
|
||
Reset the quantum bit(s) to their default state.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – qubit(s) to reset.
|
||
|
||
**Returns**
|
||
|
||
handle to the added instruction.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### reverse\_bits
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.reverse_bits" signature="reverse_bits()">
|
||
Return a circuit with the opposite order of wires.
|
||
|
||
The circuit is “vertically” flipped. If a circuit is defined over multiple registers, the resulting circuit will have the same registers but with their order flipped.
|
||
|
||
This method is useful for converting a circuit written in little-endian convention to the big-endian equivalent, and vice versa.
|
||
|
||
**Returns**
|
||
|
||
the circuit with reversed bit order.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Examples**
|
||
|
||
input:
|
||
|
||
```python
|
||
┌───┐
|
||
a_0: ┤ H ├──■─────────────────
|
||
└───┘┌─┴─┐
|
||
a_1: ─────┤ X ├──■────────────
|
||
└───┘┌─┴─┐
|
||
a_2: ──────────┤ X ├──■───────
|
||
└───┘┌─┴─┐
|
||
b_0: ───────────────┤ X ├──■──
|
||
└───┘┌─┴─┐
|
||
b_1: ────────────────────┤ X ├
|
||
└───┘
|
||
```
|
||
|
||
output:
|
||
|
||
```python
|
||
┌───┐
|
||
b_0: ────────────────────┤ X ├
|
||
┌───┐└─┬─┘
|
||
b_1: ───────────────┤ X ├──■──
|
||
┌───┐└─┬─┘
|
||
a_0: ──────────┤ X ├──■───────
|
||
┌───┐└─┬─┘
|
||
a_1: ─────┤ X ├──■────────────
|
||
┌───┐└─┬─┘
|
||
a_2: ┤ H ├──■─────────────────
|
||
└───┘
|
||
```
|
||
</Function>
|
||
|
||
### reverse\_ops
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.reverse_ops" signature="reverse_ops()">
|
||
Reverse the circuit by reversing the order of instructions.
|
||
|
||
This is done by recursively reversing all instructions. It does not invert (adjoint) any gate.
|
||
|
||
**Returns**
|
||
|
||
the reversed circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Examples**
|
||
|
||
input:
|
||
|
||
```python
|
||
┌───┐
|
||
q_0: ┤ H ├─────■──────
|
||
└───┘┌────┴─────┐
|
||
q_1: ─────┤ RX(1.57) ├
|
||
└──────────┘
|
||
```
|
||
|
||
output:
|
||
|
||
```python
|
||
┌───┐
|
||
q_0: ─────■──────┤ H ├
|
||
┌────┴─────┐└───┘
|
||
q_1: ┤ RX(1.57) ├─────
|
||
└──────────┘
|
||
```
|
||
</Function>
|
||
|
||
### rv
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.rv" signature="rv(vx, vy, vz, qubit)">
|
||
Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
Rotation around an arbitrary rotation axis $v$, where $|v|$ is the angle of rotation in radians.
|
||
|
||
**Parameters**
|
||
|
||
* **vx** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – x-component of the rotation axis.
|
||
* **vy** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – y-component of the rotation axis.
|
||
* **vz** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – z-component of the rotation axis.
|
||
* **qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### rx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.rx" signature="rx(theta, qubit, label=None)">
|
||
Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** (*ParameterValueType*) – The rotation angle of the gate.
|
||
* **qubit** (*QubitSpecifier*) – The qubit(s) to apply the gate to.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### rxx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.rxx" signature="rxx(theta, qubit1, qubit2)">
|
||
Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The angle of the rotation.
|
||
* **qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
* **qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### ry
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ry" signature="ry(theta, qubit, label=None)">
|
||
Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** (*ParameterValueType*) – The rotation angle of the gate.
|
||
* **qubit** (*QubitSpecifier*) – The qubit(s) to apply the gate to.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### ryy
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ryy" signature="ryy(theta, qubit1, qubit2)">
|
||
Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The rotation angle of the gate.
|
||
* **qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
* **qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### rz
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.rz" signature="rz(phi, qubit)">
|
||
Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The rotation angle of the gate.
|
||
* **qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### rzx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.rzx" signature="rzx(theta, qubit1, qubit2)">
|
||
Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The rotation angle of the gate.
|
||
* **qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
* **qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### rzz
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.rzz" signature="rzz(theta, qubit1, qubit2)">
|
||
Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The rotation angle of the gate.
|
||
* **qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
* **qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### s
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.s" signature="s(qubit)">
|
||
Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### sdg
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.sdg" signature="sdg(qubit)">
|
||
Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### size
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.size" signature="size(filter_function=<function QuantumCircuit.<lambda>>)">
|
||
Returns total number of instructions in circuit.
|
||
|
||
**Parameters**
|
||
|
||
**filter\_function** (*callable*) – a function to filter out some instructions. Should take as input a tuple of (Instruction, list(Qubit), list(Clbit)). By default filters out “directives”, such as barrier or snapshot.
|
||
|
||
**Returns**
|
||
|
||
Total number of gate operations.
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### snapshot
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.snapshot" signature="snapshot(label, snapshot_type='statevector', qubits=None, params=None)">
|
||
Take a statevector snapshot of the internal simulator representation. Works on all qubits, and prevents reordering (like barrier).
|
||
|
||
For other types of snapshots use the Snapshot extension directly.
|
||
|
||
**Parameters**
|
||
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – a snapshot label to report the result.
|
||
* **snapshot\_type** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – the type of the snapshot.
|
||
* **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)") *or None*) – the qubits to apply snapshot to \[Default: None].
|
||
* **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)") *or None*) – the parameters for snapshot\_type \[Default: None].
|
||
|
||
**Returns**
|
||
|
||
with attached command
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**ExtensionError**](extensions#qiskit.extensions.ExtensionError "qiskit.extensions.ExtensionError") – malformed command
|
||
</Function>
|
||
|
||
### squ
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.squ" signature="squ(unitary_matrix, qubit, mode='ZYZ', up_to_diagonal=False)">
|
||
Decompose an arbitrary 2\*2 unitary into three rotation gates.
|
||
|
||
Note that the decomposition is up to a global phase shift. (This is a well known decomposition which can be found for example in Nielsen and Chuang’s book “Quantum computation and quantum information”.)
|
||
|
||
**Parameters**
|
||
|
||
* **unitary\_matrix** (*ndarray*) – 2\*2 unitary (given as a (complex) ndarray).
|
||
* **qubit** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *or*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The qubit which the gate is acting on.
|
||
* **mode** (*string*) – determines the used decomposition by providing the rotation axes. The allowed modes are: “ZYZ” (default)
|
||
* **up\_to\_diagonal** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if set to True, the single-qubit unitary is decomposed up to a diagonal matrix, i.e. a unitary u’ is implemented such that there exists a 2\*2 diagonal gate d with u = d.dot(u’)
|
||
|
||
**Returns**
|
||
|
||
The single-qubit unitary instruction attached to the circuit.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the format is wrong; if the array u is not unitary
|
||
</Function>
|
||
|
||
### swap
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.swap" signature="swap(qubit1, qubit2)">
|
||
Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubits to apply the gate to.
|
||
* **qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubits to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### switch
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.switch" signature="switch(target: Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int], cases: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.switch_case.SwitchContext" extraSignatures={["switch(target: Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int], cases: Iterable[Tuple[Any, QuantumCircuit]], qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet"]}>
|
||
Create a `switch`/`case` structure on this circuit.
|
||
|
||
There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") with the given case structure. If `cases` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you.
|
||
|
||
Example usage:
|
||
|
||
```python
|
||
from qiskit.circuit import QuantumCircuit, ClassicalRegister, QuantumRegister
|
||
qreg = QuantumRegister(3)
|
||
creg = ClassicalRegister(3)
|
||
qc = QuantumCircuit(qreg, creg)
|
||
qc.h([0, 1, 2])
|
||
qc.measure([0, 1, 2], [0, 1, 2])
|
||
|
||
with qc.switch(creg) as case:
|
||
with case(0):
|
||
qc.x(0)
|
||
with case(1, 2):
|
||
qc.z(1)
|
||
with case(case.DEFAULT):
|
||
qc.cx(0, 1)
|
||
```
|
||
|
||
**Parameters**
|
||
|
||
* **target** (*Union\[*[*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – The classical value to switch one. This must be integer-like.
|
||
* **cases** (*Iterable\[Tuple\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")*,* [*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]]*) – A sequence of case specifiers. Each tuple defines one case body (the second item). The first item of the tuple can be either a single integer value, the special value [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT"), or a tuple of several integer values. Each of the integer values will be tried in turn; control will then pass to the body corresponding to the first match. [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT") matches all possible values. Omit in context-manager form.
|
||
* **qubits** (*Sequence\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – The circuit qubits over which all case bodies execute. Omit in context-manager form.
|
||
* **clbits** (*Sequence\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – The circuit clbits over which all case bodies execute. Omit in context-manager form.
|
||
* **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]*) – The string label of the instruction in the circuit.
|
||
|
||
**Returns**
|
||
|
||
If used in context-manager mode, then this should be used as a `with` resource, which will return an object that can be repeatedly entered to produce cases for the switch statement. If the full form is used, then this returns a handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet") or SwitchCaseContext
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if an incorrect calling convention is used.
|
||
</Function>
|
||
|
||
### sx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.sx" signature="sx(qubit)">
|
||
Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### sxdg
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.sxdg" signature="sxdg(qubit)">
|
||
Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### t
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.t" signature="t(qubit)">
|
||
Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### tdg
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.tdg" signature="tdg(qubit)">
|
||
Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### tensor
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.tensor" signature="tensor(other, inplace=False)">
|
||
Tensor `self` with `other`.
|
||
|
||
Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](qiskit.org/documentation/tutorials/circuits/3_summary_of_quantum_operations) for more information.
|
||
|
||
```python
|
||
┌────────┐ ┌─────┐ ┌─────┐
|
||
q_0: ┤ bottom ├ ⊗ q_0: ┤ top ├ = q_0: ─┤ top ├──
|
||
└────────┘ └─────┘ ┌┴─────┴─┐
|
||
q_1: ┤ bottom ├
|
||
└────────┘
|
||
```
|
||
|
||
**Parameters**
|
||
|
||
* **other** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The other circuit to tensor this circuit with.
|
||
* **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True, modify the object. Otherwise return composed circuit.
|
||
|
||
**Return type**
|
||
|
||
[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") | None
|
||
|
||
**Examples**
|
||
|
||
```python
|
||
from qiskit import QuantumCircuit
|
||
top = QuantumCircuit(1)
|
||
top.x(0);
|
||
bottom = QuantumCircuit(2)
|
||
bottom.cry(0.2, 0, 1);
|
||
tensored = bottom.tensor(top)
|
||
tensored.draw('mpl')
|
||
```
|
||
|
||
|
||
|
||
**Returns**
|
||
|
||
The tensored circuit (returns None if inplace==True).
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### to\_gate
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.to_gate" signature="to_gate(parameter_map=None, label=None)">
|
||
Create a Gate out of this circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If None, existing circuit parameters will also parameterize the gate.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Optional gate label.
|
||
|
||
**Returns**
|
||
|
||
a composite gate encapsulating this circuit (can be decomposed back)
|
||
|
||
**Return type**
|
||
|
||
[Gate](qiskit.circuit.Gate "qiskit.circuit.Gate")
|
||
</Function>
|
||
|
||
### to\_instruction
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.to_instruction" signature="to_instruction(parameter_map=None, label=None)">
|
||
Create an Instruction out of this circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Optional gate label.
|
||
|
||
**Returns**
|
||
|
||
a composite instruction encapsulating this circuit (can be decomposed back)
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
</Function>
|
||
|
||
### toffoli
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.toffoli" signature="toffoli(control_qubit1, control_qubit2, target_qubit)">
|
||
Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **control\_qubit1** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) used as the first control.
|
||
* **control\_qubit2** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) used as the second control.
|
||
* **target\_qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) targeted by the gate.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
|
||
<Admonition title="See also" type="note">
|
||
QuantumCircuit.ccx: the same gate with a different name.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### u
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.u" signature="u(theta, phi, lam, qubit)">
|
||
Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The $\theta$ rotation angle of the gate.
|
||
* **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The $\phi$ rotation angle of the gate.
|
||
* **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – The $\lambda$ rotation angle of the gate.
|
||
* **qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### uc
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.uc" signature="uc(gate_list, q_controls, q_target, up_to_diagonal=False)">
|
||
Attach a uniformly controlled gates (also called multiplexed gates) to a circuit.
|
||
|
||
The decomposition was introduced by Bergholm et al. in [https://arxiv.org/pdf/quant-ph/0410066.pdf](https://arxiv.org/pdf/quant-ph/0410066.pdf).
|
||
|
||
**Parameters**
|
||
|
||
* **gate\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[ndarray]*) – list of two qubit unitaries \[U\_0,…,U\_\{2^k-1}], where each single-qubit unitary U\_i is a given as a 2\*2 array
|
||
* **q\_controls** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*,*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*)]*) – list of k control qubits. The qubits are ordered according to their significance in the computational basis. For example if q\_controls=\[q\[1],q\[2]] (with q = QuantumRegister(2)), the unitary U\_0 is performed if q\[1] and q\[2] are in the state zero, U\_1 is performed if q\[2] is in the state zero and q\[1] is in the state one, and so on
|
||
* **q\_target** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*|(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*,*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*)*) – target qubit, where we act on with the single-qubit gates.
|
||
* **up\_to\_diagonal** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If set to True, the uniformly controlled gate is decomposed up to a diagonal gate, i.e. a unitary u’ is implemented such that there exists a diagonal gate d with u = d.dot(u’), where the unitary u describes the uniformly controlled gate
|
||
|
||
**Returns**
|
||
|
||
the uniformly controlled gate is attached to the circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type
|
||
</Function>
|
||
|
||
### ucrx
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ucrx" signature="ucrx(angle_list, q_controls, q_target)">
|
||
Attach a uniformly controlled (also called multiplexed) Rx rotation gate to a circuit.
|
||
|
||
The decomposition is base on [https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf) by Shende et al.
|
||
|
||
**Parameters**
|
||
|
||
* **angle\_list** (*List\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")*]*) – list of (real) rotation angles $[a_0,...,a_{2^k-1}]$
|
||
* **q\_controls** (*Sequence\[QubitSpecifier]*) – list of k control qubits (or empty list if no controls). The control qubits are ordered according to their significance in increasing order: For example if `q_controls=[q[0],q[1]]` (with `q = QuantumRegister(2)`), the rotation `Rx(a_0)` is performed if `q[0]` and `q[1]` are in the state zero, the rotation `Rx(a_1)` is performed if `q[0]` is in the state one and `q[1]` is in the state zero, and so on
|
||
* **q\_target** (*QubitSpecifier*) – target qubit, where we act on with the single-qubit rotation gates
|
||
|
||
**Returns**
|
||
|
||
the uniformly controlled rotation gate is attached to the circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type
|
||
</Function>
|
||
|
||
### ucry
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ucry" signature="ucry(angle_list, q_controls, q_target)">
|
||
Attach a uniformly controlled (also called multiplexed) Ry rotation gate to a circuit.
|
||
|
||
The decomposition is base on [https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf) by Shende et al.
|
||
|
||
**Parameters**
|
||
|
||
* **angle\_list** (*List\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")*]*) – list of (real) rotation angles $[a_0,...,a_{2^k-1}]$
|
||
* **q\_controls** (*Sequence\[QubitSpecifier]*) – list of k control qubits (or empty list if no controls). The control qubits are ordered according to their significance in increasing order: For example if `q_controls=[q[0],q[1]]` (with `q = QuantumRegister(2)`), the rotation `Ry(a_0)` is performed if `q[0]` and `q[1]` are in the state zero, the rotation `Ry(a_1)` is performed if `q[0]` is in the state one and `q[1]` is in the state zero, and so on
|
||
* **q\_target** (*QubitSpecifier*) – target qubit, where we act on with the single-qubit rotation gates
|
||
|
||
**Returns**
|
||
|
||
the uniformly controlled rotation gate is attached to the circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type
|
||
</Function>
|
||
|
||
### ucrz
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.ucrz" signature="ucrz(angle_list, q_controls, q_target)">
|
||
Attach a uniformly controlled (also called multiplexed gates) Rz rotation gate to a circuit.
|
||
|
||
The decomposition is base on [https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf) by Shende et al.
|
||
|
||
**Parameters**
|
||
|
||
* **angle\_list** (*List\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")*]*) – list of (real) rotation angles $[a_0,...,a_{2^k-1}]$
|
||
* **q\_controls** (*Sequence\[QubitSpecifier]*) – list of k control qubits (or empty list if no controls). The control qubits are ordered according to their significance in increasing order: For example if `q_controls=[q[0],q[1]]` (with `q = QuantumRegister(2)`), the rotation `Rx(a_0)` is performed if `q[0]` and `q[1]` are in the state zero, the rotation `Rx(a_1)` is performed if `q[0]` is in the state one and `q[1]` is in the state zero, and so on
|
||
* **q\_target** (*QubitSpecifier*) – target qubit, where we act on with the single-qubit rotation gates
|
||
|
||
**Returns**
|
||
|
||
the uniformly controlled rotation gate is attached to the circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type
|
||
</Function>
|
||
|
||
### unitary
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.unitary" signature="unitary(obj, qubits, label=None)">
|
||
Apply unitary gate specified by `obj` to `qubits`.
|
||
|
||
**Parameters**
|
||
|
||
* **obj** (*matrix or* [*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – unitary operator.
|
||
* **qubits** (*Union\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, Tuple\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – The circuit qubits to apply the transformation to.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – unitary name for backend \[Default: None].
|
||
|
||
**Returns**
|
||
|
||
The quantum circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**ExtensionError**](extensions#qiskit.extensions.ExtensionError "qiskit.extensions.ExtensionError") – if input data is not an N-qubit unitary operator.
|
||
|
||
**Example**
|
||
|
||
Apply a gate specified by a unitary matrix to a quantum circuit
|
||
|
||
```python
|
||
from qiskit import QuantumCircuit
|
||
matrix = [[0, 0, 0, 1],
|
||
[0, 0, 1, 0],
|
||
[1, 0, 0, 0],
|
||
[0, 1, 0, 0]]
|
||
circuit = QuantumCircuit(2)
|
||
circuit.unitary(matrix, [0, 1])
|
||
```
|
||
</Function>
|
||
|
||
### while\_loop
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.while_loop" signature="while_loop(condition: tuple[ClassicalRegister | Clbit, int] | expr.Expr, body: None, qubits: None, clbits: None, *, label: str | None) → qiskit.circuit.controlflow.while_loop.WhileLoopContext" extraSignatures={["while_loop(condition: tuple[ClassicalRegister | Clbit, int] | expr.Expr, body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet"]}>
|
||
Create a `while` loop on this circuit.
|
||
|
||
There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a `WhileLoopOp` with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a `WhileLoopOp` when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you.
|
||
|
||
Example usage:
|
||
|
||
```python
|
||
from qiskit.circuit import QuantumCircuit, Clbit, Qubit
|
||
bits = [Qubit(), Qubit(), Clbit()]
|
||
qc = QuantumCircuit(bits)
|
||
|
||
with qc.while_loop((bits[2], 0)):
|
||
qc.h(0)
|
||
qc.cx(0, 1)
|
||
qc.measure(0, 0)
|
||
```
|
||
|
||
**Parameters**
|
||
|
||
* **condition** (*Tuple\[Union\[*[*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*],* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – An equality condition to be checked prior to executing `body`. The left-hand side of the condition must be a [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or a [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit"), and the right-hand side must be an integer or boolean.
|
||
* **body** (*Optional\[*[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – The loop body to be repeatedly executed. Omit this to use the context-manager mode.
|
||
* **qubits** (*Optional\[Sequence\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]]*) – The circuit qubits over which the loop body should be run. Omit this to use the context-manager mode.
|
||
* **clbits** (*Optional\[Sequence\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]]*) – The circuit clbits over which the loop body should be run. Omit this to use the context-manager mode.
|
||
* **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]*) – The string label of the instruction in the circuit.
|
||
|
||
**Returns**
|
||
|
||
If used in context-manager mode, then this should be used as a `with` resource, which will infer the block content and operands on exit. If the full form is used, then this returns a handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet") or WhileLoopContext
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if an incorrect calling convention is used.
|
||
</Function>
|
||
|
||
### width
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.width" signature="width()">
|
||
Return number of qubits plus clbits in circuit.
|
||
|
||
**Returns**
|
||
|
||
Width of circuit.
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### x
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.x" signature="x(qubit, label=None)">
|
||
Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
* **qubit** (*QubitSpecifier*) – The qubit(s) to apply the gate to.
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The string label of the gate in the circuit.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
</Function>
|
||
|
||
### y
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.y" signature="y(qubit)">
|
||
Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
|
||
### z
|
||
|
||
<Function id="qiskit.circuit.QuantumCircuit.z" signature="z(qubit)">
|
||
Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate").
|
||
|
||
For the full matrix form of this gate, see the underlying gate documentation.
|
||
|
||
**Parameters**
|
||
|
||
**qubit** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.12)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.12)")*\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – The qubit(s) to apply the gate to.
|
||
|
||
**Returns**
|
||
|
||
A handle to the instructions created.
|
||
|
||
**Return type**
|
||
|
||
[*InstructionSet*](qiskit.circuit.InstructionSet "qiskit.circuit.instructionset.InstructionSet")
|
||
</Function>
|
||
</Class>
|
||
|