qiskit 1.3.0b1__cp39-abi3-macosx_10_9_x86_64.whl

qiskit/circuit/library/arithmetic/integer_comparator.py

@@ -0,0 +1,243 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2020.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+
+"""Integer Comparator."""
+
+from __future__ import annotations
+import math
+
+from qiskit.circuit import QuantumCircuit, QuantumRegister, AncillaRegister
+from qiskit.circuit.exceptions import CircuitError
+from ..boolean_logic import OR
+from ..blueprintcircuit import BlueprintCircuit
+
+
+class IntegerComparator(BlueprintCircuit):
+    r"""Integer Comparator.
+
+    Operator compares basis states :math:`|i\rangle_n` against a classically given integer
+    :math:`L` of fixed value and flips a target qubit if :math:`i \geq L`
+    (or :math:`<` depending on the parameter ``geq``):
+
+    .. math::
+
+        |i\rangle_n |0\rangle \mapsto |i\rangle_n |i \geq L\rangle
+
+    This operation is based on two's complement implementation of binary subtraction but only
+    uses carry bits and no actual result bits. If the most significant carry bit
+    (the results bit) is 1, the :math:`\geq` condition is ``True`` otherwise it is ``False``.
+    """
+
+    def __init__(
+        self,
+        num_state_qubits: int | None = None,
+        value: int | None = None,
+        geq: bool = True,
+        name: str = "cmp",
+    ) -> None:
+        """Create a new fixed value comparator circuit.
+
+        Args:
+            num_state_qubits: Number of state qubits. If this is set it will determine the number
+                of qubits required for the circuit.
+            value: The fixed value to compare with.
+            geq: If True, evaluate a ``>=`` condition, else ``<``.
+            name: Name of the circuit.
+        """
+        super().__init__(name=name)
+
+        self._value = None
+        self._geq = None
+        self._num_state_qubits = None
+
+        self.value = value
+        self.geq = geq
+        self.num_state_qubits = num_state_qubits
+
+    @property
+    def value(self) -> int:
+        """The value to compare the qubit register to.
+
+        Returns:
+            The value against which the value of the qubit register is compared.
+        """
+        return self._value
+
+    @value.setter
+    def value(self, value: int) -> None:
+        if value != self._value:
+            self._invalidate()
+            self._value = value
+
+    @property
+    def geq(self) -> bool:
+        """Return whether the comparator compares greater or less equal.
+
+        Returns:
+            True, if the comparator compares ``>=``, False if ``<``.
+        """
+        return self._geq
+
+    @geq.setter
+    def geq(self, geq: bool) -> None:
+        """Set whether the comparator compares greater or less equal.
+
+        Args:
+            geq: If True, the comparator compares ``>=``, if False ``<``.
+        """
+        if geq != self._geq:
+            self._invalidate()
+            self._geq = geq
+
+    @property
+    def num_state_qubits(self) -> int:
+        """The number of qubits encoding the state for the comparison.
+
+        Returns:
+            The number of state qubits.
+        """
+        return self._num_state_qubits
+
+    @num_state_qubits.setter
+    def num_state_qubits(self, num_state_qubits: int | None) -> None:
+        """Set the number of state qubits.
+
+        Note that this will change the quantum registers.
+
+        Args:
+            num_state_qubits: The new number of state qubits.
+        """
+        if self._num_state_qubits is None or num_state_qubits != self._num_state_qubits:
+            self._invalidate()  # reset data
+            self._num_state_qubits = num_state_qubits
+
+            if num_state_qubits is not None:
+                # set the new qubit registers
+                qr_state = QuantumRegister(num_state_qubits, name="state")
+                q_compare = QuantumRegister(1, name="compare")
+
+                self.qregs = [qr_state, q_compare]
+
+                # add ancillas is required
+                num_ancillas = num_state_qubits - 1
+                if num_ancillas > 0:
+                    qr_ancilla = AncillaRegister(num_ancillas)
+                    self.add_register(qr_ancilla)
+
+    def _get_twos_complement(self) -> list[int]:
+        """Returns the 2's complement of ``self.value`` as array.
+
+        Returns:
+             The 2's complement of ``self.value``.
+        """
+        twos_complement = pow(2, self.num_state_qubits) - math.ceil(self.value)
+        twos_complement = f"{twos_complement:b}".rjust(self.num_state_qubits, "0")
+        twos_complement = [
+            1 if twos_complement[i] == "1" else 0 for i in reversed(range(len(twos_complement)))
+        ]
+        return twos_complement
+
+    def _check_configuration(self, raise_on_failure: bool = True) -> bool:
+        """Check if the current configuration is valid."""
+        valid = True
+
+        if self._num_state_qubits is None:
+            valid = False
+            if raise_on_failure:
+                raise AttributeError("Number of state qubits is not set.")
+
+        if self._value is None:
+            valid = False
+            if raise_on_failure:
+                raise AttributeError("No comparison value set.")
+
+        required_num_qubits = 2 * self.num_state_qubits
+        if self.num_qubits != required_num_qubits:
+            valid = False
+            if raise_on_failure:
+                raise CircuitError("Number of qubits does not match required number of qubits.")
+
+        return valid
+
+    def _build(self) -> None:
+        """If not already built, build the circuit."""
+        if self._is_built:
+            return
+
+        super()._build()
+
+        qr_state = self.qubits[: self.num_state_qubits]
+        q_compare = self.qubits[self.num_state_qubits]
+        qr_ancilla = self.qubits[self.num_state_qubits + 1 :]
+
+        circuit = QuantumCircuit(*self.qregs, name=self.name)
+
+        if self.value <= 0:  # condition always satisfied for non-positive values
+            if self._geq:  # otherwise the condition is never satisfied
+                circuit.x(q_compare)
+        # condition never satisfied for values larger than or equal to 2^n
+        elif self.value < pow(2, self.num_state_qubits):
+
+            if self.num_state_qubits > 1:
+                twos = self._get_twos_complement()
+                for i in range(self.num_state_qubits):
+                    if i == 0:
+                        if twos[i] == 1:
+                            circuit.cx(qr_state[i], qr_ancilla[i])
+                    elif i < self.num_state_qubits - 1:
+                        if twos[i] == 1:
+                            circuit.compose(
+                                OR(2), [qr_state[i], qr_ancilla[i - 1], qr_ancilla[i]], inplace=True
+                            )
+                        else:
+                            circuit.ccx(qr_state[i], qr_ancilla[i - 1], qr_ancilla[i])
+                    else:
+                        if twos[i] == 1:
+                            # OR needs the result argument as qubit not register, thus
+                            # access the index [0]
+                            circuit.compose(
+                                OR(2), [qr_state[i], qr_ancilla[i - 1], q_compare], inplace=True
+                            )
+                        else:
+                            circuit.ccx(qr_state[i], qr_ancilla[i - 1], q_compare)
+
+                # flip result bit if geq flag is false
+                if not self._geq:
+                    circuit.x(q_compare)
+
+                # uncompute ancillas state
+                for i in reversed(range(self.num_state_qubits - 1)):
+                    if i == 0:
+                        if twos[i] == 1:
+                            circuit.cx(qr_state[i], qr_ancilla[i])
+                    else:
+                        if twos[i] == 1:
+                            circuit.compose(
+                                OR(2), [qr_state[i], qr_ancilla[i - 1], qr_ancilla[i]], inplace=True
+                            )
+                        else:
+                            circuit.ccx(qr_state[i], qr_ancilla[i - 1], qr_ancilla[i])
+            else:
+
+                # num_state_qubits == 1 and value == 1:
+                circuit.cx(qr_state[0], q_compare)
+
+                # flip result bit if geq flag is false
+                if not self._geq:
+                    circuit.x(q_compare)
+
+        else:
+            if not self._geq:  # otherwise the condition is never satisfied
+                circuit.x(q_compare)
+
+        self.append(circuit.to_gate(), self.qubits)

qiskit/circuit/library/arithmetic/linear_amplitude_function.py

@@ -0,0 +1,196 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2021.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""A class implementing a (piecewise-) linear function on qubit amplitudes."""
+
+from __future__ import annotations
+import numpy as np
+from qiskit.circuit import QuantumCircuit
+
+from .piecewise_linear_pauli_rotations import PiecewiseLinearPauliRotations
+
+
+class LinearAmplitudeFunction(QuantumCircuit):
+    r"""A circuit implementing a (piecewise) linear function on qubit amplitudes.
+
+    An amplitude function :math:`F` of a function :math:`f` is a mapping
+
+    .. math::
+
+        F|x\rangle|0\rangle = \sqrt{1 - \hat{f}(x)} |x\rangle|0\rangle + \sqrt{\hat{f}(x)}
+            |x\rangle|1\rangle.
+
+    for a function :math:`\hat{f}: \{ 0, ..., 2^n - 1 \} \rightarrow [0, 1]`, where
+    :math:`|x\rangle` is a :math:`n` qubit state.
+
+    This circuit implements :math:`F` for piecewise linear functions :math:`\hat{f}`.
+    In this case, the mapping :math:`F` can be approximately implemented using a Taylor expansion
+    and linearly controlled Pauli-Y rotations, see [1, 2] for more detail. This approximation
+    uses a ``rescaling_factor`` to determine the accuracy of the Taylor expansion.
+
+    In general, the function of interest :math:`f` is defined from some interval :math:`[a,b]`,
+    the ``domain`` to :math:`[c,d]`, the ``image``, instead of :math:`\{ 1, ..., N \}` to
+    :math:`[0, 1]`. Using an affine transformation we can rescale :math:`f` to :math:`\hat{f}`:
+
+    .. math::
+
+        \hat{f}(x) = \frac{f(\phi(x)) - c}{d - c}
+
+    with
+
+    .. math::
+
+        \phi(x) = a + \frac{b - a}{2^n - 1} x.
+
+    If :math:`f` is a piecewise linear function on :math:`m` intervals
+    :math:`[p_{i-1}, p_i], i \in \{1, ..., m\}` with slopes :math:`\alpha_i` and
+    offsets :math:`\beta_i` it can be written as
+
+    .. math::
+
+        f(x) = \sum_{i=1}^m 1_{[p_{i-1}, p_i]}(x) (\alpha_i x + \beta_i)
+
+    where :math:`1_{[a, b]}` is an indication function that is 1 if the argument is in the interval
+    :math:`[a, b]` and otherwise 0. The breakpoints :math:`p_i` can be specified by the
+    ``breakpoints`` argument.
+
+    References:
+
+        [1]: Woerner, S., & Egger, D. J. (2018).
+             Quantum Risk Analysis.
+             `arXiv:1806.06893 <http://arxiv.org/abs/1806.06893>`_
+
+        [2]: Gacon, J., Zoufal, C., & Woerner, S. (2020).
+             Quantum-Enhanced Simulation-Based Optimization.
+             `arXiv:2005.10780 <http://arxiv.org/abs/2005.10780>`_
+    """
+
+    def __init__(
+        self,
+        num_state_qubits: int,
+        slope: float | list[float],
+        offset: float | list[float],
+        domain: tuple[float, float],
+        image: tuple[float, float],
+        rescaling_factor: float = 1,
+        breakpoints: list[float] | None = None,
+        name: str = "F",
+    ) -> None:
+        r"""
+        Args:
+            num_state_qubits: The number of qubits used to encode the variable :math:`x`.
+            slope: The slope of the linear function. Can be a list of slopes if it is a piecewise
+                linear function.
+            offset: The offset of the linear function. Can be a list of offsets if it is a piecewise
+                linear function.
+            domain: The domain of the function as tuple :math:`(x_\min{}, x_\max{})`.
+            image: The image of the function as tuple :math:`(f_\min{}, f_\max{})`.
+            rescaling_factor: The rescaling factor to adjust the accuracy in the Taylor
+                approximation.
+            breakpoints: The breakpoints if the function is piecewise linear. If None, the function
+                is not piecewise.
+            name: Name of the circuit.
+        """
+        if not hasattr(slope, "__len__"):
+            slope = [slope]
+        if not hasattr(offset, "__len__"):
+            offset = [offset]
+
+        # ensure that the breakpoints include the first point of the domain
+        if breakpoints is None:
+            breakpoints = [domain[0]]
+        else:
+            if not np.isclose(breakpoints[0], domain[0]):
+                breakpoints = [domain[0]] + breakpoints
+
+        _check_sizes_match(slope, offset, breakpoints)
+        _check_sorted_and_in_range(breakpoints, domain)
+
+        self._domain = domain
+        self._image = image
+        self._rescaling_factor = rescaling_factor
+
+        # do rescaling
+        a, b = domain
+        c, d = image
+
+        mapped_breakpoints = []
+        mapped_slope = []
+        mapped_offset = []
+        for i, point in enumerate(breakpoints):
+            mapped_breakpoint = (point - a) / (b - a) * (2**num_state_qubits - 1)
+            mapped_breakpoints += [mapped_breakpoint]
+
+            # factor (upper - lower) / (2^n - 1) is for the scaling of x to [l,u]
+            # note that the +l for mapping to [l,u] is already included in
+            # the offsets given as parameters
+            mapped_slope += [slope[i] * (b - a) / (2**num_state_qubits - 1)]
+            mapped_offset += [offset[i]]
+
+        # approximate linear behavior by scaling and contracting around pi/4
+        slope_angles = np.zeros(len(breakpoints))
+        offset_angles = np.pi / 4 * (1 - rescaling_factor) * np.ones(len(breakpoints))
+        for i in range(len(breakpoints)):
+            slope_angles[i] = np.pi * rescaling_factor * mapped_slope[i] / 2 / (d - c)
+            offset_angles[i] += np.pi * rescaling_factor * (mapped_offset[i] - c) / 2 / (d - c)
+
+        # use PWLPauliRotations to implement the function
+        pwl_pauli_rotation = PiecewiseLinearPauliRotations(
+            num_state_qubits, mapped_breakpoints, 2 * slope_angles, 2 * offset_angles, name=name
+        )
+
+        super().__init__(*pwl_pauli_rotation.qregs, name=name)
+        self.append(pwl_pauli_rotation.to_gate(), self.qubits)
+
+    def post_processing(self, scaled_value: float) -> float:
+        r"""Map the function value of the approximated :math:`\hat{f}` to :math:`f`.
+
+        Args:
+            scaled_value: A function value from the Taylor expansion of :math:`\hat{f}(x)`.
+
+        Returns:
+            The ``scaled_value`` mapped back to the domain of :math:`f`, by first inverting
+            the transformation used for the Taylor approximation and then mapping back from
+            :math:`[0, 1]` to the original domain.
+        """
+        # revert the mapping applied in the Taylor approximation
+        value = scaled_value - 1 / 2 + np.pi / 4 * self._rescaling_factor
+        value *= 2 / np.pi / self._rescaling_factor
+
+        # map the value from [0, 1] back to the original domain
+        value *= self._image[1] - self._image[0]
+        value += self._image[0]
+
+        return value
+
+
+def _check_sorted_and_in_range(breakpoints, domain):
+    if breakpoints is None:
+        return
+
+    # check if sorted
+    if not np.all(np.diff(breakpoints) > 0):
+        raise ValueError("Breakpoints must be unique and sorted.")
+
+    if breakpoints[0] < domain[0] or breakpoints[-1] > domain[1]:
+        raise ValueError("Breakpoints must be included in domain.")
+
+
+def _check_sizes_match(slope, offset, breakpoints):
+    size = len(slope)
+    if len(offset) != size:
+        raise ValueError(f"Size mismatch of slope ({size}) and offset ({len(offset)}).")
+    if breakpoints is not None:
+        if len(breakpoints) != size:
+            raise ValueError(
+                f"Size mismatch of slope ({size}) and breakpoints ({len(breakpoints)})."
+            )

qiskit/circuit/library/arithmetic/linear_pauli_rotations.py

@@ -0,0 +1,189 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2020.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+
+"""Linearly-controlled X, Y or Z rotation."""
+
+from typing import Optional
+
+from qiskit.circuit import QuantumRegister, QuantumCircuit
+from qiskit.circuit.exceptions import CircuitError
+
+from .functional_pauli_rotations import FunctionalPauliRotations
+
+
+class LinearPauliRotations(FunctionalPauliRotations):
+    r"""Linearly-controlled X, Y or Z rotation.
+
+    For a register of state qubits :math:`|x\rangle`, a target qubit :math:`|0\rangle` and the
+    basis ``'Y'`` this circuit acts as:
+
+    .. parsed-literal::
+
+            q_0: ─────────────────────────■───────── ... ──────────────────────
+                                          │
+                                          .
+                                          │
+        q_(n-1): ─────────────────────────┼───────── ... ───────────■──────────
+                  ┌────────────┐  ┌───────┴───────┐       ┌─────────┴─────────┐
+            q_n: ─┤ RY(offset) ├──┤ RY(2^0 slope) ├  ...  ┤ RY(2^(n-1) slope) ├
+                  └────────────┘  └───────────────┘       └───────────────────┘
+
+    This can for example be used to approximate linear functions, with :math:`a =` ``slope``:math:`/2`
+    and :math:`b =` ``offset``:math:`/2` and the basis ``'Y'``:
+
+    .. math::
+
+        |x\rangle |0\rangle \mapsto \cos(ax + b)|x\rangle|0\rangle + \sin(ax + b)|x\rangle |1\rangle
+
+    Since for small arguments :math:`\sin(x) \approx x` this operator can be used to approximate
+    linear functions.
+    """
+
+    def __init__(
+        self,
+        num_state_qubits: Optional[int] = None,
+        slope: float = 1,
+        offset: float = 0,
+        basis: str = "Y",
+        name: str = "LinRot",
+    ) -> None:
+        r"""Create a new linear rotation circuit.
+
+        Args:
+            num_state_qubits: The number of qubits representing the state :math:`|x\rangle`.
+            slope: The slope of the controlled rotation.
+            offset: The offset of the controlled rotation.
+            basis: The type of Pauli rotation ('X', 'Y', 'Z').
+            name: The name of the circuit object.
+        """
+        super().__init__(num_state_qubits=num_state_qubits, basis=basis, name=name)
+
+        # define internal parameters
+        self._slope = None
+        self._offset = None
+
+        # store parameters
+        self.slope = slope
+        self.offset = offset
+
+    @property
+    def slope(self) -> float:
+        """The multiplicative factor in the rotation angle of the controlled rotations.
+
+        The rotation angles are ``slope * 2^0``, ``slope * 2^1``, ... , ``slope * 2^(n-1)`` where
+        ``n`` is the number of state qubits.
+
+        Returns:
+            The rotation angle common in all controlled rotations.
+        """
+        return self._slope
+
+    @slope.setter
+    def slope(self, slope: float) -> None:
+        """Set the multiplicative factor of the rotation angles.
+
+        Args:
+            The slope of the rotation angles.
+        """
+        if self._slope is None or slope != self._slope:
+            self._invalidate()
+            self._slope = slope
+
+    @property
+    def offset(self) -> float:
+        """The angle of the single qubit offset rotation on the target qubit.
+
+        Before applying the controlled rotations, a single rotation of angle ``offset`` is
+        applied to the target qubit.
+
+        Returns:
+            The offset angle.
+        """
+        return self._offset
+
+    @offset.setter
+    def offset(self, offset: float) -> None:
+        """Set the angle for the offset rotation on the target qubit.
+
+        Args:
+            offset: The offset rotation angle.
+        """
+        if self._offset is None or offset != self._offset:
+            self._invalidate()
+            self._offset = offset
+
+    def _reset_registers(self, num_state_qubits: Optional[int]) -> None:
+        """Set the number of state qubits.
+
+        Note that this changes the underlying quantum register, if the number of state qubits
+        changes.
+
+        Args:
+            num_state_qubits: The new number of qubits.
+        """
+        self.qregs = []
+
+        if num_state_qubits:
+            # set new register of appropriate size
+            qr_state = QuantumRegister(num_state_qubits, name="state")
+            qr_target = QuantumRegister(1, name="target")
+            self.qregs = [qr_state, qr_target]
+
+    def _check_configuration(self, raise_on_failure: bool = True) -> bool:
+        """Check if the current configuration is valid."""
+        valid = True
+
+        if self.num_state_qubits is None:
+            valid = False
+            if raise_on_failure:
+                raise AttributeError("The number of qubits has not been set.")
+
+        if self.num_qubits < self.num_state_qubits + 1:
+            valid = False
+            if raise_on_failure:
+                raise CircuitError(
+                    "Not enough qubits in the circuit, need at least "
+                    f"{self.num_state_qubits + 1}."
+                )
+
+        return valid
+
+    def _build(self):
+        """If not already built, build the circuit."""
+        if self._is_built:
+            return
+
+        super()._build()
+
+        circuit = QuantumCircuit(*self.qregs, name=self.name)
+
+        # build the circuit
+        qr_state = self.qubits[: self.num_state_qubits]
+        qr_target = self.qubits[self.num_state_qubits]
+
+        if self.basis == "x":
+            circuit.rx(self.offset, qr_target)
+        elif self.basis == "y":
+            circuit.ry(self.offset, qr_target)
+        else:  # 'Z':
+            circuit.rz(self.offset, qr_target)
+
+        for i, q_i in enumerate(qr_state):
+            if self.basis == "x":
+                circuit.crx(self.slope * pow(2, i), q_i, qr_target)
+            elif self.basis == "y":
+                circuit.cry(self.slope * pow(2, i), q_i, qr_target)
+            else:  # 'Z'
+                circuit.crz(self.slope * pow(2, i), q_i, qr_target)
+
+        self.append(circuit.to_gate(), self.qubits)

qiskit/circuit/library/arithmetic/multipliers/__init__.py

@@ -0,0 +1,16 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2021.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""The multiplier circuit library."""
+
+from .hrs_cumulative_multiplier import HRSCumulativeMultiplier
+from .rg_qft_multiplier import RGQFTMultiplier