VBERippleCarryAdder
class VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')
Bases: qiskit.circuit.library.arithmetic.adders.adder.Adder
The VBE ripple carry adder [1].
This circuit performs inplace addition of two equally-sized quantum registers. As an example, a classical adder circuit that performs full addition (i.e. including a carry-in bit) on two 2-qubit sized registers is as follows:
┌────────┐ ┌───────────┐┌──────┐
cin_0: ┤0 ├───────────────────────┤0 ├┤0 ├
│ │ │ ││ │
a_0: ┤1 ├───────────────────────┤1 ├┤1 ├
│ │┌────────┐ ┌──────┐│ ││ Sum │
a_1: ┤ ├┤1 ├──■──┤1 ├┤ ├┤ ├
│ ││ │ │ │ ││ ││ │
b_0: ┤2 Carry ├┤ ├──┼──┤ ├┤2 Carry_dg ├┤2 ├
│ ││ │┌─┴─┐│ ││ │└──────┘
b_1: ┤ ├┤2 Carry ├┤ X ├┤2 Sum ├┤ ├────────
│ ││ │└───┘│ ││ │
cout_0: ┤ ├┤3 ├─────┤ ├┤ ├────────
│ ││ │ │ ││ │
helper_0: ┤3 ├┤0 ├─────┤0 ├┤3 ├────────
└────────┘└────────┘ └──────┘└───────────┘Here Carry and Sum gates correspond to the gates introduced in [1]. Carry_dg correspond to the inverse of the Carry gate. Note that in this implementation the input register qubits are ordered as all qubits from the first input register, followed by all qubits from the second input register. This is different ordering as compared to Figure 2 in [1], which leads to a different drawing of the circuit.
References:
[1] Vedral et al., Quantum Networks for Elementary Arithmetic Operations, 1995. arXiv:quant-ph/9511018
Parameters
- num_state_qubits (
int) – The size of the register. - kind (
str) – The kind of adder, can be'full'for a full adder,'half'for a half adder, or'fixed'for a fixed-sized adder. A full adder includes both carry-in and carry-out, a half only carry-out, and a fixed-sized adder neither carry-in nor carry-out. - name (
str) – The name of the circuit.
Raises
ValueError – If num_state_qubits is lower than 1.
Attributes
ancillas
Returns a list of ancilla bits in the order that the registers were added.
Return type
List[AncillaQubit]
calibrations
Return calibration dictionary.
The custom pulse definition of a given gate is of the form {'gate_name': {(qubits, params): schedule}}
Return type
dict
clbits
data
Return the circuit data (instructions and context).
Returns
a list-like object containing the CircuitInstructions for each instruction.
Return type
QuantumCircuitData
extension_lib
Default value: 'include "qelib1.inc";'
global_phase
header
Default value: 'OPENQASM 2.0;'
instances
Default value: 2737
metadata
The user provided metadata associated with the circuit
The metadata for the circuit is a user provided dict of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit.
Return type
dict
num_ancillas
Return the number of ancilla qubits.
Return type
int
num_clbits
Return number of classical bits.
Return type
int
num_parameters
The number of parameter objects in the circuit.
Return type
int
num_qubits
Return number of qubits.
Return type
int
num_state_qubits
The number of state qubits, i.e. the number of bits in each input register.
Return type
int
Returns
The number of state qubits.
op_start_times
Return a list of operation start times.
This attribute is enabled once one of scheduling analysis passes runs on the quantum circuit.
Return type
List[int]
Returns
List of integers representing instruction start times. The index corresponds to the index of instruction in QuantumCircuit.data.
Raises
AttributeError – When circuit is not scheduled.
parameters
The parameters defined in the circuit.
This attribute returns the Parameter objects in the circuit sorted alphabetically. Note that parameters instantiated with a ParameterVector are still sorted numerically.
Examples
The snippet below shows that insertion order of parameters does not matter.
>>> from qiskit.circuit import QuantumCircuit, Parameter
>>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant")
>>> circuit = QuantumCircuit(1)
>>> circuit.rx(b, 0)
>>> circuit.rz(elephant, 0)
>>> circuit.ry(a, 0)
>>> circuit.parameters # sorted alphabetically!
ParameterView([Parameter(a), Parameter(b), Parameter(elephant)])Bear in mind that alphabetical sorting might be unituitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting.
>>> from qiskit.circuit import QuantumCircuit, Parameter
>>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")]
>>> circuit = QuantumCircuit(1)
>>> circuit.u(*angles, 0)
>>> circuit.draw()
┌─────────────────────────────┐
q: ┤ U(angle_1,angle_2,angle_10) ├
└─────────────────────────────┘
>>> circuit.parameters
ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)])To respect numerical sorting, a ParameterVector can be used.
>>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector
>>> x = ParameterVector("x", 12)
>>> circuit = QuantumCircuit(1)
>>> for x_i in x:
... circuit.rx(x_i, 0)
>>> circuit.parameters
ParameterView([
ParameterVectorElement(x[0]), ParameterVectorElement(x[1]),
ParameterVectorElement(x[2]), ParameterVectorElement(x[3]),
..., ParameterVectorElement(x[11])
])Return type
ParameterView
Returns
The sorted Parameter objects in the circuit.
prefix
Default value: 'circuit'