qiskit 1.3.0b1__cp39-abi3-win32.whl → 1.3.0rc2__cp39-abi3-win32.whl

qiskit/circuit/library/quantum_volume.py

@@ -12,11 +12,14 @@
 
 """Quantum Volume model circuit."""
 
+from __future__ import annotations
+
 from typing import Optional, Union
 
 import numpy as np
 from qiskit.circuit import QuantumCircuit, CircuitInstruction
 from qiskit.circuit.library.generalized_gates import PermutationGate, UnitaryGate
+from qiskit._accelerate.circuit_library import quantum_volume as qv_rs
 
 
 class QuantumVolume(QuantumCircuit):
@@ -80,36 +83,85 @@ class QuantumVolume(QuantumCircuit):
         depth = depth or num_qubits  # how many layers of SU(4)
         width = num_qubits // 2  # how many SU(4)s fit in each layer
         rng = seed if isinstance(seed, np.random.Generator) else np.random.default_rng(seed)
-        if seed is None:
+        seed_name = seed
+        if seed_name is None:
             # Get the internal entropy used to seed the default RNG, if no seed was given.  This
             # stays in the output name, so effectively stores a way of regenerating the circuit.
             # This is just best-effort only, for backwards compatibility, and isn't critical (if
             # someone needs full reproducibility, they should be manually controlling the seeding).
-            seed = getattr(getattr(rng.bit_generator, "seed_seq", None), "entropy", None)
+            seed_name = getattr(getattr(rng.bit_generator, "seed_seq", None), "entropy", None)
 
         super().__init__(
-            num_qubits, name="quantum_volume_" + str([num_qubits, depth, seed]).replace(" ", "")
+            num_qubits,
+            name="quantum_volume_" + str([num_qubits, depth, seed_name]).replace(" ", ""),
         )
-        base = self if flatten else QuantumCircuit(num_qubits, name=self.name)
-
-        # For each layer, generate a permutation of qubits
-        # Then generate and apply a Haar-random SU(4) to each pair
-        unitaries = scipy.stats.unitary_group.rvs(4, depth * width, rng).reshape(depth, width, 4, 4)
-        qubits = tuple(base.qubits)
-        for row in unitaries:
-            perm = rng.permutation(num_qubits)
-            if classical_permutation:
-                for w, unitary in enumerate(row):
-                    gate = UnitaryGate(unitary, check_input=False, num_qubits=2)
-                    qubit = 2 * w
-                    base._append(
-                        CircuitInstruction(gate, (qubits[perm[qubit]], qubits[perm[qubit + 1]]))
-                    )
+        if classical_permutation:
+            if seed is not None:
+                max_value = np.iinfo(np.int64).max
+                seed = rng.integers(max_value, dtype=np.int64)
+            qv_circ = quantum_volume(num_qubits, depth, seed)
+            qv_circ.name = self.name
+            if flatten:
+                self.compose(qv_circ, inplace=True)
             else:
+                self._append(CircuitInstruction(qv_circ.to_instruction(), tuple(self.qubits)))
+        else:
+            if seed is None:
+                seed = seed_name
+
+            base = self if flatten else QuantumCircuit(num_qubits, name=self.name)
+
+            # For each layer, generate a permutation of qubits
+            # Then generate and apply a Haar-random SU(4) to each pair
+            unitaries = scipy.stats.unitary_group.rvs(4, depth * width, rng).reshape(
+                depth, width, 4, 4
+            )
+            qubits = tuple(base.qubits)
+            for row in unitaries:
+                perm = rng.permutation(num_qubits)
                 base._append(CircuitInstruction(PermutationGate(perm), qubits))
                 for w, unitary in enumerate(row):
                     gate = UnitaryGate(unitary, check_input=False, num_qubits=2)
                     qubit = 2 * w
                     base._append(CircuitInstruction(gate, qubits[qubit : qubit + 2]))
-        if not flatten:
-            self._append(CircuitInstruction(base.to_instruction(), tuple(self.qubits)))
+            if not flatten:
+                self._append(CircuitInstruction(base.to_instruction(), tuple(self.qubits)))
+
+
+def quantum_volume(
+    num_qubits: int,
+    depth: int | None = None,
+    seed: int | np.random.Generator | None = None,
+) -> QuantumCircuit:
+    """A quantum volume model circuit.
+
+    The model circuits are random instances of circuits used to measure
+    the Quantum Volume metric, as introduced in [1].
+
+    The model circuits consist of layers of Haar random
+    elements of SU(4) applied between corresponding pairs
+    of qubits in a random bipartition.
+
+    This function is multithreaded and will launch a thread pool with threads equal to the number
+    of CPUs by default. You can tune the number of threads with the ``RAYON_NUM_THREADS``
+    environment variable. For example, setting ``RAYON_NUM_THREADS=4`` would limit the thread pool
+    to 4 threads.
+
+    **Reference Circuit:**
+
+    .. plot::
+
+       from qiskit.circuit.library import quantum_volume
+       circuit = quantum_volume(5, 6, seed=10)
+       circuit.draw('mpl')
+
+    **References:**
+
+    [1] A. Cross et al. Validating quantum computers using
+    randomized model circuits, Phys. Rev. A 100, 032328 (2019).
+    `arXiv:1811.12926 <https://arxiv.org/abs/1811.12926>`__
+    """
+    if isinstance(seed, np.random.Generator):
+        seed = seed.integers(0, dtype=np.uint64)
+    depth = depth or num_qubits
+    return QuantumCircuit._from_circuit_data(qv_rs(num_qubits, depth, seed))

qiskit/circuit/library/standard_gates/__init__.py

@@ -48,7 +48,26 @@ from .multi_control_rotation_gates import mcrx, mcry, mcrz
 
 def get_standard_gate_name_mapping():
     """Return a dictionary mapping the name of standard gates and instructions to an object for
-    that name."""
+    that name.
+
+    Examples:
+
+        .. code-block:: python
+
+            from qiskit.circuit.library import get_standard_gate_name_mapping
+
+            gate_name_map = get_standard_gate_name_mapping()
+            cx_object = gate_name_map["cx"]
+
+            print(cx_object)
+            print(type(cx_object))
+
+        .. code-block:: text
+
+            Instruction(name='cx', num_qubits=2, num_clbits=0, params=[])
+            _SingletonCXGate
+    """
+
     from qiskit.circuit.parameter import Parameter
     from qiskit.circuit.measure import Measure
     from qiskit.circuit.delay import Delay

qiskit/circuit/library/standard_gates/dcx.py

@@ -28,7 +28,8 @@ class DCXGate(SingletonGate):
     Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
     with the :meth:`~qiskit.circuit.QuantumCircuit.dcx` method.
 
-    .. parsed-literal::
+    .. code-block:: text
+
                   ┌───┐
         q_0: ──■──┤ X ├
              ┌─┴─┐└─┬─┘

qiskit/circuit/library/standard_gates/ecr.py

@@ -38,7 +38,7 @@ class ECRGate(SingletonGate):
 
     **Circuit Symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌─────────┐            ┌────────────┐┌────────┐┌─────────────┐
         q_0: ┤0        ├       q_0: ┤0           ├┤ RX(pi) ├┤0            ├
@@ -66,7 +66,7 @@ class ECRGate(SingletonGate):
         Instead, if we apply it on (q_1, q_0), the matrix will
         be :math:`Z \otimes X`:
 
-        .. parsed-literal::
+        .. code-block:: text
 
                  ┌─────────┐
             q_0: ┤1        ├

qiskit/circuit/library/standard_gates/h.py

@@ -38,7 +38,7 @@ class HGate(SingletonGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌───┐
         q_0: ┤ H ├
@@ -142,7 +142,7 @@ class CHGate(SingletonControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ──■──
              ┌─┴─┐
@@ -170,7 +170,8 @@ class CHGate(SingletonControlledGate):
         which in our case would be q_1. Thus a textbook matrix for this
         gate will be:
 
-        .. parsed-literal::
+        .. code-block:: text
+
                  ┌───┐
             q_0: ┤ H ├
                  └─┬─┘

qiskit/circuit/library/standard_gates/i.py

@@ -40,7 +40,8 @@ class IGate(SingletonGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
+
              ┌───┐
         q_0: ┤ I ├
              └───┘

qiskit/circuit/library/standard_gates/iswap.py

@@ -38,7 +38,7 @@ class iSwapGate(SingletonGate):
 
     **Circuit Symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ─⨂─
               │
@@ -46,7 +46,7 @@ class iSwapGate(SingletonGate):
 
     **Reference Implementation:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌───┐┌───┐     ┌───┐
         q_0: ┤ S ├┤ H ├──■──┤ X ├─────

qiskit/circuit/library/standard_gates/p.py

@@ -33,35 +33,35 @@ class PhaseGate(Gate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌──────┐
-        q_0: ┤ P(λ) ├
+        q_0: ┤ P(θ) ├
              └──────┘
 
     **Matrix Representation:**
 
     .. math::
 
-        P(\lambda) =
+        P(\theta) =
             \begin{pmatrix}
                 1 & 0 \\
-                0 & e^{i\lambda}
+                0 & e^{i\theta}
             \end{pmatrix}
 
     **Examples:**
 
         .. math::
 
-            P(\lambda = \pi) = Z
+            P(\theta = \pi) = Z
 
         .. math::
 
-            P(\lambda = \pi/2) = S
+            P(\theta = \pi/2) = S
 
         .. math::
 
-            P(\lambda = \pi/4) = T
+            P(\theta = \pi/4) = T
 
     .. seealso::
 
@@ -70,7 +70,7 @@ class PhaseGate(Gate):
 
             .. math::
 
-                P(\lambda) = e^{i{\lambda}/2} RZ(\lambda)
+                P(\theta) = e^{i{\theta}/2} RZ(\theta)
 
         Reference for virtual Z gate implementation:
         `1612.00858 <https://arxiv.org/abs/1612.00858>`_
@@ -171,11 +171,11 @@ class CPhaseGate(ControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
 
         q_0: ─■──
-              │λ
+              │θ
         q_1: ─■──
 
 
@@ -189,7 +189,7 @@ class CPhaseGate(ControlledGate):
                 1 & 0 & 0 & 0 \\
                 0 & 1 & 0 & 0 \\
                 0 & 0 & 1 & 0 \\
-                0 & 0 & 0 & e^{i\lambda}
+                0 & 0 & 0 & e^{i\theta}
             \end{pmatrix}
 
     .. seealso::
@@ -318,7 +318,7 @@ class MCPhaseGate(ControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
             q_0: ───■────
                     │
@@ -431,3 +431,11 @@ class MCPhaseGate(ControlledGate):
     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

@@ -31,7 +31,7 @@ class RGate(Gate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌──────┐
         q_0: ┤ R(ϴ) ├

qiskit/circuit/library/standard_gates/rx.py

@@ -34,7 +34,7 @@ class RXGate(Gate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌───────┐
         q_0: ┤ Rx(ϴ) ├
@@ -159,7 +159,7 @@ class CRXGate(ControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ────■────
              ┌───┴───┐
@@ -189,7 +189,8 @@ class CRXGate(ControlledGate):
         which in our case would be q_1. Thus a textbook matrix for this
         gate will be:
 
-        .. parsed-literal::
+        .. code-block:: text
+
                  ┌───────┐
             q_0: ┤ Rx(ϴ) ├
                  └───┬───┘

qiskit/circuit/library/standard_gates/rxx.py

@@ -33,7 +33,7 @@ class RXXGate(Gate):
 
     **Circuit Symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌─────────┐
         q_0: ┤1        ├
@@ -63,7 +63,7 @@ class RXXGate(Gate):
 
         .. math::
 
-            R_{XX}(\theta = \pi) = i X \otimes X
+            R_{XX}(\theta = \pi) = -i X \otimes X
 
         .. math::
 

qiskit/circuit/library/standard_gates/ry.py

@@ -33,7 +33,7 @@ class RYGate(Gate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌───────┐
         q_0: ┤ Ry(ϴ) ├
@@ -158,7 +158,7 @@ class CRYGate(ControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ────■────
              ┌───┴───┐
@@ -188,7 +188,8 @@ class CRYGate(ControlledGate):
         which in our case would be q_1. Thus a textbook matrix for this
         gate will be:
 
-        .. parsed-literal::
+        .. code-block:: text
+
                  ┌───────┐
             q_0: ┤ Ry(ϴ) ├
                  └───┬───┘

qiskit/circuit/library/standard_gates/ryy.py

@@ -33,7 +33,7 @@ class RYYGate(Gate):
 
     **Circuit Symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌─────────┐
         q_0: ┤1        ├
@@ -63,7 +63,7 @@ class RYYGate(Gate):
 
         .. math::
 
-            R_{YY}(\theta = \pi) = i Y \otimes Y
+            R_{YY}(\theta = \pi) = -i Y \otimes Y
 
         .. math::
 

qiskit/circuit/library/standard_gates/rz.py

@@ -34,7 +34,7 @@ class RZGate(Gate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌───────┐
         q_0: ┤ Rz(λ) ├
@@ -174,24 +174,24 @@ class CRZGate(ControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ────■────
              ┌───┴───┐
-        q_1: ┤ Rz(λ) ├
+        q_1: ┤ Rz(θ) ├
              └───────┘
 
     **Matrix representation:**
 
     .. math::
 
-        CRZ(\lambda)\ q_0, q_1 =
-            I \otimes |0\rangle\langle 0| + RZ(\lambda) \otimes |1\rangle\langle 1| =
+        CRZ(\theta)\ q_0, q_1 =
+            I \otimes |0\rangle\langle 0| + RZ(\theta) \otimes |1\rangle\langle 1| =
             \begin{pmatrix}
                 1 & 0 & 0 & 0 \\
                 0 & e^{-i\frac{\lambda}{2}} & 0 & 0 \\
                 0 & 0 & 1 & 0 \\
-                0 & 0 & 0 & e^{i\frac{\lambda}{2}}
+                0 & 0 & 0 & e^{i\frac{\theta}{2}}
             \end{pmatrix}
 
     .. note::
@@ -202,21 +202,22 @@ class CRZGate(ControlledGate):
         which in our case would be q_1. Thus a textbook matrix for this
         gate will be:
 
-        .. parsed-literal::
+        .. code-block:: text
+
                  ┌───────┐
-            q_0: ┤ Rz(λ) ├
+            q_0: ┤ Rz(θ) ├
                  └───┬───┘
             q_1: ────■────
 
         .. math::
 
-            CRZ(\lambda)\ q_1, q_0 =
-                |0\rangle\langle 0| \otimes I + |1\rangle\langle 1| \otimes RZ(\lambda) =
+            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{\lambda}{2}} & 0 \\
-                    0 & 0 & 0 & e^{i\frac{\lambda}{2}}
+                    0 & 0 & e^{-i\frac{\theta}{2}} & 0 \\
+                    0 & 0 & 0 & e^{i\frac{\theta}{2}}
                 \end{pmatrix}
 
     .. seealso::

qiskit/circuit/library/standard_gates/rzx.py

@@ -35,7 +35,7 @@ class RZXGate(Gate):
 
     **Circuit Symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌─────────┐
         q_0: ┤0        ├
@@ -65,7 +65,7 @@ class RZXGate(Gate):
         Instead, if we apply it on (q_1, q_0), the matrix will
         be :math:`Z \otimes X`:
 
-        .. parsed-literal::
+        .. code-block:: text
 
                  ┌─────────┐
             q_0: ┤1        ├
@@ -100,19 +100,19 @@ class RZXGate(Gate):
 
         .. math::
 
-            R_{ZX}(\theta = 0) = I
+            R_{ZX}(\theta = 0)\ q_0, q_1 = I
 
         .. math::
 
-            R_{ZX}(\theta = 2\pi) = -I
+            R_{ZX}(\theta = 2\pi)\ q_0, q_1 = -I
 
         .. math::
 
-            R_{ZX}(\theta = \pi) = -i Z \otimes X
+            R_{ZX}(\theta = \pi)\ q_0, q_1 = -i X \otimes Z
 
         .. math::
 
-            RZX(\theta = \frac{\pi}{2}) = \frac{1}{\sqrt{2}}
+            R_{ZX}(\theta = \frac{\pi}{2})\ q_0, q_1 = \frac{1}{\sqrt{2}}
                                     \begin{pmatrix}
                                         1  & 0 & -i & 0 \\
                                         0  & 1 & 0  & i \\

qiskit/circuit/library/standard_gates/rzz.py

@@ -32,7 +32,7 @@ class RZZGate(Gate):
 
     **Circuit Symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ───■────
                 │zz(θ)

qiskit/circuit/library/standard_gates/s.py

@@ -51,7 +51,7 @@ class SGate(SingletonGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌───┐
         q_0: ┤ S ├
@@ -163,7 +163,7 @@ class SdgGate(SingletonGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌─────┐
         q_0: ┤ Sdg ├
@@ -262,7 +262,7 @@ class CSGate(SingletonControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ──■──
              ┌─┴─┐
@@ -350,7 +350,7 @@ class CSdgGate(SingletonControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ───■───
              ┌──┴──┐

qiskit/circuit/library/standard_gates/swap.py

@@ -36,7 +36,7 @@ class SwapGate(SingletonGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ─X─
               │
@@ -150,7 +150,7 @@ class CSwapGate(SingletonControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ─■─
               │
@@ -185,7 +185,7 @@ class CSwapGate(SingletonControlledGate):
         which in our case would be q_2. Thus a textbook matrix for this
         gate will be:
 
-        .. parsed-literal::
+        .. code-block:: text
 
             q_0: ─X─
                   │

qiskit/circuit/library/standard_gates/sx.py

@@ -44,7 +44,7 @@ class SXGate(SingletonGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌────┐
         q_0: ┤ √X ├
@@ -220,7 +220,7 @@ class CSXGate(SingletonControlledGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
         q_0: ──■──
              ┌─┴──┐
@@ -249,7 +249,8 @@ class CSXGate(SingletonControlledGate):
         which in our case would be `q_1`. Thus a textbook matrix for this
         gate will be:
 
-        .. parsed-literal::
+        .. code-block:: text
+
                  ┌────┐
             q_0: ┤ √X ├
                  └─┬──┘

qiskit/circuit/library/standard_gates/t.py

@@ -47,7 +47,7 @@ class TGate(SingletonGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌───┐
         q_0: ┤ T ├
@@ -124,7 +124,7 @@ class TdgGate(SingletonGate):
 
     **Circuit symbol:**
 
-    .. parsed-literal::
+    .. code-block:: text
 
              ┌─────┐
         q_0: ┤ Tdg ├