qiskit 2.1.0rc1__cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

qiskit/circuit/library/standard_gates/ryy.py

@@ -0,0 +1,165 @@
+# 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.
+
+"""Two-qubit YY-rotation gate."""
+
+from __future__ import annotations
+
+import math
+from typing import Optional
+import numpy as np
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.parameterexpression import ParameterValueType, ParameterExpression
+from qiskit._accelerate.circuit import StandardGate
+
+
+class RYYGate(Gate):
+    r"""A parametric 2-qubit :math:`Y \otimes Y` interaction (rotation about YY).
+
+    This gate is symmetric, and is maximally entangling at :math:`\theta = \pi/2`.
+
+    Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
+    with the :meth:`~qiskit.circuit.QuantumCircuit.ryy` method.
+
+    **Circuit Symbol:**
+
+    .. code-block:: text
+
+             ┌─────────┐
+        q_0: ┤1        ├
+             │  Ryy(ϴ) │
+        q_1: ┤0        ├
+             └─────────┘
+
+    **Matrix Representation:**
+
+    .. math::
+
+        \newcommand{\rotationangle}{\frac{\theta}{2}}
+
+        R_{YY}(\theta) = \exp\left(-i \rotationangle Y{\otimes}Y\right) =
+            \begin{pmatrix}
+                \cos\left(\rotationangle\right) & 0 & 0 & i\sin\left(\rotationangle\right) \\
+                0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) & 0 \\
+                0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) & 0 \\
+                i\sin\left(\rotationangle\right) & 0 & 0 & \cos\left(\rotationangle\right)
+            \end{pmatrix}
+
+    **Examples:**
+
+        .. math::
+
+            R_{YY}(\theta = 0) = I
+
+        .. math::
+
+            R_{YY}(\theta = \pi) = -i Y \otimes Y
+
+        .. math::
+
+            R_{YY}\left(\theta = \frac{\pi}{2}\right) = \frac{1}{\sqrt{2}}
+                                    \begin{pmatrix}
+                                        1 & 0 & 0 & i \\
+                                        0 & 1 & -i & 0 \\
+                                        0 & -i & 1 & 0 \\
+                                        i & 0 & 0 & 1
+                                    \end{pmatrix}
+    """
+
+    _standard_gate = StandardGate.RYY
+
+    def __init__(self, theta: ParameterValueType, label: Optional[str] = None):
+        """Create new RYY gate."""
+        super().__init__("ryy", 2, [theta], label=label)
+
+    def _define(self):
+        """Default definition"""
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit
+
+        #      ┌──────┐                   ┌────┐
+        # q_0: ┤ √Xdg ├──■─────────────■──┤ √X ├
+        #      ├──────┤┌─┴─┐┌───────┐┌─┴─┐├────┤
+        # q_1: ┤ √Xdg ├┤ X ├┤ Rz(θ) ├┤ X ├┤ √X ├
+        #      └──────┘└───┘└───────┘└───┘└────┘
+
+        self.definition = QuantumCircuit._from_circuit_data(
+            StandardGate.RYY._get_definition(self.params), add_regs=True, name=self.name
+        )
+
+    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-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 RYY gate (i.e. with the negative rotation 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:`.RYYGate` with an inverted parameter value.
+
+        Returns:
+            RYYGate: inverse gate.
+        """
+        return RYYGate(-self.params[0])
+
+    def __array__(self, dtype=None, copy=None):
+        """Return a numpy.array for the RYY gate."""
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        theta = float(self.params[0])
+        cos = math.cos(theta / 2)
+        isin = 1j * math.sin(theta / 2)
+        return np.array(
+            [[cos, 0, 0, isin], [0, cos, -isin, 0], [0, -isin, cos, 0], [isin, 0, 0, cos]],
+            dtype=dtype,
+        )
+
+    def power(self, exponent: float, annotated: bool = False):
+        (theta,) = self.params
+        return RYYGate(exponent * theta)
+
+    def __eq__(self, other):
+        if isinstance(other, RYYGate):
+            return self._compare_parameters(other)
+        return False

qiskit/circuit/library/standard_gates/rz.py

@@ -0,0 +1,290 @@
+# 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.
+
+"""Rotation around the Z axis."""
+
+from __future__ import annotations
+
+from cmath import exp
+from typing import Optional, Union
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.controlledgate import ControlledGate
+from qiskit.circuit.parameterexpression import ParameterValueType
+from qiskit._accelerate.circuit import StandardGate
+
+
+class RZGate(Gate):
+    r"""Single-qubit rotation about the Z axis.
+
+    This is a diagonal gate. It can be implemented virtually in hardware
+    via framechanges (i.e. at zero error and duration).
+
+    Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
+    with the :meth:`~qiskit.circuit.QuantumCircuit.rz` method.
+
+    **Circuit symbol:**
+
+    .. code-block:: text
+
+             ┌───────┐
+        q_0: ┤ Rz(φ) ├
+             └───────┘
+
+    **Matrix Representation:**
+
+    .. math::
+
+        RZ(\phi) = \exp\left(-i\frac{\phi}{2}Z\right) =
+            \begin{pmatrix}
+                e^{-i\frac{\phi}{2}} & 0 \\
+                0 & e^{i\frac{\phi}{2}}
+            \end{pmatrix}
+
+    .. seealso::
+
+        :class:`~qiskit.circuit.library.standard_gates.U1Gate`
+        This gate is equivalent to U1 up to a phase factor.
+
+            .. math::
+
+                U1(\theta=\phi) = e^{i{\phi}/2}RZ(\phi)
+
+        Reference for virtual Z gate implementation:
+        `1612.00858 <https://arxiv.org/abs/1612.00858>`_
+    """
+
+    _standard_gate = StandardGate.RZ
+
+    def __init__(self, phi: ParameterValueType, label: Optional[str] = None):
+        """Create new RZ gate."""
+        super().__init__("rz", 1, [phi], label=label)
+
+    def _define(self):
+        """Default definition"""
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit
+
+        # global phase: -0.5*φ
+        #    ┌──────┐
+        # q: ┤ P(φ) ├
+        #    └──────┘
+
+        self.definition = QuantumCircuit._from_circuit_data(
+            StandardGate.RZ._get_definition(self.params), add_regs=True, name=self.name
+        )
+
+    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-RZ 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 and more than one control qubit, in which
+                case it cannot yet be synthesized. Otherwise it is set to ``False``.
+
+        Returns:
+            ControlledGate: controlled version of this gate.
+        """
+        # deliberately capture annotated in [None, False] here
+        if not annotated and num_ctrl_qubits == 1:
+            gate = CRZGate(self.params[0], label=label, ctrl_state=ctrl_state)
+            gate.base_gate.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 RZ gate
+
+        :math:`RZ(\lambda)^{\dagger} = RZ(-\lambda)`
+
+        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:`.RZGate` with an inverted parameter value.
+
+        Returns:
+            RZGate: inverse gate.
+        """
+        return RZGate(-self.params[0])
+
+    def __array__(self, dtype=None, copy=None):
+        """Return a numpy.array for the RZ gate."""
+        import numpy as np
+
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        ilam2 = 0.5j * float(self.params[0])
+        return np.array([[exp(-ilam2), 0], [0, exp(ilam2)]], dtype=dtype)
+
+    def power(self, exponent: float, annotated: bool = False):
+        (theta,) = self.params
+        return RZGate(exponent * theta)
+
+    def __eq__(self, other):
+        if isinstance(other, RZGate):
+            return self._compare_parameters(other)
+        return False
+
+
+class CRZGate(ControlledGate):
+    r"""Controlled-RZ gate.
+
+    This is a diagonal but non-symmetric gate that induces a
+    phase on the state of the target qubit, depending on the control state.
+
+    Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
+    with the :meth:`~qiskit.circuit.QuantumCircuit.crz` method.
+
+    **Circuit symbol:**
+
+    .. code-block:: text
+
+        q_0: ────■────
+             ┌───┴───┐
+        q_1: ┤ Rz(θ) ├
+             └───────┘
+
+    **Matrix representation:**
+
+    .. math::
+
+        CRZ(\theta)\ q_0, q_1 =
+            I \otimes |0\rangle\langle 0| + RZ(\phi=\theta) \otimes |1\rangle\langle 1| =
+            \begin{pmatrix}
+                1 & 0 & 0 & 0 \\
+                0 & e^{-i\frac{\theta}{2}} & 0 & 0 \\
+                0 & 0 & 1 & 0 \\
+                0 & 0 & 0 & e^{i\frac{\theta}{2}}
+            \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: ┤ Rz(θ) ├
+                 └───┬───┘
+            q_1: ────■────
+
+        .. math::
+
+            CRZ(\theta)\ q_1, q_0 =
+                |0\rangle\langle 0| \otimes I + |1\rangle\langle 1| \otimes RZ(\theta) =
+                \begin{pmatrix}
+                    1 & 0 & 0 & 0 \\
+                    0 & 1 & 0 & 0 \\
+                    0 & 0 & e^{-i\frac{\theta}{2}} & 0 \\
+                    0 & 0 & 0 & e^{i\frac{\theta}{2}}
+                \end{pmatrix}
+
+    .. seealso::
+
+        :class:`~qiskit.circuit.library.standard_gates.CU1Gate`:
+        Due to the global phase difference in the matrix definitions
+        of U1 and RZ, CU1 and CRZ are different gates with a relative
+        phase difference.
+    """
+
+    _standard_gate = StandardGate.CRZ
+
+    def __init__(
+        self,
+        theta: ParameterValueType,
+        label: Optional[str] = None,
+        ctrl_state: Optional[Union[str, int]] = None,
+        *,
+        _base_label=None,
+    ):
+        """Create new CRZ gate."""
+        super().__init__(
+            "crz",
+            2,
+            [theta],
+            num_ctrl_qubits=1,
+            label=label,
+            ctrl_state=ctrl_state,
+            base_gate=RZGate(theta, label=_base_label),
+        )
+
+    def _define(self):
+        """Default definition"""
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit
+
+        # q_0: ─────────────■────────────────■──
+        #      ┌─────────┐┌─┴─┐┌──────────┐┌─┴─┐
+        # q_1: ┤ Rz(θ/2) ├┤ X ├┤ Rz(-θ/2) ├┤ X ├
+        #      └─────────┘└───┘└──────────┘└───┘
+
+        self.definition = QuantumCircuit._from_circuit_data(
+            StandardGate.CRZ._get_definition(self.params), add_regs=True, name=self.name
+        )
+
+    def inverse(self, annotated: bool = False):
+        """Return inverse CRZ gate (i.e. with the negative rotation 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:`.CRZGate` with an inverted parameter value.
+
+         Returns:
+            CRZGate: inverse gate.
+        """
+        return CRZGate(-self.params[0], ctrl_state=self.ctrl_state)
+
+    def __array__(self, dtype=None, copy=None):
+        """Return a numpy.array for the CRZ gate."""
+        import numpy
+
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        arg = 1j * float(self.params[0]) / 2
+        if self.ctrl_state:
+            return numpy.array(
+                [[1, 0, 0, 0], [0, exp(-arg), 0, 0], [0, 0, 1, 0], [0, 0, 0, exp(arg)]],
+                dtype=dtype,
+            )
+        else:
+            return numpy.array(
+                [[exp(-arg), 0, 0, 0], [0, 1, 0, 0], [0, 0, exp(arg), 0], [0, 0, 0, 1]],
+                dtype=dtype,
+            )
+
+    def __eq__(self, other):
+        if isinstance(other, CRZGate):
+            return self._compare_parameters(other) and self.ctrl_state == other.ctrl_state
+        return False

qiskit/circuit/library/standard_gates/rzx.py

@@ -0,0 +1,211 @@
+# 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.
+
+"""Two-qubit ZX-rotation gate."""
+
+from __future__ import annotations
+
+import math
+from typing import Optional
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.parameterexpression import ParameterValueType, ParameterExpression
+from qiskit._accelerate.circuit import StandardGate
+
+
+class RZXGate(Gate):
+    r"""A parametric 2-qubit :math:`Z \otimes X` interaction (rotation about ZX).
+
+    This gate is maximally entangling at :math:`\theta = \pi/2`.
+
+    The cross-resonance gate (CR) for superconducting qubits implements
+    a ZX interaction (however other terms are also present in an experiment).
+
+    Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
+    with the :meth:`~qiskit.circuit.QuantumCircuit.rzx` method.
+
+    **Circuit Symbol:**
+
+    .. code-block:: text
+
+             ┌─────────┐
+        q_0: ┤0        ├
+             │  Rzx(θ) │
+        q_1: ┤1        ├
+             └─────────┘
+
+    **Matrix Representation:**
+
+    .. math::
+
+        \newcommand{\rotationangle}{\frac{\theta}{2}}
+
+        R_{ZX}(\theta)\ q_0, q_1 = \exp\left(-i \frac{\theta}{2} X{\otimes}Z\right) =
+            \begin{pmatrix}
+                \cos\left(\rotationangle\right) & 0 & -i\sin\left(\rotationangle\right) & 0 \\
+                0 & \cos\left(\rotationangle\right) & 0 & i\sin\left(\rotationangle\right) \\
+                -i\sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right) & 0 \\
+                0 & i\sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right)
+            \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 the :math:`X \otimes Z` tensor order.
+        Instead, if we apply it on (q_1, q_0), the matrix will
+        be :math:`Z \otimes X`:
+
+        .. code-block:: text
+
+                 ┌─────────┐
+            q_0: ┤1        ├
+                 │  Rzx(θ) │
+            q_1: ┤0        ├
+                 └─────────┘
+
+        .. math::
+
+            \newcommand{\rotationangle}{\frac{\theta}{2}}
+
+            R_{ZX}(\theta)\ q_1, q_0 = exp(-i \frac{\theta}{2} Z{\otimes}X) =
+                \begin{pmatrix}
+                    \cos(\rotationangle)   & -i\sin(\rotationangle) & 0           & 0          \\
+                    -i\sin(\rotationangle) & \cos(\rotationangle)   & 0           & 0          \\
+                    0           & 0           & \cos(\rotationangle)   & i\sin(\rotationangle) \\
+                    0           & 0           & i\sin(\rotationangle)  & \cos(\rotationangle)
+                \end{pmatrix}
+
+        This is a direct sum of RX rotations, so this gate is equivalent to a
+        uniformly controlled (multiplexed) RX gate:
+
+        .. math::
+
+            R_{ZX}(\theta)\ q_1, q_0 =
+                \begin{pmatrix}
+                    RX(\theta) & 0 \\
+                    0 & RX(-\theta)
+                \end{pmatrix}
+
+    **Examples:**
+
+        .. math::
+
+            R_{ZX}(\theta = 0)\ q_0, q_1 = I
+
+        .. math::
+
+            R_{ZX}(\theta = 2\pi)\ q_0, q_1 = -I
+
+        .. math::
+
+            R_{ZX}(\theta = \pi)\ q_0, q_1 = -i X \otimes Z
+
+        .. math::
+
+            R_{ZX}(\theta = \frac{\pi}{2})\ q_0, q_1 = \frac{1}{\sqrt{2}}
+                                    \begin{pmatrix}
+                                        1  & 0 & -i & 0 \\
+                                        0  & 1 & 0  & i \\
+                                        -i & 0 & 1  & 0 \\
+                                        0  & i & 0  & 1
+                                    \end{pmatrix}
+    """
+
+    _standard_gate = StandardGate.RZX
+
+    def __init__(self, theta: ParameterValueType, label: Optional[str] = None):
+        """Create new RZX gate."""
+        super().__init__("rzx", 2, [theta], label=label)
+
+    def _define(self):
+        """Default definition"""
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit
+
+        # q_0: ───────■─────────────■───────
+        #      ┌───┐┌─┴─┐┌───────┐┌─┴─┐┌───┐
+        # q_1: ┤ H ├┤ X ├┤ Rz(0) ├┤ X ├┤ H ├
+        #      └───┘└───┘└───────┘└───┘└───┘
+
+        self.definition = QuantumCircuit._from_circuit_data(
+            StandardGate.RZX._get_definition(self.params), add_regs=True, name=self.name
+        )
+
+    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-RZX 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 RZX gate (i.e. with the negative rotation 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:`.RZXGate` with an inverted parameter value.
+
+         Returns:
+            RZXGate: inverse gate.
+        """
+        return RZXGate(-self.params[0])
+
+    def __array__(self, dtype=None, copy=None):
+        """Return a numpy.array for the RZX gate."""
+        import numpy
+
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        half_theta = float(self.params[0]) / 2
+        cos = math.cos(half_theta)
+        isin = 1j * math.sin(half_theta)
+        return numpy.array(
+            [[cos, 0, -isin, 0], [0, cos, 0, isin], [-isin, 0, cos, 0], [0, isin, 0, cos]],
+            dtype=dtype,
+        )
+
+    def power(self, exponent: float, annotated: bool = False):
+        (theta,) = self.params
+        return RZXGate(exponent * theta)
+
+    def __eq__(self, other):
+        if isinstance(other, RZXGate):
+            return self._compare_parameters(other)
+        return False