2459 lines
133 KiB
Plaintext
2459 lines
133 KiB
Plaintext
---
|
||
title: NLocal
|
||
description: API reference for qiskit.circuit.library.NLocal
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.circuit.library.NLocal
|
||
---
|
||
|
||
<span id="qiskit-circuit-library-nlocal" />
|
||
|
||
# qiskit.circuit.library.NLocal
|
||
|
||
<Class id="qiskit.circuit.library.NLocal" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/circuit/library/n_local/n_local.py" signature="NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')" modifiers="class">
|
||
The n-local circuit class.
|
||
|
||
The structure of the n-local circuit are alternating rotation and entanglement layers. In both layers, parameterized circuit-blocks act on the circuit in a defined way. In the rotation layer, the blocks are applied stacked on top of each other, while in the entanglement layer according to the `entanglement` strategy. The circuit blocks can have arbitrary sizes (smaller equal to the number of qubits in the circuit). Each layer is repeated `reps` times, and by default a final rotation layer is appended.
|
||
|
||
For instance, a rotation block on 2 qubits and an entanglement block on 4 qubits using `'linear'` entanglement yields the following circuit.
|
||
|
||
```python
|
||
┌──────┐ ░ ┌──────┐ ░ ┌──────┐
|
||
┤0 ├─░─┤0 ├──────────────── ... ─░─┤0 ├
|
||
│ Rot │ ░ │ │┌──────┐ ░ │ Rot │
|
||
┤1 ├─░─┤1 ├┤0 ├──────── ... ─░─┤1 ├
|
||
├──────┤ ░ │ Ent ││ │┌──────┐ ░ ├──────┤
|
||
┤0 ├─░─┤2 ├┤1 ├┤0 ├ ... ─░─┤0 ├
|
||
│ Rot │ ░ │ ││ Ent ││ │ ░ │ Rot │
|
||
┤1 ├─░─┤3 ├┤2 ├┤1 ├ ... ─░─┤1 ├
|
||
├──────┤ ░ └──────┘│ ││ Ent │ ░ ├──────┤
|
||
┤0 ├─░─────────┤3 ├┤2 ├ ... ─░─┤0 ├
|
||
│ Rot │ ░ └──────┘│ │ ░ │ Rot │
|
||
┤1 ├─░─────────────────┤3 ├ ... ─░─┤1 ├
|
||
└──────┘ ░ └──────┘ ░ └──────┘
|
||
|
||
| |
|
||
+---------------------------------+
|
||
repeated reps times
|
||
```
|
||
|
||
If specified, barriers can be inserted in between every block. If an initial state object of Qiskit Aqua is provided, it is added in front of the NLocal.
|
||
|
||
Create a new n-local circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_qubits** (`Optional`\[`int`]) – The number of qubits of the circuit.
|
||
* **rotation\_blocks** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `Instruction`, `List`\[`Instruction`], `None`]) – The blocks used in the rotation layers. If multiple are passed, these will be applied one after another (like new sub-layers).
|
||
* **entanglement\_blocks** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `Instruction`, `List`\[`Instruction`], `None`]) – The blocks used in the entanglement layers. If multiple are passed, these will be applied one after another. To use different enganglements for the sub-layers, see [`get_entangler_map()`](#qiskit.circuit.library.NLocal.get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map").
|
||
* **entanglement** (`Union`\[`List`\[`int`], `List`\[`List`\[`int`]], `None`]) – The indices specifying on which qubits the input blocks act. If None, the entanglement blocks are applied at the top of the circuit.
|
||
* **reps** (`int`) – Specifies how often the rotation blocks and entanglement blocks are repeated.
|
||
* **insert\_barriers** (`bool`) – If True, barriers are inserted in between each layer. If False, no barriers are inserted.
|
||
* **parameter\_prefix** (`str`) – The prefix used if default parameters are generated.
|
||
* **overwrite\_block\_parameters** (`Union`\[`bool`, `List`\[`List`\[`Parameter`]]]) – If the parameters in the added blocks should be overwritten. If False, the parameters in the blocks are not changed.
|
||
* **skip\_final\_rotation\_layer** (`bool`) – Whether a final rotation layer is added to the circuit.
|
||
* **skip\_unentangled\_qubits** (`bool`) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits.
|
||
* **initial\_state** (`Optional`\[`Any`]) – A qiskit.aqua.components.initial\_states.InitialState object which can be used to describe an initial state prepended to the NLocal circuit. This is primarily for compatibility with algorithms in Qiskit Aqua, which leverage this object to prepare input states.
|
||
* **name** (`Optional`\[`str`]) – The name of the circuit.
|
||
|
||
**Examples**
|
||
|
||
TODO
|
||
|
||
**Raises**
|
||
|
||
* **ImportError** – If an `initial_state` is specified but Qiskit Aqua is not installed.
|
||
* **TypeError** – If an `initial_state` is specified but not of the correct type, `qiskit.aqua.components.initial_states.InitialState`.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.__init__" signature="__init__(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')">
|
||
Create a new n-local circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_qubits** (`Optional`\[`int`]) – The number of qubits of the circuit.
|
||
* **rotation\_blocks** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `Instruction`, `List`\[`Instruction`], `None`]) – The blocks used in the rotation layers. If multiple are passed, these will be applied one after another (like new sub-layers).
|
||
* **entanglement\_blocks** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `Instruction`, `List`\[`Instruction`], `None`]) – The blocks used in the entanglement layers. If multiple are passed, these will be applied one after another. To use different enganglements for the sub-layers, see [`get_entangler_map()`](#qiskit.circuit.library.NLocal.get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map").
|
||
* **entanglement** (`Union`\[`List`\[`int`], `List`\[`List`\[`int`]], `None`]) – The indices specifying on which qubits the input blocks act. If None, the entanglement blocks are applied at the top of the circuit.
|
||
* **reps** (`int`) – Specifies how often the rotation blocks and entanglement blocks are repeated.
|
||
* **insert\_barriers** (`bool`) – If True, barriers are inserted in between each layer. If False, no barriers are inserted.
|
||
* **parameter\_prefix** (`str`) – The prefix used if default parameters are generated.
|
||
* **overwrite\_block\_parameters** (`Union`\[`bool`, `List`\[`List`\[`Parameter`]]]) – If the parameters in the added blocks should be overwritten. If False, the parameters in the blocks are not changed.
|
||
* **skip\_final\_rotation\_layer** (`bool`) – Whether a final rotation layer is added to the circuit.
|
||
* **skip\_unentangled\_qubits** (`bool`) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits.
|
||
* **initial\_state** (`Optional`\[`Any`]) – A qiskit.aqua.components.initial\_states.InitialState object which can be used to describe an initial state prepended to the NLocal circuit. This is primarily for compatibility with algorithms in Qiskit Aqua, which leverage this object to prepare input states.
|
||
* **name** (`Optional`\[`str`]) – The name of the circuit.
|
||
|
||
**Examples**
|
||
|
||
TODO
|
||
|
||
**Raises**
|
||
|
||
* **ImportError** – If an `initial_state` is specified but Qiskit Aqua is not installed.
|
||
* **TypeError** – If an `initial_state` is specified but not of the correct type, `qiskit.aqua.components.initial_states.InitialState`.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.circuit.library.NLocal.__init__ "qiskit.circuit.library.NLocal.__init__")(\[num\_qubits, rotation\_blocks, …]) | Create a new n-local circuit. |
|
||
| [`add_calibration`](#qiskit.circuit.library.NLocal.add_calibration "qiskit.circuit.library.NLocal.add_calibration")(gate, qubits, schedule\[, params]) | Register a low-level, custom pulse definition for the given gate. |
|
||
| [`add_layer`](#qiskit.circuit.library.NLocal.add_layer "qiskit.circuit.library.NLocal.add_layer")(other\[, entanglement, front]) | Append another layer to the NLocal. |
|
||
| [`add_register`](#qiskit.circuit.library.NLocal.add_register "qiskit.circuit.library.NLocal.add_register")(\*regs) | Add registers. |
|
||
| [`append`](#qiskit.circuit.library.NLocal.append "qiskit.circuit.library.NLocal.append")(instruction\[, qargs, cargs]) | Append one or more instructions to the end of the circuit, modifying the circuit in place. |
|
||
| [`assign_parameters`](#qiskit.circuit.library.NLocal.assign_parameters "qiskit.circuit.library.NLocal.assign_parameters")(param\_dict\[, inplace]) | Assign parameters to the n-local circuit. |
|
||
| [`barrier`](#qiskit.circuit.library.NLocal.barrier "qiskit.circuit.library.NLocal.barrier")(\*qargs) | Apply `Barrier`. |
|
||
| [`bind_parameters`](#qiskit.circuit.library.NLocal.bind_parameters "qiskit.circuit.library.NLocal.bind_parameters")(value\_dict) | Assign numeric parameters to values yielding a new circuit. |
|
||
| [`cast`](#qiskit.circuit.library.NLocal.cast "qiskit.circuit.library.NLocal.cast")(value, \_type) | Best effort to cast value to type. |
|
||
| [`cbit_argument_conversion`](#qiskit.circuit.library.NLocal.cbit_argument_conversion "qiskit.circuit.library.NLocal.cbit_argument_conversion")(clbit\_representation) | Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. |
|
||
| [`ccx`](#qiskit.circuit.library.NLocal.ccx "qiskit.circuit.library.NLocal.ccx")(control\_qubit1, control\_qubit2, target\_qubit) | Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). |
|
||
| [`ch`](#qiskit.circuit.library.NLocal.ch "qiskit.circuit.library.NLocal.ch")(control\_qubit, target\_qubit\[, label, …]) | Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). |
|
||
| [`cls_instances`](#qiskit.circuit.library.NLocal.cls_instances "qiskit.circuit.library.NLocal.cls_instances")() | Return the current number of instances of this class, useful for auto naming. |
|
||
| [`cls_prefix`](#qiskit.circuit.library.NLocal.cls_prefix "qiskit.circuit.library.NLocal.cls_prefix")() | Return the prefix to use for auto naming. |
|
||
| [`cnot`](#qiskit.circuit.library.NLocal.cnot "qiskit.circuit.library.NLocal.cnot")(control\_qubit, target\_qubit\[, label, …]) | Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). |
|
||
| [`combine`](#qiskit.circuit.library.NLocal.combine "qiskit.circuit.library.NLocal.combine")(rhs) | Append rhs to self if self contains compatible registers. |
|
||
| [`compose`](#qiskit.circuit.library.NLocal.compose "qiskit.circuit.library.NLocal.compose")(other\[, qubits, clbits, front, inplace]) | Compose circuit with `other` circuit or instruction, optionally permuting wires. |
|
||
| [`control`](#qiskit.circuit.library.NLocal.control "qiskit.circuit.library.NLocal.control")(\[num\_ctrl\_qubits, label, ctrl\_state]) | Control this circuit on `num_ctrl_qubits` qubits. |
|
||
| [`copy`](#qiskit.circuit.library.NLocal.copy "qiskit.circuit.library.NLocal.copy")(\[name]) | Copy the circuit. |
|
||
| [`count_ops`](#qiskit.circuit.library.NLocal.count_ops "qiskit.circuit.library.NLocal.count_ops")() | Count each operation kind in the circuit. |
|
||
| [`cp`](#qiskit.circuit.library.NLocal.cp "qiskit.circuit.library.NLocal.cp")(theta, control\_qubit, target\_qubit\[, …]) | Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). |
|
||
| [`crx`](#qiskit.circuit.library.NLocal.crx "qiskit.circuit.library.NLocal.crx")(theta, control\_qubit, target\_qubit\[, …]) | Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). |
|
||
| [`cry`](#qiskit.circuit.library.NLocal.cry "qiskit.circuit.library.NLocal.cry")(theta, control\_qubit, target\_qubit\[, …]) | Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). |
|
||
| [`crz`](#qiskit.circuit.library.NLocal.crz "qiskit.circuit.library.NLocal.crz")(theta, control\_qubit, target\_qubit\[, …]) | Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). |
|
||
| [`cswap`](#qiskit.circuit.library.NLocal.cswap "qiskit.circuit.library.NLocal.cswap")(control\_qubit, target\_qubit1, …\[, …]) | Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). |
|
||
| [`csx`](#qiskit.circuit.library.NLocal.csx "qiskit.circuit.library.NLocal.csx")(control\_qubit, target\_qubit\[, label, …]) | Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). |
|
||
| [`cu`](#qiskit.circuit.library.NLocal.cu "qiskit.circuit.library.NLocal.cu")(theta, phi, lam, gamma, control\_qubit, …) | Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). |
|
||
| [`cu1`](#qiskit.circuit.library.NLocal.cu1 "qiskit.circuit.library.NLocal.cu1")(theta, control\_qubit, target\_qubit\[, …]) | Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). |
|
||
| [`cu3`](#qiskit.circuit.library.NLocal.cu3 "qiskit.circuit.library.NLocal.cu3")(theta, phi, lam, control\_qubit, target\_qubit) | Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). |
|
||
| [`cx`](#qiskit.circuit.library.NLocal.cx "qiskit.circuit.library.NLocal.cx")(control\_qubit, target\_qubit\[, label, …]) | Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). |
|
||
| [`cy`](#qiskit.circuit.library.NLocal.cy "qiskit.circuit.library.NLocal.cy")(control\_qubit, target\_qubit\[, label, …]) | Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). |
|
||
| [`cz`](#qiskit.circuit.library.NLocal.cz "qiskit.circuit.library.NLocal.cz")(control\_qubit, target\_qubit\[, label, …]) | Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). |
|
||
| [`dcx`](#qiskit.circuit.library.NLocal.dcx "qiskit.circuit.library.NLocal.dcx")(qubit1, qubit2) | Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). |
|
||
| [`decompose`](#qiskit.circuit.library.NLocal.decompose "qiskit.circuit.library.NLocal.decompose")() | Call a decomposition pass on this circuit, to decompose one level (shallow decompose). |
|
||
| [`delay`](#qiskit.circuit.library.NLocal.delay "qiskit.circuit.library.NLocal.delay")(duration\[, qarg, unit]) | Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). |
|
||
| [`depth`](#qiskit.circuit.library.NLocal.depth "qiskit.circuit.library.NLocal.depth")() | Return circuit depth (i.e., length of critical path). |
|
||
| [`diag_gate`](#qiskit.circuit.library.NLocal.diag_gate "qiskit.circuit.library.NLocal.diag_gate")(diag, qubit) | Deprecated version of QuantumCircuit.diagonal. |
|
||
| [`diagonal`](#qiskit.circuit.library.NLocal.diagonal "qiskit.circuit.library.NLocal.diagonal")(diag, qubit) | Attach a diagonal gate to a circuit. |
|
||
| [`draw`](#qiskit.circuit.library.NLocal.draw "qiskit.circuit.library.NLocal.draw")(\[output, scale, filename, style, …]) | Draw the quantum circuit. |
|
||
| [`extend`](#qiskit.circuit.library.NLocal.extend "qiskit.circuit.library.NLocal.extend")(rhs) | Append QuantumCircuit to the right hand side if it contains compatible registers. |
|
||
| [`fredkin`](#qiskit.circuit.library.NLocal.fredkin "qiskit.circuit.library.NLocal.fredkin")(control\_qubit, target\_qubit1, …) | Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). |
|
||
| [`from_qasm_file`](#qiskit.circuit.library.NLocal.from_qasm_file "qiskit.circuit.library.NLocal.from_qasm_file")(path) | Take in a QASM file and generate a QuantumCircuit object. |
|
||
| [`from_qasm_str`](#qiskit.circuit.library.NLocal.from_qasm_str "qiskit.circuit.library.NLocal.from_qasm_str")(qasm\_str) | Take in a QASM string and generate a QuantumCircuit object. |
|
||
| [`get_entangler_map`](#qiskit.circuit.library.NLocal.get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map")(rep\_num, block\_num, …) | Get the entangler map for in the repetition `rep_num` and the block `block_num`. |
|
||
| [`get_unentangled_qubits`](#qiskit.circuit.library.NLocal.get_unentangled_qubits "qiskit.circuit.library.NLocal.get_unentangled_qubits")() | Get the indices of unentangled qubits in a set. |
|
||
| [`h`](#qiskit.circuit.library.NLocal.h "qiskit.circuit.library.NLocal.h")(qubit) | Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). |
|
||
| [`hamiltonian`](#qiskit.circuit.library.NLocal.hamiltonian "qiskit.circuit.library.NLocal.hamiltonian")(operator, time, qubits\[, label]) | Apply hamiltonian evolution to to qubits. |
|
||
| [`has_register`](#qiskit.circuit.library.NLocal.has_register "qiskit.circuit.library.NLocal.has_register")(register) | Test if this circuit has the register r. |
|
||
| [`i`](#qiskit.circuit.library.NLocal.i "qiskit.circuit.library.NLocal.i")(qubit) | Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). |
|
||
| [`id`](#qiskit.circuit.library.NLocal.id "qiskit.circuit.library.NLocal.id")(qubit) | Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). |
|
||
| [`initialize`](#qiskit.circuit.library.NLocal.initialize "qiskit.circuit.library.NLocal.initialize")(params, qubits) | Apply initialize to circuit. |
|
||
| [`inverse`](#qiskit.circuit.library.NLocal.inverse "qiskit.circuit.library.NLocal.inverse")() | Invert (take adjoint of) this circuit. |
|
||
| [`iso`](#qiskit.circuit.library.NLocal.iso "qiskit.circuit.library.NLocal.iso")(isometry, q\_input, q\_ancillas\_for\_output) | Attach an arbitrary isometry from m to n qubits to a circuit. |
|
||
| [`isometry`](#qiskit.circuit.library.NLocal.isometry "qiskit.circuit.library.NLocal.isometry")(isometry, q\_input, …\[, …]) | Attach an arbitrary isometry from m to n qubits to a circuit. |
|
||
| [`iswap`](#qiskit.circuit.library.NLocal.iswap "qiskit.circuit.library.NLocal.iswap")(qubit1, qubit2) | Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). |
|
||
| [`mcmt`](#qiskit.circuit.library.NLocal.mcmt "qiskit.circuit.library.NLocal.mcmt")(gate, control\_qubits, target\_qubits\[, …]) | Apply a multi-control, multi-target using a generic gate. |
|
||
| [`mcp`](#qiskit.circuit.library.NLocal.mcp "qiskit.circuit.library.NLocal.mcp")(lam, control\_qubits, target\_qubit) | Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). |
|
||
| [`mcrx`](#qiskit.circuit.library.NLocal.mcrx "qiskit.circuit.library.NLocal.mcrx")(theta, q\_controls, q\_target\[, …]) | Apply Multiple-Controlled X rotation gate |
|
||
| [`mcry`](#qiskit.circuit.library.NLocal.mcry "qiskit.circuit.library.NLocal.mcry")(theta, q\_controls, q\_target, q\_ancillae) | Apply Multiple-Controlled Y rotation gate |
|
||
| [`mcrz`](#qiskit.circuit.library.NLocal.mcrz "qiskit.circuit.library.NLocal.mcrz")(lam, q\_controls, q\_target\[, …]) | Apply Multiple-Controlled Z rotation gate |
|
||
| [`mct`](#qiskit.circuit.library.NLocal.mct "qiskit.circuit.library.NLocal.mct")(control\_qubits, target\_qubit\[, …]) | Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). |
|
||
| [`mcu1`](#qiskit.circuit.library.NLocal.mcu1 "qiskit.circuit.library.NLocal.mcu1")(lam, control\_qubits, target\_qubit) | Apply `MCU1Gate`. |
|
||
| [`mcx`](#qiskit.circuit.library.NLocal.mcx "qiskit.circuit.library.NLocal.mcx")(control\_qubits, target\_qubit\[, …]) | Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). |
|
||
| [`measure`](#qiskit.circuit.library.NLocal.measure "qiskit.circuit.library.NLocal.measure")(qubit, cbit) | Measure quantum bit into classical bit (tuples). |
|
||
| [`measure_active`](#qiskit.circuit.library.NLocal.measure_active "qiskit.circuit.library.NLocal.measure_active")(\[inplace]) | Adds measurement to all non-idle qubits. |
|
||
| [`measure_all`](#qiskit.circuit.library.NLocal.measure_all "qiskit.circuit.library.NLocal.measure_all")(\[inplace]) | Adds measurement to all qubits. |
|
||
| [`mirror`](#qiskit.circuit.library.NLocal.mirror "qiskit.circuit.library.NLocal.mirror")() | DEPRECATED: use circuit.reverse\_ops(). |
|
||
| [`ms`](#qiskit.circuit.library.NLocal.ms "qiskit.circuit.library.NLocal.ms")(theta, qubits) | Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). |
|
||
| [`num_connected_components`](#qiskit.circuit.library.NLocal.num_connected_components "qiskit.circuit.library.NLocal.num_connected_components")(\[unitary\_only]) | How many non-entangled subcircuits can the circuit be factored to. |
|
||
| [`num_nonlocal_gates`](#qiskit.circuit.library.NLocal.num_nonlocal_gates "qiskit.circuit.library.NLocal.num_nonlocal_gates")() | Return number of non-local gates (i.e. |
|
||
| [`num_tensor_factors`](#qiskit.circuit.library.NLocal.num_tensor_factors "qiskit.circuit.library.NLocal.num_tensor_factors")() | Computes the number of tensor factors in the unitary (quantum) part of the circuit only. |
|
||
| [`num_unitary_factors`](#qiskit.circuit.library.NLocal.num_unitary_factors "qiskit.circuit.library.NLocal.num_unitary_factors")() | Computes the number of tensor factors in the unitary (quantum) part of the circuit only. |
|
||
| [`p`](#qiskit.circuit.library.NLocal.p "qiskit.circuit.library.NLocal.p")(theta, qubit) | Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). |
|
||
| [`power`](#qiskit.circuit.library.NLocal.power "qiskit.circuit.library.NLocal.power")(power\[, matrix\_power]) | Raise this circuit to the power of `power`. |
|
||
| [`print_settings`](#qiskit.circuit.library.NLocal.print_settings "qiskit.circuit.library.NLocal.print_settings")() | Returns information about the setting. |
|
||
| [`qasm`](#qiskit.circuit.library.NLocal.qasm "qiskit.circuit.library.NLocal.qasm")(\[formatted, filename]) | Return OpenQASM string. |
|
||
| [`qbit_argument_conversion`](#qiskit.circuit.library.NLocal.qbit_argument_conversion "qiskit.circuit.library.NLocal.qbit_argument_conversion")(qubit\_representation) | Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. |
|
||
| [`qubit_duration`](#qiskit.circuit.library.NLocal.qubit_duration "qiskit.circuit.library.NLocal.qubit_duration")(\*qubits) | Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. |
|
||
| [`qubit_start_time`](#qiskit.circuit.library.NLocal.qubit_start_time "qiskit.circuit.library.NLocal.qubit_start_time")(\*qubits) | Return the start time of the first instruction, excluding delays, over the supplied qubits. |
|
||
| [`qubit_stop_time`](#qiskit.circuit.library.NLocal.qubit_stop_time "qiskit.circuit.library.NLocal.qubit_stop_time")(\*qubits) | Return the stop time of the last instruction, excluding delays, over the supplied qubits. |
|
||
| [`r`](#qiskit.circuit.library.NLocal.r "qiskit.circuit.library.NLocal.r")(theta, phi, qubit) | Apply `RGate`. |
|
||
| [`rcccx`](#qiskit.circuit.library.NLocal.rcccx "qiskit.circuit.library.NLocal.rcccx")(control\_qubit1, control\_qubit2, …) | Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). |
|
||
| [`rccx`](#qiskit.circuit.library.NLocal.rccx "qiskit.circuit.library.NLocal.rccx")(control\_qubit1, control\_qubit2, …) | Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). |
|
||
| [`remove_final_measurements`](#qiskit.circuit.library.NLocal.remove_final_measurements "qiskit.circuit.library.NLocal.remove_final_measurements")(\[inplace]) | Removes final measurement on all qubits if they are present. |
|
||
| [`repeat`](#qiskit.circuit.library.NLocal.repeat "qiskit.circuit.library.NLocal.repeat")(reps) | Repeat this circuit `reps` times. |
|
||
| [`reset`](#qiskit.circuit.library.NLocal.reset "qiskit.circuit.library.NLocal.reset")(qubit) | Reset q. |
|
||
| [`reverse_bits`](#qiskit.circuit.library.NLocal.reverse_bits "qiskit.circuit.library.NLocal.reverse_bits")() | Return a circuit with the opposite order of wires. |
|
||
| [`reverse_ops`](#qiskit.circuit.library.NLocal.reverse_ops "qiskit.circuit.library.NLocal.reverse_ops")() | Reverse the circuit by reversing the order of instructions. |
|
||
| [`rx`](#qiskit.circuit.library.NLocal.rx "qiskit.circuit.library.NLocal.rx")(theta, qubit\[, label]) | Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). |
|
||
| [`rxx`](#qiskit.circuit.library.NLocal.rxx "qiskit.circuit.library.NLocal.rxx")(theta, qubit1, qubit2) | Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). |
|
||
| [`ry`](#qiskit.circuit.library.NLocal.ry "qiskit.circuit.library.NLocal.ry")(theta, qubit\[, label]) | Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). |
|
||
| [`ryy`](#qiskit.circuit.library.NLocal.ryy "qiskit.circuit.library.NLocal.ryy")(theta, qubit1, qubit2) | Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). |
|
||
| [`rz`](#qiskit.circuit.library.NLocal.rz "qiskit.circuit.library.NLocal.rz")(phi, qubit) | Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). |
|
||
| [`rzx`](#qiskit.circuit.library.NLocal.rzx "qiskit.circuit.library.NLocal.rzx")(theta, qubit1, qubit2) | Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). |
|
||
| [`rzz`](#qiskit.circuit.library.NLocal.rzz "qiskit.circuit.library.NLocal.rzz")(theta, qubit1, qubit2) | Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). |
|
||
| [`s`](#qiskit.circuit.library.NLocal.s "qiskit.circuit.library.NLocal.s")(qubit) | Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). |
|
||
| [`sdg`](#qiskit.circuit.library.NLocal.sdg "qiskit.circuit.library.NLocal.sdg")(qubit) | Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). |
|
||
| [`size`](#qiskit.circuit.library.NLocal.size "qiskit.circuit.library.NLocal.size")() | Returns total number of gate operations in circuit. |
|
||
| [`snapshot`](#qiskit.circuit.library.NLocal.snapshot "qiskit.circuit.library.NLocal.snapshot")(label\[, snapshot\_type, qubits, params]) | Take a statevector snapshot of the internal simulator representation. |
|
||
| [`snapshot_density_matrix`](#qiskit.circuit.library.NLocal.snapshot_density_matrix "qiskit.circuit.library.NLocal.snapshot_density_matrix")(label\[, qubits]) | Take a density matrix snapshot of simulator state. |
|
||
| [`snapshot_expectation_value`](#qiskit.circuit.library.NLocal.snapshot_expectation_value "qiskit.circuit.library.NLocal.snapshot_expectation_value")(label, op, qubits) | Take a snapshot of expectation value \<O> of an Operator. |
|
||
| [`snapshot_probabilities`](#qiskit.circuit.library.NLocal.snapshot_probabilities "qiskit.circuit.library.NLocal.snapshot_probabilities")(label, qubits\[, variance]) | Take a probability snapshot of the simulator state. |
|
||
| [`snapshot_stabilizer`](#qiskit.circuit.library.NLocal.snapshot_stabilizer "qiskit.circuit.library.NLocal.snapshot_stabilizer")(label) | Take a stabilizer snapshot of the simulator state. |
|
||
| [`snapshot_statevector`](#qiskit.circuit.library.NLocal.snapshot_statevector "qiskit.circuit.library.NLocal.snapshot_statevector")(label) | Take a statevector snapshot of the simulator state. |
|
||
| [`squ`](#qiskit.circuit.library.NLocal.squ "qiskit.circuit.library.NLocal.squ")(unitary\_matrix, qubit\[, mode, …]) | Decompose an arbitrary 2\*2 unitary into three rotation gates. |
|
||
| [`swap`](#qiskit.circuit.library.NLocal.swap "qiskit.circuit.library.NLocal.swap")(qubit1, qubit2) | Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). |
|
||
| [`sx`](#qiskit.circuit.library.NLocal.sx "qiskit.circuit.library.NLocal.sx")(qubit) | Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). |
|
||
| [`sxdg`](#qiskit.circuit.library.NLocal.sxdg "qiskit.circuit.library.NLocal.sxdg")(qubit) | Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). |
|
||
| [`t`](#qiskit.circuit.library.NLocal.t "qiskit.circuit.library.NLocal.t")(qubit) | Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). |
|
||
| [`tdg`](#qiskit.circuit.library.NLocal.tdg "qiskit.circuit.library.NLocal.tdg")(qubit) | Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). |
|
||
| [`to_gate`](#qiskit.circuit.library.NLocal.to_gate "qiskit.circuit.library.NLocal.to_gate")(\[parameter\_map, label]) | Create a Gate out of this circuit. |
|
||
| [`to_instruction`](#qiskit.circuit.library.NLocal.to_instruction "qiskit.circuit.library.NLocal.to_instruction")(\[parameter\_map]) | Create an Instruction out of this circuit. |
|
||
| [`toffoli`](#qiskit.circuit.library.NLocal.toffoli "qiskit.circuit.library.NLocal.toffoli")(control\_qubit1, control\_qubit2, …) | Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). |
|
||
| [`u`](#qiskit.circuit.library.NLocal.u "qiskit.circuit.library.NLocal.u")(theta, phi, lam, qubit) | Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). |
|
||
| [`u1`](#qiskit.circuit.library.NLocal.u1 "qiskit.circuit.library.NLocal.u1")(theta, qubit) | Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). |
|
||
| [`u2`](#qiskit.circuit.library.NLocal.u2 "qiskit.circuit.library.NLocal.u2")(phi, lam, qubit) | Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). |
|
||
| [`u3`](#qiskit.circuit.library.NLocal.u3 "qiskit.circuit.library.NLocal.u3")(theta, phi, lam, qubit) | Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). |
|
||
| [`uc`](#qiskit.circuit.library.NLocal.uc "qiskit.circuit.library.NLocal.uc")(gate\_list, q\_controls, q\_target\[, …]) | Attach a uniformly controlled gates (also called multiplexed gates) to a circuit. |
|
||
| [`ucrx`](#qiskit.circuit.library.NLocal.ucrx "qiskit.circuit.library.NLocal.ucrx")(angle\_list, q\_controls, q\_target) | Attach a uniformly controlled (also called multiplexed) Rx rotation gate to a circuit. |
|
||
| [`ucry`](#qiskit.circuit.library.NLocal.ucry "qiskit.circuit.library.NLocal.ucry")(angle\_list, q\_controls, q\_target) | Attach a uniformly controlled (also called multiplexed) Ry rotation gate to a circuit. |
|
||
| [`ucrz`](#qiskit.circuit.library.NLocal.ucrz "qiskit.circuit.library.NLocal.ucrz")(angle\_list, q\_controls, q\_target) | Attach a uniformly controlled (also called multiplexed gates) Rz rotation gate to a circuit. |
|
||
| [`unitary`](#qiskit.circuit.library.NLocal.unitary "qiskit.circuit.library.NLocal.unitary")(obj, qubits\[, label]) | Apply unitary gate to q. |
|
||
| [`width`](#qiskit.circuit.library.NLocal.width "qiskit.circuit.library.NLocal.width")() | Return number of qubits plus clbits in circuit. |
|
||
| [`x`](#qiskit.circuit.library.NLocal.x "qiskit.circuit.library.NLocal.x")(qubit\[, label]) | Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). |
|
||
| [`y`](#qiskit.circuit.library.NLocal.y "qiskit.circuit.library.NLocal.y")(qubit) | Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). |
|
||
| [`z`](#qiskit.circuit.library.NLocal.z "qiskit.circuit.library.NLocal.z")(qubit) | Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||
| [`ancillas`](#qiskit.circuit.library.NLocal.ancillas "qiskit.circuit.library.NLocal.ancillas") | Returns a list of ancilla bits in the order that the registers were added. |
|
||
| [`calibrations`](#qiskit.circuit.library.NLocal.calibrations "qiskit.circuit.library.NLocal.calibrations") | Return calibration dictionary. |
|
||
| [`clbits`](#qiskit.circuit.library.NLocal.clbits "qiskit.circuit.library.NLocal.clbits") | Returns a list of classical bits in the order that the registers were added. |
|
||
| [`data`](#qiskit.circuit.library.NLocal.data "qiskit.circuit.library.NLocal.data") | Return the circuit data (instructions and context). |
|
||
| [`entanglement`](#qiskit.circuit.library.NLocal.entanglement "qiskit.circuit.library.NLocal.entanglement") | Get the entanglement strategy. |
|
||
| [`entanglement_blocks`](#qiskit.circuit.library.NLocal.entanglement_blocks "qiskit.circuit.library.NLocal.entanglement_blocks") | The blocks in the entanglement layers. |
|
||
| `extension_lib` | |
|
||
| [`global_phase`](#qiskit.circuit.library.NLocal.global_phase "qiskit.circuit.library.NLocal.global_phase") | Return the global phase of the circuit in radians. |
|
||
| `header` | |
|
||
| [`initial_state`](#qiskit.circuit.library.NLocal.initial_state "qiskit.circuit.library.NLocal.initial_state") | Return the initial state that is added in front of the n-local circuit. |
|
||
| [`insert_barriers`](#qiskit.circuit.library.NLocal.insert_barriers "qiskit.circuit.library.NLocal.insert_barriers") | If barriers are inserted in between the layers or not. |
|
||
| `instances` | |
|
||
| [`num_ancillas`](#qiskit.circuit.library.NLocal.num_ancillas "qiskit.circuit.library.NLocal.num_ancillas") | Return the number of ancilla qubits. |
|
||
| [`num_clbits`](#qiskit.circuit.library.NLocal.num_clbits "qiskit.circuit.library.NLocal.num_clbits") | Return number of classical bits. |
|
||
| [`num_layers`](#qiskit.circuit.library.NLocal.num_layers "qiskit.circuit.library.NLocal.num_layers") | Return the number of layers in the n-local circuit. |
|
||
| [`num_parameters`](#qiskit.circuit.library.NLocal.num_parameters "qiskit.circuit.library.NLocal.num_parameters") | Convenience function to get the number of parameter objects in the circuit. |
|
||
| [`num_parameters_settable`](#qiskit.circuit.library.NLocal.num_parameters_settable "qiskit.circuit.library.NLocal.num_parameters_settable") | The number of total parameters that can be set to distinct values. |
|
||
| [`num_qubits`](#qiskit.circuit.library.NLocal.num_qubits "qiskit.circuit.library.NLocal.num_qubits") | Returns the number of qubits in this circuit. |
|
||
| [`ordered_parameters`](#qiskit.circuit.library.NLocal.ordered_parameters "qiskit.circuit.library.NLocal.ordered_parameters") | The parameters used in the underlying circuit. |
|
||
| [`parameter_bounds`](#qiskit.circuit.library.NLocal.parameter_bounds "qiskit.circuit.library.NLocal.parameter_bounds") | The parameter bounds for the unbound parameters in the circuit. |
|
||
| [`parameters`](#qiskit.circuit.library.NLocal.parameters "qiskit.circuit.library.NLocal.parameters") | Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. |
|
||
| [`preferred_init_points`](#qiskit.circuit.library.NLocal.preferred_init_points "qiskit.circuit.library.NLocal.preferred_init_points") | The initial points for the parameters. |
|
||
| `prefix` | |
|
||
| [`qregs`](#qiskit.circuit.library.NLocal.qregs "qiskit.circuit.library.NLocal.qregs") | A list of the quantum registers associated with the circuit. |
|
||
| [`qubits`](#qiskit.circuit.library.NLocal.qubits "qiskit.circuit.library.NLocal.qubits") | Returns a list of quantum bits in the order that the registers were added. |
|
||
| [`reps`](#qiskit.circuit.library.NLocal.reps "qiskit.circuit.library.NLocal.reps") | The number of times rotation and entanglement block are repeated. |
|
||
| [`rotation_blocks`](#qiskit.circuit.library.NLocal.rotation_blocks "qiskit.circuit.library.NLocal.rotation_blocks") | The blocks in the rotation layers. |
|
||
|
||
### add\_calibration
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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]*) – Gate information.
|
||
* **qubits** (*Union\[int, Tuple\[int]]*) – List of qubits to be measured.
|
||
* **schedule** ([*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")) – Schedule information.
|
||
* **params** (*Optional\[List\[Union\[float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]]]*) – A list of parameters.
|
||
|
||
**Raises**
|
||
|
||
**Exception** – if the gate is of type string and params is None.
|
||
</Function>
|
||
|
||
### add\_layer
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.add_layer" signature="add_layer(other, entanglement=None, front=False)">
|
||
Append another layer to the NLocal.
|
||
|
||
**Parameters**
|
||
|
||
* **other** (`Union`\[`NLocal`, `Instruction`, `QuantumCircuit`]) – The layer to compose, can be another NLocal, an Instruction or Gate, or a QuantumCircuit.
|
||
* **entanglement** (`Union`\[`List`\[`int`], `str`, `List`\[`List`\[`int`]], `None`]) – The entanglement or qubit indices.
|
||
* **front** (`bool`) – If True, `other` is appended to the front, else to the back.
|
||
|
||
**Return type**
|
||
|
||
`NLocal`
|
||
|
||
**Returns**
|
||
|
||
self, such that chained composes are possible.
|
||
|
||
**Raises**
|
||
|
||
**TypeError** – If other is not compatible, i.e. is no Instruction and does not have a to\_instruction method.
|
||
</Function>
|
||
|
||
### add\_register
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.add_register" signature="add_register(*regs)">
|
||
Add registers.
|
||
</Function>
|
||
|
||
### ancillas
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.ancillas">
|
||
Returns a list of ancilla bits in the order that the registers were added.
|
||
</Attribute>
|
||
|
||
### append
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.append" signature="append(instruction, qargs=None, cargs=None)">
|
||
Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs.
|
||
|
||
**Parameters**
|
||
|
||
* **instruction** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – Instruction instance to append
|
||
* **qargs** (*list(argument)*) – qubits to attach instruction to
|
||
* **cargs** (*list(argument)*) – clbits to attach instruction to
|
||
|
||
**Returns**
|
||
|
||
a handle to the instruction that was just added
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
|
||
**Raises**
|
||
|
||
* **CircuitError** – if object passed is a subclass of Instruction
|
||
* **CircuitError** – if object passed is neither subclass nor an instance of Instruction
|
||
</Function>
|
||
|
||
### assign\_parameters
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.assign_parameters" signature="assign_parameters(param_dict, inplace=False)">
|
||
Assign parameters to the n-local circuit.
|
||
|
||
This method also supports passing a list instead of a dictionary. If a list is passed, the list must have the same length as the number of unbound parameters in the circuit. The parameters are assigned in the order of the parameters in [`ordered_parameters()`](#qiskit.circuit.library.NLocal.ordered_parameters "qiskit.circuit.library.NLocal.ordered_parameters").
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`QuantumCircuit`]
|
||
|
||
**Returns**
|
||
|
||
A copy of the NLocal circuit with the specified parameters.
|
||
|
||
**Raises**
|
||
|
||
**AttributeError** – If the parameters are given as list and do not match the number of parameters.
|
||
</Function>
|
||
|
||
### barrier
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.barrier" signature="barrier(*qargs)">
|
||
Apply `Barrier`. If qargs is None, applies to all.
|
||
</Function>
|
||
|
||
### bind\_parameters
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.bind_parameters" signature="bind_parameters(value_dict)">
|
||
Assign numeric parameters to values yielding a new circuit.
|
||
|
||
To assign new Parameter objects or bind the values in-place, without yielding a new circuit, use the [`assign_parameters()`](#qiskit.circuit.library.NLocal.assign_parameters "qiskit.circuit.library.NLocal.assign_parameters") method.
|
||
|
||
**Parameters**
|
||
|
||
**value\_dict** (*dict*) – \{parameter: value, …}
|
||
|
||
**Raises**
|
||
|
||
* **CircuitError** – If value\_dict contains parameters not present in the circuit
|
||
* **TypeError** – If value\_dict contains a ParameterExpression in the values.
|
||
|
||
**Returns**
|
||
|
||
copy of self with assignment substitution.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### calibrations
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.calibrations">
|
||
Return calibration dictionary.
|
||
|
||
**The custom pulse definition of a given gate is of the form**
|
||
|
||
\{‘gate\_name’: \{(qubits, params): schedule}}
|
||
</Attribute>
|
||
|
||
### cast
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cast" signature="cast(value, _type)" modifiers="static">
|
||
Best effort to cast value to type. Otherwise, returns the value.
|
||
</Function>
|
||
|
||
### cbit\_argument\_conversion
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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)
|
||
</Function>
|
||
|
||
### ccx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.ccx" signature="ccx(control_qubit1, control_qubit2, target_qubit)">
|
||
Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate").
|
||
</Function>
|
||
|
||
### ch
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.ch" signature="ch(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate").
|
||
</Function>
|
||
|
||
### clbits
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.clbits">
|
||
Returns a list of classical bits in the order that the registers were added.
|
||
</Attribute>
|
||
|
||
### cls\_instances
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cls_instances" signature="cls_instances()" modifiers="classmethod">
|
||
Return the current number of instances of this class, useful for auto naming.
|
||
</Function>
|
||
|
||
### cls\_prefix
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cls_prefix" signature="cls_prefix()" modifiers="classmethod">
|
||
Return the prefix to use for auto naming.
|
||
</Function>
|
||
|
||
### cnot
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cnot" signature="cnot(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate").
|
||
</Function>
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.combine" signature="combine(rhs)">
|
||
Append rhs to self if self contains compatible registers.
|
||
|
||
Two circuits are compatible if they contain the same registers or if they contain different registers with unique names. The returned circuit will contain all unique registers between both circuits.
|
||
|
||
Return self + rhs as a new object.
|
||
|
||
**Parameters**
|
||
|
||
**rhs** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The quantum circuit to append to the right hand side.
|
||
|
||
**Returns**
|
||
|
||
Returns a new QuantumCircuit object
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**QiskitError** – if the rhs circuit is not compatible
|
||
</Function>
|
||
|
||
### compose
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.compose" signature="compose(other, qubits=None, clbits=None, front=False, inplace=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") *or BaseOperator*) – (sub)circuit to compose onto self.
|
||
* **qubits** (*list\[Qubit|int]*) – qubits of self to compose onto.
|
||
* **clbits** (*list\[Clbit|int]*) – clbits of self to compose onto.
|
||
* **front** (*bool*) – If True, front composition will be performed (not implemented yet).
|
||
* **inplace** (*bool*) – If True, modify the object. Otherwise return composed circuit.
|
||
|
||
**Returns**
|
||
|
||
the composed circuit (returns None if inplace==True).
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
* **CircuitError** – if composing on the front.
|
||
* **QiskitError** – if `other` is wider or there are duplicate edge mappings.
|
||
|
||
**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>
|
||
|
||
### control
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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*) – The number of control qubits.
|
||
* **label** (*str*) – An optional label to give the controlled operation for visualization.
|
||
* **ctrl\_state** (*str or int*) – 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** – If the circuit contains a non-unitary operation and cannot be controlled.
|
||
</Function>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.copy" signature="copy(name=None)">
|
||
Copy the circuit.
|
||
|
||
**Parameters**
|
||
|
||
**name** (*str*) – 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>
|
||
|
||
### count\_ops
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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.library.NLocal.cp" signature="cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate").
|
||
</Function>
|
||
|
||
### crx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.crx" signature="crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate").
|
||
</Function>
|
||
|
||
### cry
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cry" signature="cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate").
|
||
</Function>
|
||
|
||
### crz
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.crz" signature="crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate").
|
||
</Function>
|
||
|
||
### cswap
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cswap" signature="cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)">
|
||
Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate").
|
||
</Function>
|
||
|
||
### csx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.csx" signature="csx(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate").
|
||
</Function>
|
||
|
||
### cu
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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").
|
||
</Function>
|
||
|
||
### cu1
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cu1" signature="cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate").
|
||
</Function>
|
||
|
||
### cu3
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cu3" signature="cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate").
|
||
</Function>
|
||
|
||
### cx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cx" signature="cx(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate").
|
||
</Function>
|
||
|
||
### cy
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cy" signature="cy(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate").
|
||
</Function>
|
||
|
||
### cz
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.cz" signature="cz(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||
Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate").
|
||
</Function>
|
||
|
||
### data
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.data">
|
||
Return the circuit data (instructions and context).
|
||
|
||
**Returns**
|
||
|
||
a list-like object containing the tuples for the circuit’s data.
|
||
|
||
Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is an Instruction (or subclass) object, qargs is a list of Qubit objects, and cargs is a list of Clbit objects.
|
||
|
||
**Return type**
|
||
|
||
QuantumCircuitData
|
||
</Attribute>
|
||
|
||
### dcx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.dcx" signature="dcx(qubit1, qubit2)">
|
||
Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate").
|
||
</Function>
|
||
|
||
### decompose
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.decompose" signature="decompose()">
|
||
Call a decomposition pass on this circuit, to decompose one level (shallow decompose).
|
||
|
||
**Returns**
|
||
|
||
a circuit one level decomposed
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### delay
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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 or float*) – duration of the delay.
|
||
* **qarg** (*Object*) – qubit argument to apply this delay.
|
||
* **unit** (*str*) – unit of the duration. Supported units: ‘s’, ‘ms’, ‘us’, ‘ns’, ‘ps’, ‘dt’. Default is `dt`, i.e. integer time unit depending on the target backend.
|
||
|
||
**Returns**
|
||
|
||
the attached delay instruction.
|
||
|
||
**Return type**
|
||
|
||
qiskit.Instruction
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – if arguments have bad format.
|
||
</Function>
|
||
|
||
### depth
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.depth" signature="depth()">
|
||
Return circuit depth (i.e., length of critical path). This does not include compiler or simulator directives such as ‘barrier’ or ‘snapshot’.
|
||
|
||
**Returns**
|
||
|
||
Depth of circuit.
|
||
|
||
**Return type**
|
||
|
||
int
|
||
|
||
**Notes**
|
||
|
||
The circuit depth and the DAG depth need not be the same.
|
||
</Function>
|
||
|
||
### diag\_gate
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.diag_gate" signature="diag_gate(diag, qubit)">
|
||
Deprecated version of QuantumCircuit.diagonal.
|
||
</Function>
|
||
|
||
### diagonal
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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*) – list of the 2^k diagonal entries (for a diagonal gate on k qubits). Must contain at least two entries
|
||
* **qubit** (*QuantumRegister|list*) – 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** – 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.library.NLocal.draw" signature="draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=False, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=True)">
|
||
Draw the quantum circuit.
|
||
|
||
**text**: ASCII art TextDrawing that can be printed in the console.
|
||
|
||
**latex**: high-quality images compiled via LaTeX.
|
||
|
||
**latex\_source**: raw uncompiled LaTeX output.
|
||
|
||
**matplotlib**: images with color rendered purely in Python.
|
||
|
||
**Parameters**
|
||
|
||
* **output** (*str*) – Select the output method to use for drawing the circuit. Valid choices are `text`, `latex`, `latex_source`, or `mpl`. By default the ‘text’ drawer is used unless a user config file has an alternative backend set as the default. If the output kwarg is set, that backend will always be used over the default in a user config file.
|
||
* **scale** (*float*) – scale of image to draw (shrink if \< 1)
|
||
* **filename** (*str*) – file path to save image to
|
||
* **style** (*dict or str*) – dictionary of style or file name of style file. This option is only used by the `mpl` output type. If a str is passed in that is the path to a json file which contains a dictionary of style, then that will be opened, parsed, and used as the input dict. See: [Style Dict Doc](qiskit.circuit.library.ZZFeatureMap#style-dict-circ-doc) for more information on the contents.
|
||
* **interactive** (*bool*) – when set 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.
|
||
* **reverse\_bits** (*bool*) – When set to True, reverse the bit order inside registers for the output visualization.
|
||
* **plot\_barriers** (*bool*) – 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*) – Include idle wires (wires with no circuit elements) in output visualization. Default is True.
|
||
* **with\_layout** (*bool*) – Include layout information, with labels on the physical layout. Default is True.
|
||
* **fold** (*int*) – 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` is the number of (visual) layers before folding. Default is 25.
|
||
* **ax** (*matplotlib.axes.Axes*) – 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. This is only used when the `output` kwarg is set to use the `mpl` backend. It will be silently ignored with all other outputs.
|
||
* **initial\_state** (*bool*) – Optional. Adds `|0>` in the beginning of the wire. Only used by the `text`, `latex` and `latex_source` outputs. Default: `False`.
|
||
* **cregbundle** (*bool*) – Optional. If set True bundle classical registers. Not used by the `matplotlib` output. Default: `True`.
|
||
|
||
**Returns**
|
||
|
||
`PIL.Image` or `matplotlib.figure` or `str` or `TextDrawing`:
|
||
|
||
* **PIL.Image (output=’latex’)**
|
||
|
||
an in-memory representation of the image of the circuit diagram.
|
||
|
||
* **matplotlib.figure.Figure (output=’mpl’)**
|
||
|
||
a matplotlib figure object for the circuit diagram.
|
||
|
||
* **str (output=’latex\_source’)**
|
||
|
||
The LaTeX source code for visualizing the circuit diagram.
|
||
|
||
* **TextDrawing (output=’text’)**
|
||
|
||
A drawing that can be printed as ASCII art.
|
||
|
||
**Raises**
|
||
|
||
* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when an invalid output method is selected
|
||
* **ImportError** – when the output methods require non-installed libraries
|
||
|
||
**Style Dict Details**
|
||
|
||
The style dict kwarg contains numerous options that define the style of the output circuit visualization. The style dict is only used by the `mpl` output. The options available in the style dict are defined below:
|
||
|
||
**Parameters**
|
||
|
||
* **name** (*str*) – The name of the style. The name can be set to ‘iqx’, ‘bw’, or ‘default’. This overrides the setting in the ‘\~/.qiskit/settings.conf’ file.
|
||
|
||
* **textcolor** (*str*) – The color code to use for text. Defaults to ‘#000000’
|
||
|
||
* **subtextcolor** (*str*) – The color code to use for subtext. Defaults to ‘#000000’
|
||
|
||
* **linecolor** (*str*) – The color code to use for lines. Defaults to ‘#000000’
|
||
|
||
* **creglinecolor** (*str*) – The color code to use for classical register lines. Defaults to ‘#778899’
|
||
|
||
* **gatetextcolor** (*str*) – The color code to use for gate text. Defaults to ‘#000000’
|
||
|
||
* **gatefacecolor** (*str*) – The color code to use for gates. Defaults to ‘#ffffff’
|
||
|
||
* **barrierfacecolor** (*str*) – The color code to use for barriers. Defaults to ‘#bdbdbd’
|
||
|
||
* **backgroundcolor** (*str*) – The color code to use for the background. Defaults to ‘#ffffff’
|
||
|
||
* **fontsize** (*int*) – The font size to use for text. Defaults to 13.
|
||
|
||
* **subfontsize** (*int*) – The font size to use for subtext. Defaults to 8.
|
||
|
||
* **displaytext** (*dict*) –
|
||
|
||
A dictionary of the text to use for each element type in the output visualization. The default values are:
|
||
|
||
```python
|
||
{
|
||
'id': 'id',
|
||
'u0': 'U_0',
|
||
'u1': 'U_1',
|
||
'u2': 'U_2',
|
||
'u3': 'U_3',
|
||
'x': 'X',
|
||
'y': 'Y',
|
||
'z': 'Z',
|
||
'h': 'H',
|
||
's': 'S',
|
||
'sdg': 'S^\dagger',
|
||
't': 'T',
|
||
'tdg': 'T^\dagger',
|
||
'rx': 'R_x',
|
||
'ry': 'R_y',
|
||
'rz': 'R_z',
|
||
'reset': '\left|0\right\rangle'
|
||
}
|
||
```
|
||
|
||
You must specify all the necessary values if using this. There is no provision for passing an incomplete dict in.
|
||
|
||
* **displaycolor** (*dict*) –
|
||
|
||
The color codes to use for each circuit element in the form (gate\_color, text\_color). The default values are:
|
||
|
||
```python
|
||
{
|
||
'u1': ('#FA74A6', '#000000'),
|
||
'u2': ('#FA74A6', '#000000'),
|
||
'u3': ('#FA74A6', '#000000'),
|
||
'id': ('#05BAB6', '#000000'),
|
||
'x': ('#05BAB6', '#000000'),
|
||
'y': ('#05BAB6', '#000000'),
|
||
'z': ('#05BAB6', '#000000'),
|
||
'h': ('#6FA4FF', '#000000'),
|
||
'cx': ('#6FA4FF', '#000000'),
|
||
'cy': ('#6FA4FF', '#000000'),
|
||
'cz': ('#6FA4FF', '#000000'),
|
||
'swap': ('#6FA4FF', '#000000'),
|
||
's': ('#6FA4FF', '#000000'),
|
||
'sdg': ('#6FA4FF', '#000000'),
|
||
'dcx': ('#6FA4FF', '#000000'),
|
||
'iswap': ('#6FA4FF', '#000000'),
|
||
't': ('#BB8BFF', '#000000'),
|
||
'tdg': ('#BB8BFF', '#000000'),
|
||
'r': ('#BB8BFF', '#000000'),
|
||
'rx': ('#BB8BFF', '#000000'),
|
||
'ry': ('#BB8BFF', '#000000'),
|
||
'rz': ('#BB8BFF', '#000000'),
|
||
'rxx': ('#BB8BFF', '#000000'),
|
||
'ryy': ('#BB8BFF', '#000000'),
|
||
'rzx': ('#BB8BFF', '#000000'),
|
||
'reset': ('#000000', #FFFFFF'),
|
||
'target': ('#FFFFFF, '#FFFFFF'),
|
||
'measure': ('#000000', '#FFFFFF'),
|
||
'ccx': ('#BB8BFF', '#000000'),
|
||
'cdcx': ('#BB8BFF', '#000000'),
|
||
'ccdcx': ('#BB8BFF', '#000000'),
|
||
'cswap': ('#BB8BFF', '#000000'),
|
||
'ccswap': ('#BB8BFF', '#000000'),
|
||
'mcx': ('#BB8BFF', '#000000'),
|
||
'mcx_gray': ('#BB8BFF', '#000000),
|
||
'u': ('#BB8BFF', '#000000'),
|
||
'p': ('#BB8BFF', '#000000'),
|
||
'sx': ('#BB8BFF', '#000000'),
|
||
'sxdg': ('#BB8BFF', '#000000')
|
||
}
|
||
```
|
||
|
||
Colors can also be entered without the text color, such as ‘u1’: ‘#FA74A6’, in which case the text color will always be ‘gatetextcolor’. The ‘displaycolor’ dict can contain any number of elements from one to the entire dict above.
|
||
|
||
* **latexdrawerstyle** (*bool*) – When set to True, enable LaTeX mode, which will draw gates like the latex output modes.
|
||
|
||
* **usepiformat** (*bool*) – When set to True, use radians for output.
|
||
|
||
* **fold** (*int*) – The number of circuit elements to fold the circuit at. Defaults to 20.
|
||
|
||
* **cregbundle** (*bool*) – If set True, bundle classical registers
|
||
|
||
* **showindex** (*bool*) – If set True, draw an index.
|
||
|
||
* **compress** (*bool*) – If set True, draw a compressed circuit.
|
||
|
||
* **figwidth** (*int*) – The maximum width (in inches) for the output figure.
|
||
|
||
* **dpi** (*int*) – The DPI to use for the output image. Defaults to 150.
|
||
|
||
* **margin** (*list*) – A list of margin values to adjust spacing around output image. Takes a list of 4 ints: \[x left, x right, y bottom, y top].
|
||
|
||
* **creglinestyle** (*str*) – The style of line to use for classical registers. Choices are ‘solid’, ‘doublet’, or any valid matplotlib linestyle kwarg value. Defaults to doublet
|
||
</Function>
|
||
|
||
### entanglement
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.entanglement">
|
||
Get the entanglement strategy.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`str`, `List`\[`str`], `List`\[`List`\[`str`]], `List`\[`int`], `List`\[`List`\[`int`]], `List`\[`List`\[`List`\[`int`]]], `List`\[`List`\[`List`\[`List`\[`int`]]]], `Callable`\[\[`int`], `str`], `Callable`\[\[`int`], `List`\[`List`\[`int`]]]]
|
||
|
||
**Returns**
|
||
|
||
The entanglement strategy, see [`get_entangler_map()`](#qiskit.circuit.library.NLocal.get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map") for more detail on how the format is interpreted.
|
||
</Attribute>
|
||
|
||
### entanglement\_blocks
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.entanglement_blocks">
|
||
The blocks in the entanglement layers.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`Instruction`]
|
||
|
||
**Returns**
|
||
|
||
The blocks in the entanglement layers.
|
||
</Attribute>
|
||
|
||
### extend
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.extend" signature="extend(rhs)">
|
||
Append QuantumCircuit to the right hand side if it contains compatible registers.
|
||
|
||
Two circuits are compatible if they contain the same registers or if they contain different registers with unique names. The returned circuit will contain all unique registers between both circuits.
|
||
|
||
Modify and return self.
|
||
|
||
**Parameters**
|
||
|
||
**rhs** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The quantum circuit to append to the right hand side.
|
||
|
||
**Returns**
|
||
|
||
Returns this QuantumCircuit object (which has been modified)
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**QiskitError** – if the rhs circuit is not compatible
|
||
</Function>
|
||
|
||
### fredkin
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.fredkin" signature="fredkin(control_qubit, target_qubit1, target_qubit2)">
|
||
Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate").
|
||
</Function>
|
||
|
||
### from\_qasm\_file
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.from_qasm_file" signature="from_qasm_file(path)" modifiers="static">
|
||
Take in a QASM file and generate a QuantumCircuit object.
|
||
|
||
**Parameters**
|
||
|
||
**path** (*str*) – Path to the file for a QASM program
|
||
|
||
**Returns**
|
||
|
||
The QuantumCircuit object for the input QASM
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### from\_qasm\_str
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.from_qasm_str" signature="from_qasm_str(qasm_str)" modifiers="static">
|
||
Take in a QASM string and generate a QuantumCircuit object.
|
||
|
||
**Parameters**
|
||
|
||
**qasm\_str** (*str*) – A QASM program string
|
||
|
||
**Returns**
|
||
|
||
The QuantumCircuit object for the input QASM
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### get\_entangler\_map
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.get_entangler_map" signature="get_entangler_map(rep_num, block_num, num_block_qubits)">
|
||
Get the entangler map for in the repetition `rep_num` and the block `block_num`.
|
||
|
||
The entangler map for the current block is derived from the value of `self.entanglement`. Below the different cases are listed, where `i` and `j` denote the repetition number and the block number, respectively, and `n` the number of qubits in the block.
|
||
|
||
entanglement type | entangler map ——————————-+——————————————————– None | \[\[0, …, n - 1]] str (e.g ‘full’) | the specified connectivity on `n` qubits List\[int] | \[`entanglement`] List\[List\[int]] | `entanglement` List\[List\[List\[int]]] | `entanglement[i]` List\[List\[List\[List\[int]]]] | `entanglement[i][j]` List\[str] | the connectivity specified in `entanglement[i]` List\[List\[str]] | the connectivity specified in `entanglement[i][j]` Callable\[int, str] | same as List\[str] Callable\[int, List\[List\[int]]] | same as List\[List\[List\[int]]]
|
||
|
||
Note that all indices are to be taken modulo the length of the array they act on, i.e. no out-of-bounds index error will be raised but we re-iterate from the beginning of the list.
|
||
|
||
**Parameters**
|
||
|
||
* **rep\_num** (`int`) – The current repetition we are in.
|
||
* **block\_num** (`int`) – The block number within the entanglement layers.
|
||
* **num\_block\_qubits** (`int`) – The number of qubits in the block.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`List`\[`int`]]
|
||
|
||
**Returns**
|
||
|
||
The entangler map for the current block in the current repetition.
|
||
|
||
**Raises**
|
||
|
||
**ValueError** – If the value of `entanglement` could not be cast to a corresponding entangler map.
|
||
</Function>
|
||
|
||
### get\_unentangled\_qubits
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.get_unentangled_qubits" signature="get_unentangled_qubits()">
|
||
Get the indices of unentangled qubits in a set.
|
||
|
||
**Return type**
|
||
|
||
`Set`\[`int`]
|
||
|
||
**Returns**
|
||
|
||
The unentangled qubits.
|
||
</Function>
|
||
|
||
### global\_phase
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.global_phase">
|
||
Return the global phase of the circuit in radians.
|
||
</Attribute>
|
||
|
||
### h
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.h" signature="h(qubit)">
|
||
Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate").
|
||
</Function>
|
||
|
||
### hamiltonian
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.hamiltonian" signature="hamiltonian(operator, time, qubits, label=None)">
|
||
Apply hamiltonian evolution to to qubits.
|
||
</Function>
|
||
|
||
### has\_register
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.has_register" signature="has_register(register)">
|
||
Test if this circuit has the register r.
|
||
|
||
**Parameters**
|
||
|
||
**register** (*Register*) – a quantum or classical register.
|
||
|
||
**Returns**
|
||
|
||
True if the register is contained in this circuit.
|
||
|
||
**Return type**
|
||
|
||
bool
|
||
</Function>
|
||
|
||
### i
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.i" signature="i(qubit)">
|
||
Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate").
|
||
</Function>
|
||
|
||
### id
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.id" signature="id(qubit)">
|
||
Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate").
|
||
</Function>
|
||
|
||
### initial\_state
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.initial_state">
|
||
Return the initial state that is added in front of the n-local circuit.
|
||
|
||
**Return type**
|
||
|
||
`Any`
|
||
|
||
**Returns**
|
||
|
||
The initial state.
|
||
</Attribute>
|
||
|
||
### initialize
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.initialize" signature="initialize(params, qubits)">
|
||
Apply initialize to circuit.
|
||
</Function>
|
||
|
||
### insert\_barriers
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.insert_barriers">
|
||
If barriers are inserted in between the layers or not.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
|
||
**Returns**
|
||
|
||
True, if barriers are inserted in between the layers, False if not.
|
||
</Attribute>
|
||
|
||
### inverse
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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** – if the circuit cannot be inverted.
|
||
|
||
**Examples**
|
||
|
||
**input:**
|
||
|
||
┌───┐
|
||
|
||
**q\_0: ┤ H ├─────■──────**
|
||
|
||
└───┘┌────┴─────┐
|
||
|
||
**q\_1: ─────┤ RX(1.57) ├**
|
||
|
||
└──────────┘
|
||
|
||
**output:**
|
||
|
||
┌───┐
|
||
|
||
**q\_0: ──────■──────┤ H ├**
|
||
|
||
┌─────┴─────┐└───┘
|
||
|
||
**q\_1: ┤ RX(-1.57) ├─────**
|
||
|
||
└───────────┘
|
||
</Function>
|
||
|
||
### iso
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.iso" signature="iso(isometry, q_input, q_ancillas_for_output, q_ancillas_zero=None, q_ancillas_dirty=None)">
|
||
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|list\[*[*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|list\[*[*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|list\[*[*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|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which can start in an arbitrary state. Default is q\_ancillas\_dirty = None.
|
||
|
||
**Returns**
|
||
|
||
the isometry is attached to the quantum circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**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.library.NLocal.isometry" signature="isometry(isometry, q_input, q_ancillas_for_output, q_ancillas_zero=None, q_ancillas_dirty=None)">
|
||
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|list\[*[*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|list\[*[*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|list\[*[*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|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which can start in an arbitrary state. Default is q\_ancillas\_dirty = None.
|
||
|
||
**Returns**
|
||
|
||
the isometry is attached to the quantum circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**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.library.NLocal.iswap" signature="iswap(qubit1, qubit2)">
|
||
Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate").
|
||
</Function>
|
||
|
||
### mcmt
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.mcmt" signature="mcmt(gate, control_qubits, target_qubits, ancilla_qubits=None, mode='noancilla', *, single_control_gate_fun=None, q_controls=None, q_ancillae=None, q_targets=None)">
|
||
Apply a multi-control, multi-target using a generic gate.
|
||
|
||
This can also be used to implement a generic multi-control gate, as the target could also be of length 1.
|
||
</Function>
|
||
|
||
### mcp
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.mcp" signature="mcp(lam, control_qubits, target_qubit)">
|
||
Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate").
|
||
</Function>
|
||
|
||
### mcrx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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*) – angle theta
|
||
* **q\_controls** (*list(*[*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*) – use p, u, cx
|
||
|
||
**Raises**
|
||
|
||
**QiskitError** – parameter errors
|
||
</Function>
|
||
|
||
### mcry
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.mcry" signature="mcry(theta, q_controls, q_target, q_ancillae, 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*) – angle theta
|
||
* **q\_controls** (*list(*[*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(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*, int)*) – The list of ancillary qubits.
|
||
* **mode** (*string*) – The implementation mode to use
|
||
* **use\_basis\_gates** (*bool*) – use p, u, cx
|
||
|
||
**Raises**
|
||
|
||
**QiskitError** – parameter errors
|
||
</Function>
|
||
|
||
### mcrz
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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*) – angle lambda
|
||
* **q\_controls** (*list(*[*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*) – use p, u, cx
|
||
|
||
**Raises**
|
||
|
||
**QiskitError** – parameter errors
|
||
</Function>
|
||
|
||
### mct
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.mct" signature="mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')">
|
||
Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate").
|
||
</Function>
|
||
|
||
### mcu1
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.mcu1" signature="mcu1(lam, control_qubits, target_qubit)">
|
||
Apply `MCU1Gate`.
|
||
</Function>
|
||
|
||
### mcx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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: - ‘no-ancilla’: 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).
|
||
</Function>
|
||
|
||
### measure
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.measure" signature="measure(qubit, cbit)">
|
||
Measure quantum bit into classical bit (tuples).
|
||
|
||
**Parameters**
|
||
|
||
* **qubit** (*QuantumRegister|list|tuple*) – quantum register
|
||
* **cbit** (*ClassicalRegister|list|tuple*) – classical register
|
||
|
||
**Returns**
|
||
|
||
the attached measure instruction.
|
||
|
||
**Return type**
|
||
|
||
qiskit.Instruction
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – if qubit is not in this circuit or bad format; if cbit is not in this circuit or not creg.
|
||
</Function>
|
||
|
||
### measure\_active
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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*) – 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.library.NLocal.measure_all" signature="measure_all(inplace=True)">
|
||
Adds measurement to all qubits. Creates a new ClassicalRegister with a size equal to the number of qubits being measured.
|
||
|
||
Returns a new circuit with measurements if inplace=False.
|
||
|
||
**Parameters**
|
||
|
||
**inplace** (*bool*) – 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>
|
||
|
||
### mirror
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.mirror" signature="mirror()">
|
||
DEPRECATED: use circuit.reverse\_ops().
|
||
|
||
**Returns**
|
||
|
||
the reversed circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### ms
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.ms" signature="ms(theta, qubits)">
|
||
Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate").
|
||
</Function>
|
||
|
||
### num\_ancillas
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.num_ancillas">
|
||
Return the number of ancilla qubits.
|
||
</Attribute>
|
||
|
||
### num\_clbits
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.num_clbits">
|
||
Return number of classical bits.
|
||
</Attribute>
|
||
|
||
### num\_connected\_components
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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*) – Compute only unitary part of graph.
|
||
|
||
**Returns**
|
||
|
||
Number of connected components in circuit.
|
||
|
||
**Return type**
|
||
|
||
int
|
||
</Function>
|
||
|
||
### num\_layers
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.num_layers">
|
||
Return the number of layers in the n-local circuit.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
|
||
**Returns**
|
||
|
||
The number of layers in the circuit.
|
||
</Attribute>
|
||
|
||
### num\_nonlocal\_gates
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.num_nonlocal_gates" signature="num_nonlocal_gates()">
|
||
Return number of non-local gates (i.e. involving 2+ qubits).
|
||
|
||
Conditional nonlocal gates are also included.
|
||
</Function>
|
||
|
||
### num\_parameters
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.num_parameters">
|
||
Convenience function to get the number of parameter objects in the circuit.
|
||
</Attribute>
|
||
|
||
### num\_parameters\_settable
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.num_parameters_settable">
|
||
The number of total parameters that can be set to distinct values.
|
||
|
||
This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
|
||
**Returns**
|
||
|
||
The number of parameters originally available in the circuit.
|
||
|
||
<Admonition title="Note" type="note">
|
||
This quantity does not require the circuit to be built yet.
|
||
</Admonition>
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.num_qubits">
|
||
Returns the number of qubits in this circuit.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
|
||
**Returns**
|
||
|
||
The number of qubits.
|
||
</Attribute>
|
||
|
||
### num\_tensor\_factors
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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.
|
||
</Function>
|
||
|
||
### num\_unitary\_factors
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.num_unitary_factors" signature="num_unitary_factors()">
|
||
Computes the number of tensor factors in the unitary (quantum) part of the circuit only.
|
||
</Function>
|
||
|
||
### ordered\_parameters
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.ordered_parameters">
|
||
The parameters used in the underlying circuit.
|
||
|
||
This includes float values and duplicates.
|
||
|
||
**Examples**
|
||
|
||
```python
|
||
>>> # prepare circuit ...
|
||
>>> print(nlocal)
|
||
┌───────┐┌──────────┐┌──────────┐┌──────────┐
|
||
q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├
|
||
└───────┘└──────────┘└──────────┘└──────────┘
|
||
>>> nlocal.parameters
|
||
{Parameter(θ[1]), Parameter(θ[3])}
|
||
>>> nlocal.ordered_parameters
|
||
[1, Parameter(θ[1]), Parameter(θ[1]), Parameter(θ[3])]
|
||
```
|
||
|
||
**Return type**
|
||
|
||
`List`\[`Parameter`]
|
||
|
||
**Returns**
|
||
|
||
The parameters objects used in the circuit.
|
||
</Attribute>
|
||
|
||
### p
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.p" signature="p(theta, qubit)">
|
||
Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate").
|
||
</Function>
|
||
|
||
### parameter\_bounds
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.parameter_bounds">
|
||
The parameter bounds for the unbound parameters in the circuit.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`List`\[`Tuple`\[`float`, `float`]]]
|
||
|
||
**Returns**
|
||
|
||
A list of pairs indicating the bounds, as (lower, upper). None indicates an unbounded parameter in the corresponding direction. If None is returned, problem is fully unbounded.
|
||
</Attribute>
|
||
|
||
### parameters
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.parameters">
|
||
Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit.
|
||
|
||
**Return type**
|
||
|
||
`Set`\[`Parameter`]
|
||
|
||
**Returns**
|
||
|
||
A set containing the unbound circuit parameters.
|
||
</Attribute>
|
||
|
||
### power
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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** (*int*) – The power to raise this circuit to.
|
||
* **matrix\_power** (*bool*) – 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** – 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>
|
||
|
||
### preferred\_init\_points
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.preferred_init_points">
|
||
The initial points for the parameters. Can be stored as initial guess in optimization.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`List`\[`float`]]
|
||
|
||
**Returns**
|
||
|
||
The initial values for the parameters, or None, if none have been set.
|
||
</Attribute>
|
||
|
||
### print\_settings
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.print_settings" signature="print_settings()">
|
||
Returns information about the setting.
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
|
||
**Returns**
|
||
|
||
The class name and the attributes/parameters of the instance as `str`.
|
||
</Function>
|
||
|
||
### qasm
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.qasm" signature="qasm(formatted=False, filename=None)">
|
||
Return OpenQASM string.
|
||
|
||
**Parameters**
|
||
|
||
* **formatted** (*bool*) – Return formatted Qasm string.
|
||
* **filename** (*str*) – Save Qasm to file with name ‘filename’.
|
||
|
||
**Returns**
|
||
|
||
If formatted=False.
|
||
|
||
**Return type**
|
||
|
||
str
|
||
|
||
**Raises**
|
||
|
||
**ImportError** – If pygments is not installed and `formatted` is `True`.
|
||
</Function>
|
||
|
||
### qbit\_argument\_conversion
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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**
|
||
|
||
Where each tuple is a qubit.
|
||
|
||
**Return type**
|
||
|
||
List(tuple)
|
||
</Function>
|
||
|
||
### qregs
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.qregs">
|
||
A list of the quantum registers associated with the circuit.
|
||
</Attribute>
|
||
|
||
### qubit\_duration
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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** – Qubits within `self` to include.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`int`, `float`]
|
||
|
||
**Returns**
|
||
|
||
Return the duration between the first start and last stop time of non-delay instructions
|
||
</Function>
|
||
|
||
### qubit\_start\_time
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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** – Qubits within `self` to include. Integers are allowed for qubits, indicating
|
||
* **of self.qubits.** (*indices*) –
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`int`, `float`]
|
||
|
||
**Returns**
|
||
|
||
Return the start time of the first instruction, excluding delays, over the qubits
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – if `self` is a not-yet scheduled circuit.
|
||
</Function>
|
||
|
||
### qubit\_stop\_time
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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** – Qubits within `self` to include. Integers are allowed for qubits, indicating
|
||
* **of self.qubits.** (*indices*) –
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`int`, `float`]
|
||
|
||
**Returns**
|
||
|
||
Return the stop time of the last instruction, excluding delays, over the qubits
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – if `self` is a not-yet scheduled circuit.
|
||
</Function>
|
||
|
||
### qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.qubits">
|
||
Returns a list of quantum bits in the order that the registers were added.
|
||
</Attribute>
|
||
|
||
### r
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.r" signature="r(theta, phi, qubit)">
|
||
Apply `RGate`.
|
||
</Function>
|
||
|
||
### rcccx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.rcccx" signature="rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)">
|
||
Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate").
|
||
</Function>
|
||
|
||
### rccx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.rccx" signature="rccx(control_qubit1, control_qubit2, target_qubit)">
|
||
Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate").
|
||
</Function>
|
||
|
||
### remove\_final\_measurements
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.remove_final_measurements" signature="remove_final_measurements(inplace=True)">
|
||
Removes final measurement on all qubits if they are present. Deletes the ClassicalRegister that was used to store the values from these measurements if it is idle.
|
||
|
||
Returns a new circuit without measurements if inplace=False.
|
||
|
||
**Parameters**
|
||
|
||
**inplace** (*bool*) – All measurements removed inplace or return new circuit.
|
||
|
||
**Returns**
|
||
|
||
Returns circuit with measurements removed when inplace = False.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### repeat
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.repeat" signature="repeat(reps)">
|
||
Repeat this circuit `reps` times.
|
||
|
||
**Parameters**
|
||
|
||
**reps** (*int*) – 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>
|
||
|
||
### reps
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.reps">
|
||
The number of times rotation and entanglement block are repeated.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
|
||
**Returns**
|
||
|
||
The number of repetitions.
|
||
</Attribute>
|
||
|
||
### reset
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.reset" signature="reset(qubit)">
|
||
Reset q.
|
||
</Function>
|
||
|
||
### reverse\_bits
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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:**
|
||
|
||
┌───┐
|
||
|
||
**q\_0: ┤ H ├─────■──────**
|
||
|
||
└───┘┌────┴─────┐
|
||
|
||
**q\_1: ─────┤ RX(1.57) ├**
|
||
|
||
└──────────┘
|
||
|
||
**output:**
|
||
|
||
┌──────────┐
|
||
|
||
**q\_0: ─────┤ RX(1.57) ├**
|
||
|
||
┌───┐└────┬─────┘
|
||
|
||
**q\_1: ┤ H ├─────■──────**
|
||
|
||
└───┘
|
||
</Function>
|
||
|
||
### reverse\_ops
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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:**
|
||
|
||
┌───┐
|
||
|
||
**q\_0: ┤ H ├─────■──────**
|
||
|
||
└───┘┌────┴─────┐
|
||
|
||
**q\_1: ─────┤ RX(1.57) ├**
|
||
|
||
└──────────┘
|
||
|
||
**output:**
|
||
|
||
┌───┐
|
||
|
||
**q\_0: ─────■──────┤ H ├**
|
||
|
||
┌────┴─────┐└───┘
|
||
|
||
**q\_1: ┤ RX(1.57) ├─────**
|
||
|
||
└──────────┘
|
||
</Function>
|
||
|
||
### rotation\_blocks
|
||
|
||
<Attribute id="qiskit.circuit.library.NLocal.rotation_blocks">
|
||
The blocks in the rotation layers.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`Instruction`]
|
||
|
||
**Returns**
|
||
|
||
The blocks in the rotation layers.
|
||
</Attribute>
|
||
|
||
### rx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.rx" signature="rx(theta, qubit, label=None)">
|
||
Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate").
|
||
</Function>
|
||
|
||
### rxx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.rxx" signature="rxx(theta, qubit1, qubit2)">
|
||
Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate").
|
||
</Function>
|
||
|
||
### ry
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.ry" signature="ry(theta, qubit, label=None)">
|
||
Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate").
|
||
</Function>
|
||
|
||
### ryy
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.ryy" signature="ryy(theta, qubit1, qubit2)">
|
||
Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate").
|
||
</Function>
|
||
|
||
### rz
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.rz" signature="rz(phi, qubit)">
|
||
Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate").
|
||
</Function>
|
||
|
||
### rzx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.rzx" signature="rzx(theta, qubit1, qubit2)">
|
||
Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate").
|
||
</Function>
|
||
|
||
### rzz
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.rzz" signature="rzz(theta, qubit1, qubit2)">
|
||
Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate").
|
||
</Function>
|
||
|
||
### s
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.s" signature="s(qubit)">
|
||
Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate").
|
||
</Function>
|
||
|
||
### sdg
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.sdg" signature="sdg(qubit)">
|
||
Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate").
|
||
</Function>
|
||
|
||
### size
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.size" signature="size()">
|
||
Returns total number of gate operations in circuit.
|
||
|
||
**Returns**
|
||
|
||
Total number of gate operations.
|
||
|
||
**Return type**
|
||
|
||
int
|
||
</Function>
|
||
|
||
### snapshot
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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). :param label: a snapshot label to report the result :type label: str :param snapshot\_type: the type of the snapshot. :type snapshot\_type: str :param qubits: the qubits to apply snapshot to \[Default: None]. :type qubits: list or None :param params: the parameters for snapshot\_type \[Default: None]. :type params: list or None
|
||
|
||
**Returns**
|
||
|
||
with attached command
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**ExtensionError** – malformed command
|
||
</Function>
|
||
|
||
### snapshot\_density\_matrix
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.snapshot_density_matrix" signature="snapshot_density_matrix(label, qubits=None)">
|
||
Take a density matrix snapshot of simulator state.
|
||
|
||
**Parameters**
|
||
|
||
* **label** (*str*) – a snapshot label to report the result
|
||
* **qubits** (*list or None*) – the qubits to apply snapshot to. If None all qubits will be snapshot \[Default: None].
|
||
|
||
**Returns**
|
||
|
||
with attached instruction.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**ExtensionError** – if snapshot is invalid.
|
||
</Function>
|
||
|
||
### snapshot\_expectation\_value
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.snapshot_expectation_value" signature="snapshot_expectation_value(label, op, qubits, single_shot=False, variance=False)">
|
||
Take a snapshot of expectation value \<O> of an Operator.
|
||
|
||
**Parameters**
|
||
|
||
* **label** (*str*) – a snapshot label to report the result
|
||
* **op** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – operator to snapshot
|
||
* **qubits** (*list*) – the qubits to snapshot.
|
||
* **single\_shot** (*bool*) – return list for each shot rather than average \[Default: False]
|
||
* **variance** (*bool*) – compute variance of values \[Default: False]
|
||
|
||
**Returns**
|
||
|
||
with attached instruction.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**ExtensionError** – if snapshot is invalid.
|
||
</Function>
|
||
|
||
### snapshot\_probabilities
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.snapshot_probabilities" signature="snapshot_probabilities(label, qubits, variance=False)">
|
||
Take a probability snapshot of the simulator state.
|
||
|
||
**Parameters**
|
||
|
||
* **label** (*str*) – a snapshot label to report the result
|
||
* **qubits** (*list*) – the qubits to snapshot.
|
||
* **variance** (*bool*) – compute variance of probabilities \[Default: False]
|
||
|
||
**Returns**
|
||
|
||
with attached instruction.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**ExtensionError** – if snapshot is invalid.
|
||
</Function>
|
||
|
||
### snapshot\_stabilizer
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.snapshot_stabilizer" signature="snapshot_stabilizer(label)">
|
||
Take a stabilizer snapshot of the simulator state.
|
||
|
||
**Parameters**
|
||
|
||
**label** (*str*) – a snapshot label to report the result.
|
||
|
||
**Returns**
|
||
|
||
with attached instruction.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**ExtensionError** – if snapshot is invalid.
|
||
|
||
**Additional Information:**
|
||
|
||
This snapshot is always performed on all qubits in a circuit. The number of qubits parameter specifies the size of the instruction as a barrier and should be set to the number of qubits in the circuit.
|
||
</Function>
|
||
|
||
### snapshot\_statevector
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.snapshot_statevector" signature="snapshot_statevector(label)">
|
||
Take a statevector snapshot of the simulator state.
|
||
|
||
**Parameters**
|
||
|
||
**label** (*str*) – a snapshot label to report the result.
|
||
|
||
**Returns**
|
||
|
||
with attached instruction.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
**ExtensionError** – if snapshot is invalid.
|
||
|
||
**Additional Information:**
|
||
|
||
This snapshot is always performed on all qubits in a circuit. The number of qubits parameter specifies the size of the instruction as a barrier and should be set to the number of qubits in the circuit.
|
||
</Function>
|
||
|
||
### squ
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.squ" signature="squ(unitary_matrix, qubit, mode='ZYZ', up_to_diagonal=False, *, u=None)">
|
||
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 | 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*) – 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’)
|
||
* **u** (*ndarray*) – Deprecated, use `unitary_matrix` instead.
|
||
|
||
**Returns**
|
||
|
||
The single-qubit unitary instruction attached to the circuit.
|
||
|
||
**Return type**
|
||
|
||
[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")
|
||
|
||
**Raises**
|
||
|
||
**QiskitError** – if the format is wrong; if the array u is not unitary
|
||
</Function>
|
||
|
||
### swap
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.swap" signature="swap(qubit1, qubit2)">
|
||
Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate").
|
||
</Function>
|
||
|
||
### sx
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.sx" signature="sx(qubit)">
|
||
Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate").
|
||
</Function>
|
||
|
||
### sxdg
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.sxdg" signature="sxdg(qubit)">
|
||
Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate").
|
||
</Function>
|
||
|
||
### t
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.t" signature="t(qubit)">
|
||
Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate").
|
||
</Function>
|
||
|
||
### tdg
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.tdg" signature="tdg(qubit)">
|
||
Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate").
|
||
</Function>
|
||
|
||
### to\_gate
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.to_gate" signature="to_gate(parameter_map=None, label=None)">
|
||
Create a Gate out of this circuit.
|
||
|
||
**Parameters**
|
||
|
||
* **parameter\_map** (*dict*) – 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*) – 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.library.NLocal.to_instruction" signature="to_instruction(parameter_map=None)">
|
||
Create an Instruction out of this circuit.
|
||
|
||
**Parameters**
|
||
|
||
**parameter\_map** (*dict*) – 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.
|
||
|
||
**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.library.NLocal.toffoli" signature="toffoli(control_qubit1, control_qubit2, target_qubit)">
|
||
Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate").
|
||
</Function>
|
||
|
||
### u
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.u" signature="u(theta, phi, lam, qubit)">
|
||
Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate").
|
||
</Function>
|
||
|
||
### u1
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.u1" signature="u1(theta, qubit)">
|
||
Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate").
|
||
</Function>
|
||
|
||
### u2
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.u2" signature="u2(phi, lam, qubit)">
|
||
Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate").
|
||
</Function>
|
||
|
||
### u3
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.u3" signature="u3(theta, phi, lam, qubit)">
|
||
Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate").
|
||
</Function>
|
||
|
||
### uc
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.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\[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|list\[(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*,int)]*) – 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|(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*,int)*) – target qubit, where we act on with the single-qubit gates.
|
||
* **up\_to\_diagonal** (*bool*) – 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** – 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.library.NLocal.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*) – list of (real) rotation angles $[a_0,...,a_{2^k-1}]$
|
||
* **q\_controls** (*QuantumRegister|list*) – 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** (*QuantumRegister|Qubit*) – 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** – 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.library.NLocal.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\[numbers*) – list of (real) rotation angles $[a_0,...,a_{2^k-1}]$
|
||
* **q\_controls** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – 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** (*QuantumRegister|Qubit*) – 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** – 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.library.NLocal.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\[numbers*) – list of (real) rotation angles \[a\_0,…,a\_\{2^k-1}]
|
||
* **q\_controls** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – 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\[1],q\[2]] (with q = QuantumRegister(2)), the rotation Rz(a\_0)is performed if q\[1] and q\[2] are in the state zero, the rotation Rz(a\_1) is performed if q\[1] is in the state one and q\[2] is in the state zero, and so on
|
||
* **q\_target** (*QuantumRegister|Qubit*) – 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** – 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.library.NLocal.unitary" signature="unitary(obj, qubits, label=None)">
|
||
Apply unitary gate to q.
|
||
</Function>
|
||
|
||
### width
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.width" signature="width()">
|
||
Return number of qubits plus clbits in circuit.
|
||
|
||
**Returns**
|
||
|
||
Width of circuit.
|
||
|
||
**Return type**
|
||
|
||
int
|
||
</Function>
|
||
|
||
### x
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.x" signature="x(qubit, label=None)">
|
||
Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate").
|
||
</Function>
|
||
|
||
### y
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.y" signature="y(qubit)">
|
||
Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate").
|
||
</Function>
|
||
|
||
### z
|
||
|
||
<Function id="qiskit.circuit.library.NLocal.z" signature="z(qubit)">
|
||
Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate").
|
||
</Function>
|
||
</Class>
|
||
|