qiskit 2.1.0rc1__cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

qiskit/circuit/library/standard_gates/p.py

@@ -0,0 +1,415 @@
+# 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.
+
+"""Phase Gate."""
+
+from __future__ import annotations
+from cmath import exp
+import numpy
+from qiskit.circuit.controlledgate import ControlledGate
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.parameterexpression import ParameterValueType
+from qiskit._accelerate.circuit import StandardGate
+
+
+class PhaseGate(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.p` method.
+
+    **Circuit symbol:**
+
+    .. code-block:: text
+
+             ┌──────┐
+        q_0: ┤ P(θ) ├
+             └──────┘
+
+    **Matrix Representation:**
+
+    .. math::
+
+        P(\theta) =
+            \begin{pmatrix}
+                1 & 0 \\
+                0 & e^{i\theta}
+            \end{pmatrix}
+
+    **Examples:**
+
+        .. math::
+
+            P(\theta = \pi) = Z
+
+        .. math::
+
+            P(\theta = \pi/2) = S
+
+        .. math::
+
+            P(\theta = \pi/4) = T
+
+    .. seealso::
+
+        :class:`~qiskit.circuit.library.standard_gates.RZGate`:
+        This gate is equivalent to RZ up to a phase factor.
+
+            .. math::
+
+                P(\theta) = e^{i{\theta}/2} RZ(\theta)
+
+        Reference for virtual Z gate implementation:
+        `1612.00858 <https://arxiv.org/abs/1612.00858>`_
+    """
+
+    _standard_gate = StandardGate.Phase
+
+    def __init__(self, theta: ParameterValueType, label: str | None = None):
+        """Create new Phase gate."""
+        super().__init__("p", 1, [theta], label=label)
+
+    def _define(self):
+        """Default definition"""
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit
+
+        #    ┌──────────┐
+        # q: ┤ U(0,0,θ) ├
+        #    └──────────┘
+
+        self.definition = QuantumCircuit._from_circuit_data(
+            StandardGate.Phase._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-Phase 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 handled as ``False``.
+
+        Returns:
+            ControlledGate: controlled version of this gate.
+        """
+        if not annotated and num_ctrl_qubits == 1:
+            gate = CPhaseGate(self.params[0], label=label, ctrl_state=ctrl_state)
+            gate.base_gate.label = self.label
+        elif not annotated and ctrl_state is None and num_ctrl_qubits > 1:
+            gate = MCPhaseGate(self.params[0], num_ctrl_qubits, label=label)
+            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 Phase gate (:math:`Phase(\lambda)^{\dagger} = Phase(-\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 another :class:`.PGate` with an inverse parameter value.
+
+        Returns:
+            PGate: inverse gate.
+        """
+        return PhaseGate(-self.params[0])
+
+    def __array__(self, dtype=None, copy=None):
+        """Return a numpy.array for the Phase gate."""
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        lam = float(self.params[0])
+        return numpy.array([[1, 0], [0, exp(1j * lam)]], dtype=dtype)
+
+    def power(self, exponent: float, annotated: bool = False):
+        (theta,) = self.params
+        return PhaseGate(exponent * theta)
+
+    def __eq__(self, other):
+        if isinstance(other, PhaseGate):
+            return self._compare_parameters(other)
+        return False
+
+
+class CPhaseGate(ControlledGate):
+    r"""Controlled-Phase gate.
+
+    This is a diagonal and 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.cp` method.
+
+    **Circuit symbol:**
+
+    .. code-block:: text
+
+
+        q_0: ─■──
+              │θ
+        q_1: ─■──
+
+
+    **Matrix representation:**
+
+    .. math::
+
+        CPhase =
+            I \otimes |0\rangle\langle 0| + P \otimes |1\rangle\langle 1| =
+            \begin{pmatrix}
+                1 & 0 & 0 & 0 \\
+                0 & 1 & 0 & 0 \\
+                0 & 0 & 1 & 0 \\
+                0 & 0 & 0 & e^{i\theta}
+            \end{pmatrix}
+
+    .. seealso::
+
+        :class:`~qiskit.circuit.library.standard_gates.CRZGate`:
+        Due to the global phase difference in the matrix definitions
+        of Phase and RZ, CPhase and CRZ are different gates with a relative
+        phase difference.
+    """
+
+    _standard_gate = StandardGate.CPhase
+
+    def __init__(
+        self,
+        theta: ParameterValueType,
+        label: str | None = None,
+        ctrl_state: str | int | None = None,
+        *,
+        _base_label=None,
+    ):
+        """Create new CPhase gate."""
+        super().__init__(
+            "cp",
+            2,
+            [theta],
+            num_ctrl_qubits=1,
+            label=label,
+            ctrl_state=ctrl_state,
+            base_gate=PhaseGate(theta, label=_base_label),
+        )
+
+    def _define(self):
+        """Default definition"""
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit
+
+        #      ┌────────┐
+        # q_0: ┤ P(θ/2) ├──■───────────────■────────────
+        #      └────────┘┌─┴─┐┌─────────┐┌─┴─┐┌────────┐
+        # q_1: ──────────┤ X ├┤ P(-θ/2) ├┤ X ├┤ P(θ/2) ├
+        #                └───┘└─────────┘└───┘└────────┘
+
+        self.definition = QuantumCircuit._from_circuit_data(
+            StandardGate.CPhase._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,
+    ):
+        """Controlled version of this 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 handled as ``False``.
+
+        Returns:
+            ControlledGate: controlled version of this gate.
+        """
+        if not annotated and ctrl_state is None:
+            gate = MCPhaseGate(self.params[0], num_ctrl_qubits=num_ctrl_qubits + 1, label=label)
+            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 CPhase gate (:math:`CPhase(\lambda)^{\dagger} = CPhase(-\lambda)`)"""
+        return CPhaseGate(-self.params[0], ctrl_state=self.ctrl_state)
+
+    def __array__(self, dtype=None, copy=None):
+        """Return a numpy.array for the CPhase gate."""
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        eith = exp(1j * float(self.params[0]))
+        if self.ctrl_state:
+            return numpy.array(
+                [[1, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0], [0, 0, 0, eith]], dtype=dtype
+            )
+        return numpy.array([[1, 0, 0, 0], [0, 1, 0, 0], [0, 0, eith, 0], [0, 0, 0, 1]], dtype=dtype)
+
+    def power(self, exponent: float, annotated: bool = False):
+        (theta,) = self.params
+        return CPhaseGate(exponent * theta)
+
+    def __eq__(self, other):
+        if isinstance(other, CPhaseGate):
+            return self._compare_parameters(other) and self.ctrl_state == other.ctrl_state
+        return False
+
+
+class MCPhaseGate(ControlledGate):
+    r"""Multi-controlled-Phase gate.
+
+    This is a diagonal and symmetric gate that induces a
+    phase on the state of the target qubit, depending on the state of the control qubits.
+
+    Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
+    with the :meth:`~qiskit.circuit.QuantumCircuit.mcp` method.
+
+    **Circuit symbol:**
+
+    .. code-block:: text
+
+            q_0: ───■────
+                    │
+                    .
+                    │
+        q_(n-1): ───■────
+                 ┌──┴───┐
+            q_n: ┤ P(λ) ├
+                 └──────┘
+
+    .. seealso::
+
+        :class:`~qiskit.circuit.library.standard_gates.CPhaseGate`:
+        The singly-controlled-version of this gate.
+    """
+
+    def __init__(
+        self,
+        lam: ParameterValueType,
+        num_ctrl_qubits: int,
+        label: str | None = None,
+        ctrl_state: str | int | None = None,
+        *,
+        _base_label=None,
+    ):
+        """Create new MCPhase gate."""
+        super().__init__(
+            "mcphase",
+            num_ctrl_qubits + 1,
+            [lam],
+            num_ctrl_qubits=num_ctrl_qubits,
+            label=label,
+            ctrl_state=ctrl_state,
+            base_gate=PhaseGate(lam, label=_base_label),
+        )
+
+    def _define(self):
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit, QuantumRegister
+
+        qr = QuantumRegister(self.num_qubits, "q")
+        qc = QuantumCircuit(qr, name=self.name)
+
+        if self.num_ctrl_qubits == 0:
+            qc.p(self.params[0], 0)
+        if self.num_ctrl_qubits == 1:
+            qc.cp(self.params[0], 0, 1)
+        else:
+            lam = self.params[0]
+
+            q_controls = list(range(self.num_ctrl_qubits))
+            q_target = self.num_ctrl_qubits
+            new_target = q_target
+            for k in range(self.num_ctrl_qubits):
+                # Note: it's better *not* to run transpile recursively
+                qc.mcrz(lam / (2**k), q_controls, new_target, use_basis_gates=False)
+                new_target = q_controls.pop()
+            qc.p(lam / (2**self.num_ctrl_qubits), new_target)
+
+        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,
+    ):
+        """Controlled version of this 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 handled as ``False``.
+
+        Returns:
+            ControlledGate: controlled version of this gate.
+        """
+        if not annotated and ctrl_state is None:
+            gate = MCPhaseGate(
+                self.params[0],
+                num_ctrl_qubits=num_ctrl_qubits + self.num_ctrl_qubits,
+                label=label,
+            )
+            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 MCPhase gate (:math:`MCPhase(\lambda)^{\dagger} = MCPhase(-\lambda)`)"""
+        return MCPhaseGate(-self.params[0], self.num_ctrl_qubits)
+
+    def __eq__(self, other):
+        return (
+            isinstance(other, MCPhaseGate)
+            and self.num_ctrl_qubits == other.num_ctrl_qubits
+            and self.ctrl_state == other.ctrl_state
+            and self._compare_parameters(other)
+        )

qiskit/circuit/library/standard_gates/r.py

@@ -0,0 +1,108 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019
+#
+# 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 axis in x-y plane."""
+
+import math
+from cmath import exp
+from typing import Optional
+import numpy
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.parameterexpression import ParameterValueType
+from qiskit._accelerate.circuit import StandardGate
+
+
+class RGate(Gate):
+    r"""Rotation θ around the cos(φ)x + sin(φ)y axis.
+
+    Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
+    with the :meth:`~qiskit.circuit.QuantumCircuit.r` method.
+
+    **Circuit symbol:**
+
+    .. code-block:: text
+
+               ┌─────────┐
+        q_0:   ┤ R(θ,ϕ)  ├ 
+               └─────────┘
+
+
+    **Matrix Representation:**
+
+    .. math::
+
+        \newcommand{\rotationangle}{\frac{\theta}{2}}
+
+        R(\theta, \phi) = e^{-i \rotationangle \left(\cos{\phi} x + \sin{\phi} y\right)} =
+            \begin{pmatrix}
+                \cos\left(\rotationangle\right) & -i e^{-i \phi} \sin\left(\rotationangle\right) \\
+                -i e^{i \phi} \sin\left(\rotationangle\right) & \cos\left(\rotationangle\right)
+            \end{pmatrix}
+    """
+
+    _standard_gate = StandardGate.R
+
+    def __init__(
+        self,
+        theta: ParameterValueType,
+        phi: ParameterValueType,
+        label: Optional[str] = None,
+    ):
+        """Create new r single-qubit gate."""
+        super().__init__("r", 1, [theta, phi], label=label)
+
+    def _define(self):
+        """Default definition"""
+        # pylint: disable=cyclic-import
+        from qiskit.circuit import QuantumCircuit
+
+        #    ┌───────────────────────┐
+        # q: ┤ U(θ,-π/2 + φ,π/2 - φ) ├
+        #    └───────────────────────┘
+
+        self.definition = QuantumCircuit._from_circuit_data(
+            StandardGate.R._get_definition(self.params), add_regs=True, name=self.name
+        )
+
+    def inverse(self, annotated: bool = False):
+        r"""Invert this gate as: :math:`R(θ, φ)^{\dagger} = R(-θ, φ)`
+
+        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:`.RGate` with an inverted parameter value.
+
+        Returns:
+            RGate: inverse gate.
+        """
+        return RGate(-self.params[0], self.params[1])
+
+    def __array__(self, dtype=None, copy=None):
+        """Return a numpy.array for the R gate."""
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        theta, phi = float(self.params[0]), float(self.params[1])
+        cos = math.cos(theta / 2)
+        sin = math.sin(theta / 2)
+        exp_m = exp(-1j * phi)
+        exp_p = exp(1j * phi)
+        return numpy.array([[cos, -1j * exp_m * sin], [-1j * exp_p * sin, cos]], dtype=dtype)
+
+    def power(self, exponent: float, annotated: bool = False):
+        theta, phi = self.params
+        return RGate(exponent * theta, phi)
+
+    def __eq__(self, other):
+        if isinstance(other, RGate):
+            return self._compare_parameters(other)
+        return False