qiskit 2.1.0rc1__cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

qiskit/circuit/library/generalized_gates/permutation.py

@@ -0,0 +1,202 @@
+# 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.
+
+"""Permutation circuit (the old way to specify permutations, which is required for
+backward compatibility and which will be eventually deprecated) and the permutation
+gate (the new way to specify permutations, allowing a variety of synthesis algorithms).
+"""
+
+from __future__ import annotations
+
+import numpy as np
+
+from qiskit.circuit.quantumcircuit import QuantumCircuit
+from qiskit.circuit.quantumcircuit import Gate
+from qiskit.circuit.exceptions import CircuitError
+from qiskit.utils.deprecation import deprecate_func
+
+
+class Permutation(QuantumCircuit):
+    """An n_qubit circuit that permutes qubits."""
+
+    @deprecate_func(
+        since="2.1",
+        additional_msg="Use PermutationGate instead.",
+        removal_timeline="in Qiskit 3.0",
+    )
+    def __init__(
+        self,
+        num_qubits: int,
+        pattern: list[int] | np.ndarray | None = None,
+        seed: int | None = None,
+    ) -> None:
+        """Return an n_qubit permutation circuit implemented using SWAPs.
+
+        Args:
+            num_qubits: circuit width.
+            pattern: permutation pattern, describing which qubits occupy the
+                positions 0, 1, 2, etc. after applying the permutation, that
+                is ``pattern[k] = m`` when the permutation maps qubit ``m``
+                to position ``k``. As an example, the pattern ``[2, 4, 3, 0, 1]``
+                means that qubit ``2`` goes to position ``0``, qubit ``4``
+                goes to the position ``1``, etc. The pattern can also be ``None``,
+                in which case a random permutation over ``num_qubits`` is
+                created.
+            seed: random seed in case a random permutation is requested.
+
+        Raises:
+            CircuitError: if permutation pattern is malformed.
+
+        Reference Circuit:
+            .. plot::
+               :alt: Diagram illustrating the previously described circuit.
+
+               from qiskit.circuit.library import Permutation
+               A = [2,4,3,0,1]
+               circuit = Permutation(5, A)
+               circuit.draw('mpl')
+
+        Expanded Circuit:
+            .. plot::
+               :alt: Diagram illustrating the previously described circuit.
+
+               from qiskit.circuit.library import Permutation
+               from qiskit.visualization.library import _generate_circuit_library_visualization
+               A = [2,4,3,0,1]
+               circuit = Permutation(5, A)
+               _generate_circuit_library_visualization(circuit.decompose())
+        """
+        if pattern is not None:
+            if sorted(pattern) != list(range(num_qubits)):
+                raise CircuitError(
+                    "Permutation pattern must be some ordering of 0..num_qubits-1 in a list."
+                )
+            pattern = np.array(pattern)
+        else:
+            rng = np.random.default_rng(seed)
+            pattern = np.arange(num_qubits)
+            rng.shuffle(pattern)
+
+        name = "permutation_" + np.array_str(pattern).replace(" ", ",")
+
+        super().__init__(num_qubits, name=name)
+
+        # pylint: disable=cyclic-import
+        from qiskit.synthesis.permutation import synth_permutation_basic
+
+        circuit = synth_permutation_basic(pattern)
+        circuit.name = name
+
+        all_qubits = self.qubits
+        self.append(circuit.to_gate(), all_qubits)
+
+
+class PermutationGate(Gate):
+    """A gate that permutes qubits."""
+
+    def __init__(
+        self,
+        pattern: list[int],
+    ) -> None:
+        """Return a permutation gate.
+
+        Args:
+            pattern: permutation pattern, describing which qubits occupy the
+                positions 0, 1, 2, etc. after applying the permutation, that
+                is ``pattern[k] = m`` when the permutation maps qubit ``m``
+                to position ``k``. As an example, the pattern ``[2, 4, 3, 0, 1]``
+                means that qubit ``2`` goes to position ``0``, qubit ``4``
+                goes to the position ``1``, etc.
+
+        Raises:
+            CircuitError: if permutation pattern is malformed.
+
+        Reference Circuit:
+            .. plot::
+               :alt: Diagram illustrating the previously described circuit.
+
+                from qiskit.circuit.quantumcircuit import QuantumCircuit
+                from qiskit.circuit.library import PermutationGate
+                A = [2, 4, 3, 0, 1]
+                permutation = PermutationGate(A)
+                circuit = QuantumCircuit(5)
+                circuit.append(permutation, [0, 1, 2, 3, 4])
+                circuit.draw("mpl")
+
+        Expanded Circuit:
+            .. plot::
+               :alt: Diagram illustrating the previously described circuit.
+
+                from qiskit.circuit.quantumcircuit import QuantumCircuit
+                from qiskit.circuit.library import PermutationGate
+                from qiskit.visualization.library import _generate_circuit_library_visualization
+                A = [2, 4, 3, 0, 1]
+                permutation = PermutationGate(A)
+                circuit = QuantumCircuit(5)
+                circuit.append(permutation, [0, 1, 2, 3, 4])
+
+                _generate_circuit_library_visualization(circuit.decompose())
+        """
+        num_qubits = len(pattern)
+        if sorted(pattern) != list(range(num_qubits)):
+            raise CircuitError(
+                "Permutation pattern must be some ordering of 0..num_qubits-1 in a list."
+            )
+        pattern = np.array(pattern, dtype=np.int32)
+
+        super().__init__(name="permutation", num_qubits=num_qubits, params=[pattern])
+
+    def __array__(self, dtype=None, copy=None):
+        """Return a numpy.array for the Permutation gate."""
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+
+        nq = len(self.pattern)
+        mat = np.zeros((2**nq, 2**nq), dtype=dtype)
+
+        for r in range(2**nq):
+            # convert row to bitstring, reverse, apply permutation pattern, reverse again,
+            # and convert to row
+            bit = bin(r)[2:].zfill(nq)[::-1]
+            permuted_bit = "".join([bit[j] for j in self.pattern])
+            pr = int(permuted_bit[::-1], 2)
+            mat[pr, r] = 1
+
+        return mat
+
+    def validate_parameter(self, parameter):
+        """Parameter validation."""
+        return parameter
+
+    @property
+    def pattern(self) -> np.ndarray[bool]:
+        """Returns the permutation pattern defining this permutation."""
+        return self.params[0]
+
+    def inverse(self, annotated: bool = False) -> PermutationGate:
+        """Returns the inverse of the permutation."""
+
+        # pylint: disable=cyclic-import
+        from qiskit.synthesis.permutation.permutation_utils import _inverse_pattern
+
+        return PermutationGate(pattern=_inverse_pattern(self.pattern))
+
+    def _qasm_decomposition(self):
+        # pylint: disable=cyclic-import
+        from qiskit.synthesis.permutation import synth_permutation_basic
+
+        name = f"permutation__{'_'.join(str(n) for n in self.pattern)}_"
+
+        out = synth_permutation_basic(self.pattern)
+        out.name = name
+
+        return out.to_gate()

qiskit/circuit/library/generalized_gates/rv.py

@@ -0,0 +1,96 @@
+# 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.
+
+"""Rotation around an arbitrary axis on the Bloch sphere."""
+
+import math
+import numpy
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.exceptions import CircuitError
+
+
+class RVGate(Gate):
+    r"""Rotation around arbitrary rotation axis :math:`\vec{v}` where :math:`\|\vec{v}\|_2` is
+    angle of rotation in radians.
+
+    Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
+    with the :meth:`~qiskit.circuit.QuantumCircuit.rv` method.
+
+    **Circuit symbol:**
+
+    .. code-block:: text
+
+             ┌─────────────────┐
+        q_0: ┤ RV(v_x,v_y,v_z) ├
+             └─────────────────┘
+
+    **Matrix Representation:**
+
+    .. math::
+
+        \newcommand{\rotationangle}{\frac{\|\vec{v}\|_2}{2}}
+            R(\vec{v}) = e^{-i \vec{v}\cdot\vec{\sigma} / 2} =
+                \begin{pmatrix}
+                    \cos\left(\rotationangle\right)
+                    -i \frac{v_z}{\|\vec{v}\|_2} \sin\left(\rotationangle\right)
+                    & -(i \frac{v_x}{\|\vec{v}\|_2}
+                    + \frac{v_y}{\|\vec{v}\|_2}) \sin\left(\rotationangle\right) \\
+                    -(i \frac{v_x}{\|\vec{v}\|_2}
+                    - \frac{v_y}{\|\vec{v}\|_2}) \sin\left(\rotationangle\right)
+                    & \cos\left(\rotationangle\right)
+                    + i \frac{v_z}{\|\vec{v}\|_2} \sin\left(\rotationangle\right)
+                \end{pmatrix}
+    """
+
+    def __init__(self, v_x: float, v_y: float, v_z: float, basis: str = "U"):
+        """
+        Args:
+            v_x: x-component
+            v_y: y-component
+            v_z: z-component
+            basis: basis (see
+                :class:`~qiskit.synthesis.one_qubit.one_qubit_decompose.OneQubitEulerDecomposer`)
+        """
+        # pylint: disable=cyclic-import
+        from qiskit.synthesis.one_qubit.one_qubit_decompose import OneQubitEulerDecomposer
+
+        super().__init__("rv", 1, [v_x, v_y, v_z])
+        self._decomposer = OneQubitEulerDecomposer(basis=basis)
+
+    def _define(self):
+        try:
+            self.definition = self._decomposer(self.to_matrix())
+        except TypeError as ex:
+            raise CircuitError(
+                f"The {self.name} gate cannot be decomposed with unbound parameters"
+            ) from ex
+
+    def inverse(self, annotated: bool = False):
+        """Invert this gate."""
+        vx, vy, vz = self.params
+        return RVGate(-vx, -vy, -vz)
+
+    def to_matrix(self) -> numpy.ndarray:
+        """Return a numpy.array for the R(v) gate."""
+        v = numpy.asarray(self.params, dtype=float)
+        angle = math.sqrt(v.dot(v))
+        if angle == 0:
+            return numpy.array([[1, 0], [0, 1]])
+        nx, ny, nz = v / angle
+        sin = math.sin(angle / 2)
+        cos = math.cos(angle / 2)
+        return numpy.array(
+            [
+                [cos - 1j * nz * sin, (-ny - 1j * nx) * sin],
+                [(ny - 1j * nx) * sin, cos + 1j * nz * sin],
+            ]
+        )

qiskit/circuit/library/generalized_gates/uc.py

@@ -0,0 +1,303 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2020, 2024.
+#
+# 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 structure of the code is based on Emanuel Malvetti's semester thesis at
+# ETH in 2018, which was supervised by Raban Iten and Prof. Renato Renner.
+
+# pylint: disable=invalid-name
+# pylint: disable=missing-param-doc
+# pylint: disable=missing-type-doc
+
+"""Uniformly controlled gates (also called multiplexed gates)."""
+
+from __future__ import annotations
+
+import math
+
+import numpy as np
+
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.library.standard_gates.h import HGate
+from qiskit.quantum_info.operators.predicates import is_unitary_matrix
+from qiskit.circuit import QuantumRegister
+from qiskit.circuit.quantumcircuit import QuantumCircuit
+from qiskit.circuit.exceptions import CircuitError
+from qiskit.exceptions import QiskitError
+from qiskit._accelerate import uc_gate
+
+from .diagonal import DiagonalGate
+
+_EPS = 1e-10  # global variable used to chop very small numbers to zero
+
+
+class UCGate(Gate):
+    r"""Uniformly controlled gate (also called multiplexed gate).
+
+    These gates can have several control qubits and a single target qubit.
+    If the k control qubits are in the state :math:`|i\rangle` (in the computational basis),
+    a single-qubit unitary :math:`U_i` is applied to the target qubit.
+
+    This gate is represented by a block-diagonal matrix, where each block is a
+    :math:`2\times 2` unitary, that is
+
+    .. math::
+
+        \begin{pmatrix}
+            U_0 & 0 & \cdots & 0 \\
+            0 & U_1 & \cdots & 0 \\
+            \vdots  &     & \ddots & \vdots \\
+            0 & 0   &  \cdots & U_{2^{k-1}}
+        \end{pmatrix}.
+
+    The decomposition is based on Ref. [1].
+
+    Unnecessary controls and repeated operators can be removed as described in Ref [2].
+
+    **References:**
+
+    [1] Bergholm et al., Quantum circuits with uniformly controlled one-qubit gates (2005).
+        `Phys. Rev. A 71, 052330 <https://journals.aps.org/pra/abstract/10.1103/PhysRevA.71.052330>`__.
+
+    [2] de Carvalho et al., Quantum multiplexer simplification for state preparation (2024).
+        `arXiv:2409.05618 <https://arxiv.org/abs/2409.05618>`__.
+
+    """
+
+    def __init__(
+        self, gate_list: list[np.ndarray], up_to_diagonal: bool = False, mux_simp: bool = True
+    ):
+        r"""
+        Args:
+            gate_list: List of two qubit unitaries :math:`[U_0, ..., U_{2^{k-1}}]`, where each
+                single-qubit unitary :math:`U_i` is given as a :math:`2 \times 2` numpy array.
+            up_to_diagonal: Determines if the gate is implemented up to a diagonal.
+                or if it is decomposed completely (default: False).
+                If the ``UCGate`` :math:`U` is decomposed up to a diagonal :math:`D`, this means
+                that the circuit implements a unitary :math:`U'` such that :math:`D U' = U`.
+            mux_simp: Determines whether the search for repetitions is conducted (default: True).
+                The intention is to perform a possible simplification in the number of controls
+                and operators.
+
+        Raises:
+            QiskitError: in case of bad input to the constructor
+        """
+        # check input format
+        if not isinstance(gate_list, list):
+            raise QiskitError("The single-qubit unitaries are not provided in a list.")
+        for gate in gate_list:
+            if not gate.shape == (2, 2):
+                raise QiskitError("The dimension of a controlled gate is not equal to (2,2).")
+        if not gate_list:
+            raise QiskitError("The gate list cannot be empty.")
+
+        # Check if number of gates in gate_list is a positive power of two
+        num_contr = math.log2(len(gate_list))
+        if num_contr < 0 or not num_contr.is_integer():
+            raise QiskitError(
+                "The number of controlled single-qubit gates is not a non-negative power of 2."
+            )
+
+        # Check if the single-qubit gates are unitaries
+        for gate in gate_list:
+            if not is_unitary_matrix(gate, _EPS):
+                raise QiskitError("A controlled gate is not unitary.")
+
+        new_controls = set()
+        if mux_simp:
+            new_controls, gate_list = self._simplify(gate_list, num_contr)
+        self.simp_contr = (mux_simp, new_controls)
+
+        # Create new gate.
+        super().__init__("multiplexer", int(num_contr) + 1, gate_list)
+        self.up_to_diagonal = up_to_diagonal
+
+    def _simplify(self, gate_list, num_contr):
+        """https://arxiv.org/abs/2409.05618"""
+
+        c = set()
+        nc = set()
+        mux_copy = gate_list.copy()
+
+        for i in range(int(num_contr)):
+            c.add(i + 1)
+
+        if len(gate_list) > 1:
+            nc, mux_copy = self._repetition_search(gate_list, num_contr, mux_copy)
+
+        new_controls = {x for x in c if x not in nc}
+        new_mux = [gate for gate in mux_copy if gate is not None]
+        return new_controls, new_mux
+
+    def _repetition_search(self, mux, level, mux_copy):
+        nc = set()
+        d = 1
+        while d <= len(mux) / 2:
+            disentanglement = False
+            if np.allclose(mux[d], mux[0]):
+                mux_org = mux_copy.copy()
+                repetitions = len(mux) / (2 * d)
+                p = 0
+                while repetitions > 0:
+                    repetitions -= 1
+                    valid, mux_copy = self._repetition_verify(p, d, mux, mux_copy)
+                    p = p + 2 * d
+                    if not valid:
+                        mux_copy = mux_org
+                        break
+                    if repetitions == 0:
+                        disentanglement = True
+
+            if disentanglement:
+                removed_contr = level - math.log2(d)
+                nc.add(removed_contr)
+            d = 2 * d
+        return nc, mux_copy
+
+    def _repetition_verify(self, base, d, mux, mux_copy):
+        i = 0
+        next_base = base + d
+        while i < d:
+            if not np.allclose(mux[base], mux[next_base]):
+                return False, mux_copy
+            mux_copy[next_base] = None
+            base, next_base, i = base + 1, next_base + 1, i + 1
+        return True, mux_copy
+
+    def inverse(self, annotated: bool = False) -> Gate:
+        """Return the inverse.
+
+        This does not re-compute the decomposition for the multiplexer with the inverse of the
+        gates but simply inverts the existing decomposition.
+        """
+        if not annotated:
+            inverse_gate = Gate(
+                name=self.name + "_dg", num_qubits=self.num_qubits, params=[]
+            )  # removing the params because arrays are deprecated
+
+            definition = QuantumCircuit(*self.definition.qregs)
+            for inst in reversed(self._definition):
+                definition._append(
+                    inst.replace(operation=inst.operation.inverse(annotated=annotated))
+                )
+
+            definition.global_phase = -self.definition.global_phase
+
+            inverse_gate.definition = definition
+        else:
+            inverse_gate = super().inverse(annotated=annotated)
+        return inverse_gate
+
+    def _get_diagonal(self):
+        # Important: for a control list q_controls = [q[0],...,q_[k-1]] the
+        # diagonal gate is provided in the computational basis of the qubits
+        # q[k-1],...,q[0],q_target, decreasingly ordered with respect to the
+        # significance of the qubit in the computational basis
+        _, diag = self._dec_ucg()
+        if self.simp_contr[1]:
+            q_controls = [self.num_qubits - i for i in self.simp_contr[1]]
+            q_controls.reverse()
+            for i in range(self.num_qubits):
+                if i not in [0] + q_controls:
+                    d = 2**i
+                    new_diag = []
+                    n = len(diag)
+                    for j in range(n):
+                        new_diag.append(diag[j])
+                        if (j + 1) % d == 0:
+                            new_diag.extend(diag[j + 1 - d : j + 1])
+                    diag = np.array(new_diag)
+        return diag
+
+    def _define(self):
+        ucg_circuit, _ = self._dec_ucg()
+        self.definition = ucg_circuit
+
+    def _dec_ucg(self):
+        """
+        Call to create a circuit that implements the uniformly controlled gate. If
+        up_to_diagonal=True, the circuit implements the gate up to a diagonal gate and
+        the diagonal gate is also returned.
+        """
+        diag = np.ones(2**self.num_qubits).tolist()
+        q = QuantumRegister(self.num_qubits, "q")
+        q_target = q[0]
+        mux_simplify = self.simp_contr[0]
+
+        if mux_simplify:
+            q_controls = [q[self.num_qubits - i] for i in self.simp_contr[1]]
+            q_controls.reverse()
+        else:
+            q_controls = q[1:]
+
+        circuit = QuantumCircuit(q, name="uc")
+        # If there is no control, we use the ZYZ decomposition
+        if not q_controls:
+            circuit.unitary(self.params[0], q[0])
+            return circuit, diag
+        # If there is at least one control, first,
+        # we find the single qubit gates of the decomposition.
+        (single_qubit_gates, diag) = self._dec_ucg_help()
+        # Now, it is easy to place the C-NOT gates and some Hadamards and Rz(pi/2) gates
+        # (which are absorbed into the single-qubit unitaries) to get back the full decomposition.
+        for i, gate in enumerate(single_qubit_gates):
+            # Absorb Hadamards and Rz(pi/2) gates
+            if i == 0:
+                squ = HGate().to_matrix().dot(gate)
+            elif i == len(single_qubit_gates) - 1:
+                squ = gate.dot(UCGate._rz(np.pi / 2)).dot(HGate().to_matrix())
+            else:
+                squ = (
+                    HGate()
+                    .to_matrix()
+                    .dot(gate.dot(UCGate._rz(np.pi / 2)))
+                    .dot(HGate().to_matrix())
+                )
+            # Add single-qubit gate
+            circuit.unitary(squ, [q_target])
+            # The number of the control qubit is given by the number of zeros at the end
+            # of the binary representation of (i+1)
+            binary_rep = np.binary_repr(i + 1)
+            num_trailing_zeros = len(binary_rep) - len(binary_rep.rstrip("0"))
+            q_contr_index = num_trailing_zeros
+            # Add C-NOT gate
+            if not i == len(single_qubit_gates) - 1:
+                circuit.cx(q_controls[q_contr_index], q_target)
+                circuit.global_phase -= 0.25 * np.pi
+        if not self.up_to_diagonal:
+            # Important: the diagonal gate is given in the computational basis of the qubits
+            # q[k-1],...,q[0],q_target (ordered with decreasing significance),
+            # where q[i] are the control qubits and t denotes the target qubit.
+            diagonal = DiagonalGate(diag)
+
+            circuit.append(diagonal, [q_target] + q_controls)
+        return circuit, diag
+
+    def _dec_ucg_help(self):
+        """
+        This method finds the single qubit gate arising in the decomposition of UCGates given in
+        https://arxiv.org/pdf/quant-ph/0410066.pdf.
+        """
+        single_qubit_gates = [np.asarray(gate, dtype=complex, order="f") for gate in self.params]
+        if self.simp_contr[0]:
+            return uc_gate.dec_ucg_help(single_qubit_gates, len(self.simp_contr[1]) + 1)
+        return uc_gate.dec_ucg_help(single_qubit_gates, self.num_qubits)
+
+    @staticmethod
+    def _rz(alpha):
+        return np.array([[np.exp(1j * alpha / 2), 0], [0, np.exp(-1j * alpha / 2)]])
+
+    def validate_parameter(self, parameter):
+        """Uniformly controlled gate parameter has to be an ndarray."""
+        if isinstance(parameter, np.ndarray):
+            return parameter
+        else:
+            raise CircuitError(f"invalid param type {type(parameter)} in gate {self.name}")