qiskit 2.0.3__cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

qiskit/circuit/library/standard_gates/xx_minus_yy.py

@@ -0,0 +1,202 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 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.
+
+"""Two-qubit XX-YY gate."""
+
+from __future__ import annotations
+
+import math
+from cmath import exp
+from math import pi
+from typing import Optional
+
+import numpy as np
+
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.library.standard_gates.ry import RYGate
+from qiskit.circuit.library.standard_gates.rz import RZGate
+from qiskit.circuit.library.standard_gates.s import SdgGate, SGate
+from qiskit.circuit.library.standard_gates.sx import SXdgGate, SXGate
+from qiskit.circuit.library.standard_gates.x import CXGate
+from qiskit.circuit.parameterexpression import ParameterValueType, ParameterExpression
+from qiskit.circuit.quantumcircuit import QuantumCircuit
+from qiskit.circuit import QuantumRegister
+from qiskit._accelerate.circuit import StandardGate
+
+
+class XXMinusYYGate(Gate):
+    r"""XX-YY interaction gate.
+
+    A 2-qubit parameterized XX-YY interaction. Its action is to induce
+    a coherent rotation by some angle between :math:`|00\rangle` and :math:`|11\rangle`.
+
+    **Circuit Symbol:**
+
+    .. code-block:: text
+
+             ┌───────────────┐
+        q_0: ┤0              ├
+             │  (XX-YY)(θ,β) │
+        q_1: ┤1              ├
+             └───────────────┘
+
+    **Matrix Representation:**
+
+    .. math::
+
+        \newcommand{\rotationangle}{\frac{\theta}{2}}
+
+        R_{XX-YY}(\theta, \beta) q_0, q_1 =
+          RZ_1(\beta) \cdot \exp\left(-i \frac{\theta}{2} \frac{XX-YY}{2}\right) \cdot RZ_1(-\beta) =
+            \begin{pmatrix}
+                \cos\left(\rotationangle\right) & 0 & 0 & -i\sin\left(\rotationangle\right)e^{-i\beta} \\
+                0 & 1 & 0 & 0 \\
+                0 & 0 & 1 & 0 \\
+                -i\sin\left(\rotationangle\right)e^{i\beta} & 0 & 0 & \cos\left(\rotationangle\right)
+            \end{pmatrix}
+    """
+
+    _standard_gate = StandardGate.XXMinusYYGate
+
+    def __init__(
+        self,
+        theta: ParameterValueType,
+        beta: ParameterValueType = 0,
+        label: Optional[str] = "(XX-YY)",
+    ):
+        """Create new XX-YY gate.
+
+        Args:
+            theta: The rotation angle.
+            beta: The phase angle.
+            label: The label of the gate.
+        """
+        super().__init__("xx_minus_yy", 2, [theta, beta], label=label)
+
+    def _define(self):
+        """
+        gate xx_minus_yy(theta, beta) a, b {
+            rz(-beta) b;
+            rz(-pi/2) a;
+            sx a;
+            rz(pi/2) a;
+            s b;
+            cx a, b;
+            ry(theta/2) a;
+            ry(-theta/2) b;
+            cx a, b;
+            sdg b;
+            rz(-pi/2) a;
+            sxdg a;
+            rz(pi/2) a;
+            rz(beta) b;
+        }
+        """
+        theta, beta = self.params
+        register = QuantumRegister(2, "q")
+        circuit = QuantumCircuit(register, name=self.name)
+        a, b = register
+        rules = [
+            (RZGate(-beta), [b], []),
+            (RZGate(-pi / 2), [a], []),
+            (SXGate(), [a], []),
+            (RZGate(pi / 2), [a], []),
+            (SGate(), [b], []),
+            (CXGate(), [a, b], []),
+            (RYGate(theta / 2), [a], []),
+            (RYGate(-theta / 2), [b], []),
+            (CXGate(), [a, b], []),
+            (SdgGate(), [b], []),
+            (RZGate(-pi / 2), [a], []),
+            (SXdgGate(), [a], []),
+            (RZGate(pi / 2), [a], []),
+            (RZGate(beta), [b], []),
+        ]
+        for instr, qargs, cargs in rules:
+            circuit._append(instr, qargs, cargs)
+
+        self.definition = circuit
+
+    def control(
+        self,
+        num_ctrl_qubits: int = 1,
+        label: str | None = None,
+        ctrl_state: str | int | None = None,
+        annotated: bool | None = None,
+    ):
+        """Return a (multi-)controlled-(XX-YY) gate.
+
+        Args:
+            num_ctrl_qubits: number of control qubits.
+            label: An optional label for the gate [Default: ``None``]
+            ctrl_state: control state expressed as integer,
+                string (e.g.``'110'``), or ``None``. If ``None``, use all 1s.
+            annotated: indicates whether the controlled gate should be implemented
+                as an annotated gate. If ``None``, this is set to ``True`` if
+                the gate contains free parameters, in which case it cannot
+                yet be synthesized.
+
+        Returns:
+            ControlledGate: controlled version of this gate.
+        """
+        if annotated is None:
+            annotated = any(isinstance(p, ParameterExpression) for p in self.params)
+
+        gate = super().control(
+            num_ctrl_qubits=num_ctrl_qubits,
+            label=label,
+            ctrl_state=ctrl_state,
+            annotated=annotated,
+        )
+        return gate
+
+    def inverse(self, annotated: bool = False):
+        """Inverse gate.
+
+        Args:
+            annotated: when set to ``True``, this is typically used to return an
+                :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
+                :class:`.Gate`. However, for this class this argument is ignored as the inverse
+                of this gate is always a :class:`.XXMinusYYGate` with inverse
+                parameter values.
+
+        Returns:
+            XXMinusYYGate: inverse gate.
+        """
+        theta, beta = self.params
+        return XXMinusYYGate(-theta, beta)
+
+    def __array__(self, dtype=None, copy=None):
+        """Gate matrix."""
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        theta, beta = self.params
+        cos = math.cos(theta / 2)
+        sin = math.sin(theta / 2)
+        return np.array(
+            [
+                [cos, 0, 0, -1j * sin * exp(-1j * beta)],
+                [0, 1, 0, 0],
+                [0, 0, 1, 0],
+                [-1j * sin * exp(1j * beta), 0, 0, cos],
+            ],
+            dtype=dtype,
+        )
+
+    def power(self, exponent: float, annotated: bool = False):
+        theta, beta = self.params
+        return XXMinusYYGate(exponent * theta, beta)
+
+    def __eq__(self, other):
+        if isinstance(other, XXMinusYYGate):
+            return self._compare_parameters(other)
+        return False

qiskit/circuit/library/standard_gates/xx_plus_yy.py

@@ -0,0 +1,236 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 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.
+
+"""Two-qubit XX+YY gate."""
+
+from __future__ import annotations
+
+import math
+from cmath import exp
+from math import pi
+from typing import Optional
+
+import numpy
+
+from qiskit.circuit.gate import Gate
+from qiskit.circuit import QuantumRegister
+from qiskit.circuit.parameterexpression import ParameterValueType, ParameterExpression
+from qiskit._accelerate.circuit import StandardGate
+
+
+class XXPlusYYGate(Gate):
+    r"""XX+YY interaction gate.
+
+    A 2-qubit parameterized XX+YY interaction, also known as an XY gate. Its action is to induce
+    a coherent rotation by some angle between :math:`|01\rangle` and :math:`|10\rangle`.
+
+    **Circuit Symbol:**
+
+    .. code-block:: text
+
+             ┌───────────────┐
+        q_0: ┤0              ├
+             │  (XX+YY)(θ,β) │
+        q_1: ┤1              ├
+             └───────────────┘
+
+    **Matrix Representation:**
+
+    .. math::
+
+        \newcommand{\rotationangle}{\frac{\theta}{2}}
+
+        R_{XX+YY}(\theta, \beta)\ q_0, q_1 =
+          RZ_0(-\beta) \cdot \exp\left(-i \frac{\theta}{2} \frac{XX+YY}{2}\right) \cdot RZ_0(\beta) =
+            \begin{pmatrix}
+                1 & 0 & 0 & 0  \\
+                0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right)e^{-i\beta} & 0 \\
+                0 & -i\sin\left(\rotationangle\right)e^{i\beta} & \cos\left(\rotationangle\right) & 0 \\
+                0 & 0 & 0 & 1
+            \end{pmatrix}
+
+    .. note::
+
+        In Qiskit's convention, higher qubit indices are more significant
+        (little endian convention). In the above example we apply the gate
+        on (q_0, q_1) which results in adding the (optional) phase defined
+        by :math:`\beta` on q_0. Instead, if we apply it on (q_1, q_0), the
+        phase is added on q_1. If :math:`\beta` is set to its default value
+        of :math:`0`, the gate is equivalent in big and little endian.
+
+        .. code-block:: text
+
+                 ┌───────────────┐
+            q_0: ┤1              ├
+                 │  (XX+YY)(θ,β) │
+            q_1: ┤0              ├
+                 └───────────────┘
+
+        .. math::
+
+            \newcommand{\rotationangle}{\frac{\theta}{2}}
+
+            R_{XX+YY}(\theta, \beta)\ q_0, q_1 =
+            RZ_1(-\beta) \cdot \exp\left(-i \frac{\theta}{2} \frac{XX+YY}{2}\right) \cdot RZ_1(\beta) =
+                \begin{pmatrix}
+                    1 & 0 & 0 & 0  \\
+                    0 & \cos\left(\rotationangle\right) &
+                    -i\sin\left(\rotationangle\right)e^{i\beta} & 0 \\
+                    0 & -i\sin\left(\rotationangle\right)e^{-i\beta} &
+                    \cos\left(\rotationangle\right) & 0 \\
+                    0 & 0 & 0 & 1
+                \end{pmatrix}
+    """
+
+    _standard_gate = StandardGate.XXPlusYYGate
+
+    def __init__(
+        self,
+        theta: ParameterValueType,
+        beta: ParameterValueType = 0,
+        label: Optional[str] = "(XX+YY)",
+    ):
+        """Create new XX+YY gate.
+
+        Args:
+            theta: The rotation angle.
+            beta: The phase angle.
+            label: The label of the gate.
+        """
+        super().__init__("xx_plus_yy", 2, [theta, beta], label=label)
+
+    def _define(self):
+        """
+        gate xx_plus_yy(theta, beta) a, b {
+            rz(beta) b;
+            rz(-pi/2) a;
+            sx a;
+            rz(pi/2) a;
+            s b;
+            cx a, b;
+            ry(theta/2) a;
+            ry(theta/2) b;
+            cx a, b;
+            sdg b;
+            rz(-pi/2) a;
+            sxdg a;
+            rz(pi/2) a;
+            rz(-beta) b;
+        }
+        """
+        # pylint: disable=cyclic-import
+        from qiskit.circuit.quantumcircuit import QuantumCircuit
+        from .x import CXGate
+        from .s import SGate, SdgGate
+        from .sx import SXGate, SXdgGate
+        from .rz import RZGate
+        from .ry import RYGate
+
+        theta = self.params[0]
+        beta = self.params[1]
+        q = QuantumRegister(2, "q")
+        qc = QuantumCircuit(q, name=self.name)
+        rules = [
+            (RZGate(beta), [q[0]], []),
+            (RZGate(-pi / 2), [q[1]], []),
+            (SXGate(), [q[1]], []),
+            (RZGate(pi / 2), [q[1]], []),
+            (SGate(), [q[0]], []),
+            (CXGate(), [q[1], q[0]], []),
+            (RYGate(-theta / 2), [q[1]], []),
+            (RYGate(-theta / 2), [q[0]], []),
+            (CXGate(), [q[1], q[0]], []),
+            (SdgGate(), [q[0]], []),
+            (RZGate(-pi / 2), [q[1]], []),
+            (SXdgGate(), [q[1]], []),
+            (RZGate(pi / 2), [q[1]], []),
+            (RZGate(-beta), [q[0]], []),
+        ]
+        for instr, qargs, cargs in rules:
+            qc._append(instr, qargs, cargs)
+
+        self.definition = qc
+
+    def control(
+        self,
+        num_ctrl_qubits: int = 1,
+        label: str | None = None,
+        ctrl_state: str | int | None = None,
+        annotated: bool | None = None,
+    ):
+        """Return a (multi-)controlled-(XX+YY) gate.
+
+        Args:
+            num_ctrl_qubits: number of control qubits.
+            label: An optional label for the gate [Default: ``None``]
+            ctrl_state: control state expressed as integer,
+                string (e.g.``'110'``), or ``None``. If ``None``, use all 1s.
+            annotated: indicates whether the controlled gate should be implemented
+                as an annotated gate. If ``None``, this is set to ``True`` if
+                the gate contains free parameters, in which case it cannot
+                yet be synthesized.
+
+        Returns:
+            ControlledGate: controlled version of this gate.
+        """
+        if annotated is None:
+            annotated = any(isinstance(p, ParameterExpression) for p in self.params)
+
+        gate = super().control(
+            num_ctrl_qubits=num_ctrl_qubits,
+            label=label,
+            ctrl_state=ctrl_state,
+            annotated=annotated,
+        )
+        return gate
+
+    def inverse(self, annotated: bool = False):
+        """Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle).
+
+        Args:
+            annotated: when set to ``True``, this is typically used to return an
+                :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
+                :class:`.Gate`. However, for this class this argument is ignored as the inverse
+                of this gate is always a :class:`.XXPlusYYGate` with inverse
+                parameter values.
+
+        Returns:
+            XXPlusYYGate: inverse gate.
+        """
+        return XXPlusYYGate(-self.params[0], self.params[1])
+
+    def __array__(self, dtype=None, copy=None):
+        """Return a numpy.array for the XX+YY gate."""
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        half_theta = float(self.params[0]) / 2
+        beta = float(self.params[1])
+        cos = math.cos(half_theta)
+        sin = math.sin(half_theta)
+        return numpy.array(
+            [
+                [1, 0, 0, 0],
+                [0, cos, -1j * sin * exp(-1j * beta), 0],
+                [0, -1j * sin * exp(1j * beta), cos, 0],
+                [0, 0, 0, 1],
+            ],
+            dtype=dtype,
+        )
+
+    def power(self, exponent: float, annotated: bool = False):
+        theta, beta = self.params
+        return XXPlusYYGate(exponent * theta, beta)
+
+    def __eq__(self, other):
+        if isinstance(other, XXPlusYYGate):
+            return self._compare_parameters(other)
+        return False

qiskit/circuit/library/standard_gates/y.py

@@ -0,0 +1,257 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017.
+#
+# 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.
+
+"""Y and CY gates."""
+
+from math import pi
+from typing import Optional, Union
+
+# pylint: disable=cyclic-import
+from qiskit.circuit.singleton import SingletonGate, SingletonControlledGate, stdlib_singleton_key
+from qiskit.circuit._utils import with_gate_array, with_controlled_gate_array
+from qiskit._accelerate.circuit import StandardGate
+
+_Y_ARRAY = [[0, -1j], [1j, 0]]
+
+
+@with_gate_array(_Y_ARRAY)
+class YGate(SingletonGate):
+    r"""The single-qubit Pauli-Y gate (:math:`\sigma_y`).
+
+    Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
+    with the :meth:`~qiskit.circuit.QuantumCircuit.y` method.
+
+    **Matrix Representation:**
+
+    .. math::
+
+        Y = \begin{pmatrix}
+                0 & -i \\
+                i & 0
+            \end{pmatrix}
+
+    **Circuit symbol:**
+
+    .. code-block:: text
+
+             ┌───┐
+        q_0: ┤ Y ├
+             └───┘
+
+    Equivalent to a :math:`\pi` radian rotation about the Y axis.
+
+    .. note::
+
+        A global phase difference exists between the definitions of
+        :math:`RY(\pi)` and :math:`Y`.
+
+        .. math::
+
+            RY(\pi) = \begin{pmatrix}
+                        0 & -1 \\
+                        1 & 0
+                      \end{pmatrix}
+                    = -i Y
+
+    The gate is equivalent to a bit and phase flip.
+
+    .. math::
+
+        |0\rangle \rightarrow i|1\rangle \\
+        |1\rangle \rightarrow -i|0\rangle
+    """
+
+    _standard_gate = StandardGate.YGate
+
+    def __init__(self, label: Optional[str] = None):
+        """Create new Y gate."""
+        super().__init__("y", 1, [], label=label)
+
+    _singleton_lookup_key = stdlib_singleton_key()
+
+    def _define(self):
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit, QuantumRegister
+        from .u3 import U3Gate
+
+        q = QuantumRegister(1, "q")
+        qc = QuantumCircuit(q, name=self.name)
+        rules = [(U3Gate(pi, pi / 2, pi / 2), [q[0]], [])]
+        for instr, qargs, cargs in rules:
+            qc._append(instr, qargs, cargs)
+
+        self.definition = qc
+
+    def control(
+        self,
+        num_ctrl_qubits: int = 1,
+        label: Optional[str] = None,
+        ctrl_state: Optional[Union[str, int]] = None,
+        annotated: bool = False,
+    ):
+        """Return a (multi-)controlled-Y gate.
+
+        One control returns a CY gate.
+
+        Args:
+            num_ctrl_qubits: number of control qubits.
+            label: An optional label for the gate [Default: ``None``]
+            ctrl_state: control state expressed as integer,
+                string (e.g.``'110'``), or ``None``. If ``None``, use all 1s.
+            annotated: indicates whether the controlled gate should be implemented
+                as an annotated gate.
+
+        Returns:
+            ControlledGate: controlled version of this gate.
+        """
+        if not annotated and num_ctrl_qubits == 1:
+            gate = CYGate(label=label, ctrl_state=ctrl_state, _base_label=self.label)
+        else:
+            gate = super().control(
+                num_ctrl_qubits=num_ctrl_qubits,
+                label=label,
+                ctrl_state=ctrl_state,
+                annotated=annotated,
+            )
+        return gate
+
+    def inverse(self, annotated: bool = False):
+        r"""Return inverted Y gate (:math:`Y^{\dagger} = Y`)
+
+        Args:
+            annotated: when set to ``True``, this is typically used to return an
+                :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
+                :class:`.Gate`. However, for this class this argument is ignored as this gate
+                is self-inverse.
+
+        Returns:
+            YGate: inverse gate (self-inverse).
+        """
+        return YGate()  # self-inverse
+
+    def __eq__(self, other):
+        return isinstance(other, YGate)
+
+
+@with_controlled_gate_array(_Y_ARRAY, num_ctrl_qubits=1)
+class CYGate(SingletonControlledGate):
+    r"""Controlled-Y gate.
+
+    Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
+    with the :meth:`~qiskit.circuit.QuantumCircuit.cy` method.
+
+    **Circuit symbol:**
+
+    .. code-block:: text
+
+        q_0: ──■──
+             ┌─┴─┐
+        q_1: ┤ Y ├
+             └───┘
+
+    **Matrix representation:**
+
+    .. math::
+
+        CY\ q_0, q_1 =
+        I \otimes |0 \rangle\langle 0| + Y \otimes |1 \rangle\langle 1|  =
+            \begin{pmatrix}
+                1 & 0 & 0 & 0 \\
+                0 & 0 & 0 & -i \\
+                0 & 0 & 1 & 0 \\
+                0 & i & 0 & 0
+            \end{pmatrix}
+
+
+    .. note::
+
+        In Qiskit's convention, higher qubit indices are more significant
+        (little endian convention). In many textbooks, controlled gates are
+        presented with the assumption of more significant qubits as control,
+        which in our case would be q_1. Thus a textbook matrix for this
+        gate will be:
+
+        .. code-block:: text
+
+                 ┌───┐
+            q_0: ┤ Y ├
+                 └─┬─┘
+            q_1: ──■──
+
+        .. math::
+
+            CY\ q_1, q_0 =
+                |0 \rangle\langle 0| \otimes I + |1 \rangle\langle 1| \otimes Y =
+                \begin{pmatrix}
+                    1 & 0 & 0 & 0 \\
+                    0 & 1 & 0 & 0 \\
+                    0 & 0 & 0 & -i \\
+                    0 & 0 & i & 0
+                \end{pmatrix}
+
+    """
+
+    _standard_gate = StandardGate.CYGate
+
+    def __init__(
+        self,
+        label: Optional[str] = None,
+        ctrl_state: Optional[Union[str, int]] = None,
+        *,
+        _base_label=None,
+    ):
+        """Create new CY gate."""
+        super().__init__(
+            "cy",
+            2,
+            [],
+            num_ctrl_qubits=1,
+            label=label,
+            ctrl_state=ctrl_state,
+            base_gate=YGate(label=_base_label),
+        )
+
+    _singleton_lookup_key = stdlib_singleton_key(num_ctrl_qubits=1)
+
+    def _define(self):
+        """
+        gate cy a,b { sdg b; cx a,b; s b; }
+        """
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit, QuantumRegister
+        from .s import SGate, SdgGate
+        from .x import CXGate
+
+        q = QuantumRegister(2, "q")
+        qc = QuantumCircuit(q, name=self.name)
+        rules = [(SdgGate(), [q[1]], []), (CXGate(), [q[0], q[1]], []), (SGate(), [q[1]], [])]
+        for instr, qargs, cargs in rules:
+            qc._append(instr, qargs, cargs)
+
+        self.definition = qc
+
+    def inverse(self, annotated: bool = False):
+        """Return inverted CY gate (itself).
+
+        Args:
+            annotated: when set to ``True``, this is typically used to return an
+                :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
+                :class:`.Gate`. However, for this class this argument is ignored as this gate
+                is self-inverse.
+
+        Returns:
+            CYGate: inverse gate (self-inverse).
+        """
+        return CYGate(ctrl_state=self.ctrl_state)  # self-inverse
+
+    def __eq__(self, other):
+        return isinstance(other, CYGate) and self.ctrl_state == other.ctrl_state