Add duration and unit kwargs to __init__ for all standard gates (#11013)

* Add duration and unit to kwargs for all standard_gates * Add release notes * Make duration and unit keyword only * Normalise all standard-library gate signatures This corrects a couple of places that had `unit=None` instead of `unit="dt", and makes sure that all gates in a given file have the right signature. * Fix bad default argument --------- Co-authored-by: Jake Lishman <[email protected]>
Qiskit · Oct 19, 2023 · 9f3a7cf · 9f3a7cf
1 parent cefd6a3
commit 9f3a7cf
Show file tree

Hide file tree

Showing 20 changed files with 166 additions and 45 deletions.
diff --git a/qiskit/circuit/library/standard_gates/global_phase.py b/qiskit/circuit/library/standard_gates/global_phase.py
@@ -34,13 +34,15 @@ class GlobalPhaseGate(Gate):
             \end{pmatrix}
     """
 
-    def __init__(self, phase: ParameterValueType, label: Optional[str] = None):
+    def __init__(
+        self, phase: ParameterValueType, label: Optional[str] = None, *, duration=None, unit="dt"
+    ):
         """
         Args:
             phase: The value of phase it takes.
             label: An optional label for the gate.
         """
-        super().__init__("global_phase", 0, [phase], label=label)
+        super().__init__("global_phase", 0, [phase], label=label, duration=duration, unit=unit)
 
     def _define(self):
         q = QuantumRegister(0, "q")

diff --git a/qiskit/circuit/library/standard_gates/p.py b/qiskit/circuit/library/standard_gates/p.py
@@ -75,9 +75,11 @@ class PhaseGate(Gate):
         `1612.00858 <https://arxiv.org/abs/1612.00858>`_
     """
 
-    def __init__(self, theta: ParameterValueType, label: str | None = None):
+    def __init__(
+        self, theta: ParameterValueType, label: str | None = None, *, duration=None, unit="dt"
+    ):
         """Create new Phase gate."""
-        super().__init__("p", 1, [theta], label=label)
+        super().__init__("p", 1, [theta], label=label, duration=duration, unit=unit)
 
     def _define(self):
         # pylint: disable=cyclic-import
@@ -177,6 +179,10 @@ def __init__(
         theta: ParameterValueType,
         label: str | None = None,
         ctrl_state: str | int | None = None,
+        *,
+        duration=None,
+        unit="dt",
+        _base_label=None,
     ):
         """Create new CPhase gate."""
         super().__init__(
@@ -186,7 +192,9 @@ def __init__(
             num_ctrl_qubits=1,
             label=label,
             ctrl_state=ctrl_state,
-            base_gate=PhaseGate(theta),
+            base_gate=PhaseGate(theta, label=_base_label),
+            duration=duration,
+            unit=unit,
         )
 
     def _define(self):
@@ -284,15 +292,26 @@ class MCPhaseGate(ControlledGate):
         The singly-controlled-version of this gate.
     """
 
-    def __init__(self, lam: ParameterValueType, num_ctrl_qubits: int, label: str | None = None):
+    def __init__(
+        self,
+        lam: ParameterValueType,
+        num_ctrl_qubits: int,
+        label: str | None = None,
+        *,
+        duration=None,
+        unit="dt",
+        _base_label=None,
+    ):
         """Create new MCPhase gate."""
         super().__init__(
             "mcphase",
             num_ctrl_qubits + 1,
             [lam],
             num_ctrl_qubits=num_ctrl_qubits,
             label=label,
-            base_gate=PhaseGate(lam),
+            base_gate=PhaseGate(lam, label=_base_label),
+            duration=duration,
+            unit=unit,
         )
 
     def _define(self):

diff --git a/qiskit/circuit/library/standard_gates/r.py b/qiskit/circuit/library/standard_gates/r.py
@@ -50,10 +50,16 @@ class RGate(Gate):
     """
 
     def __init__(
-        self, theta: ParameterValueType, phi: ParameterValueType, label: Optional[str] = None
+        self,
+        theta: ParameterValueType,
+        phi: ParameterValueType,
+        label: Optional[str] = None,
+        *,
+        duration=None,
+        unit="dt",
     ):
         """Create new r single-qubit gate."""
-        super().__init__("r", 1, [theta, phi], label=label)
+        super().__init__("r", 1, [theta, phi], label=label, duration=duration, unit=unit)
 
     def _define(self):
         """

diff --git a/qiskit/circuit/library/standard_gates/rx.py b/qiskit/circuit/library/standard_gates/rx.py
@@ -50,9 +50,11 @@ class RXGate(Gate):
             \end{pmatrix}
     """
 
-    def __init__(self, theta: ParameterValueType, label: Optional[str] = None):
+    def __init__(
+        self, theta: ParameterValueType, label: Optional[str] = None, *, duration=None, unit="dt"
+    ):
         """Create new RX gate."""
-        super().__init__("rx", 1, [theta], label=label)
+        super().__init__("rx", 1, [theta], label=label, duration=duration, unit=unit)
 
     def _define(self):
         """
@@ -175,6 +177,10 @@ def __init__(
         theta: ParameterValueType,
         label: Optional[str] = None,
         ctrl_state: Optional[Union[str, int]] = None,
+        *,
+        duration=None,
+        unit="dt",
+        _base_label=None,
     ):
         """Create new CRX gate."""
         super().__init__(
@@ -184,7 +190,7 @@ def __init__(
             num_ctrl_qubits=1,
             label=label,
             ctrl_state=ctrl_state,
-            base_gate=RXGate(theta),
+            base_gate=RXGate(theta, label=_base_label),
         )
 
     def _define(self):

diff --git a/qiskit/circuit/library/standard_gates/rxx.py b/qiskit/circuit/library/standard_gates/rxx.py
@@ -72,9 +72,11 @@ class RXXGate(Gate):
                                     \end{pmatrix}
     """
 
-    def __init__(self, theta: ParameterValueType, label: Optional[str] = None):
+    def __init__(
+        self, theta: ParameterValueType, label: Optional[str] = None, *, duration=None, unit="dt"
+    ):
         """Create new RXX gate."""
-        super().__init__("rxx", 2, [theta], label=label)
+        super().__init__("rxx", 2, [theta], label=label, duration=duration, unit=unit)
 
     def _define(self):
         """Calculate a subcircuit that implements this unitary."""

diff --git a/qiskit/circuit/library/standard_gates/ry.py b/qiskit/circuit/library/standard_gates/ry.py
@@ -49,9 +49,11 @@ class RYGate(Gate):
             \end{pmatrix}
     """
 
-    def __init__(self, theta: ParameterValueType, label: Optional[str] = None):
+    def __init__(
+        self, theta: ParameterValueType, label: Optional[str] = None, *, duration=None, unit="dt"
+    ):
         """Create new RY gate."""
-        super().__init__("ry", 1, [theta], label=label)
+        super().__init__("ry", 1, [theta], label=label, duration=duration, unit=unit)
 
     def _define(self):
         """
@@ -174,6 +176,10 @@ def __init__(
         theta: ParameterValueType,
         label: Optional[str] = None,
         ctrl_state: Optional[Union[str, int]] = None,
+        *,
+        duration=None,
+        unit="dt",
+        _base_label=None,
     ):
         """Create new CRY gate."""
         super().__init__(
@@ -183,7 +189,9 @@ def __init__(
             num_ctrl_qubits=1,
             label=label,
             ctrl_state=ctrl_state,
-            base_gate=RYGate(theta),
+            base_gate=RYGate(theta, label=_base_label),
+            duration=duration,
+            unit=unit,
         )
 
     def _define(self):

diff --git a/qiskit/circuit/library/standard_gates/ryy.py b/qiskit/circuit/library/standard_gates/ryy.py
@@ -72,9 +72,11 @@ class RYYGate(Gate):
                                     \end{pmatrix}
     """
 
-    def __init__(self, theta: ParameterValueType, label: Optional[str] = None):
+    def __init__(
+        self, theta: ParameterValueType, label: Optional[str] = None, *, duration=None, unit="dt"
+    ):
         """Create new RYY gate."""
-        super().__init__("ryy", 2, [theta], label=label)
+        super().__init__("ryy", 2, [theta], label=label, duration=duration, unit=unit)
 
     def _define(self):
         """Calculate a subcircuit that implements this unitary."""

diff --git a/qiskit/circuit/library/standard_gates/rz.py b/qiskit/circuit/library/standard_gates/rz.py
@@ -59,9 +59,11 @@ class RZGate(Gate):
         `1612.00858 <https://arxiv.org/abs/1612.00858>`_
     """
 
-    def __init__(self, phi: ParameterValueType, label: Optional[str] = None):
+    def __init__(
+        self, phi: ParameterValueType, label: Optional[str] = None, *, duration=None, unit="dt"
+    ):
         """Create new RZ gate."""
-        super().__init__("rz", 1, [phi], label=label)
+        super().__init__("rz", 1, [phi], label=label, duration=duration, unit=unit)
 
     def _define(self):
         """
@@ -192,6 +194,10 @@ def __init__(
         theta: ParameterValueType,
         label: Optional[str] = None,
         ctrl_state: Optional[Union[str, int]] = None,
+        *,
+        duration=None,
+        unit="dt",
+        _base_label=None,
     ):
         """Create new CRZ gate."""
         super().__init__(
@@ -201,7 +207,9 @@ def __init__(
             num_ctrl_qubits=1,
             label=label,
             ctrl_state=ctrl_state,
-            base_gate=RZGate(theta),
+            base_gate=RZGate(theta, label=_base_label),
+            duration=duration,
+            unit=unit,
         )
 
     def _define(self):

diff --git a/qiskit/circuit/library/standard_gates/rzx.py b/qiskit/circuit/library/standard_gates/rzx.py
@@ -117,9 +117,11 @@ class RZXGate(Gate):
                                     \end{pmatrix}
     """
 
-    def __init__(self, theta: ParameterValueType, label: Optional[str] = None):
+    def __init__(
+        self, theta: ParameterValueType, label: Optional[str] = None, *, duration=None, unit="dt"
+    ):
         """Create new RZX gate."""
-        super().__init__("rzx", 2, [theta], label=label)
+        super().__init__("rzx", 2, [theta], label=label, duration=duration, unit=unit)
 
     def _define(self):
         """

diff --git a/qiskit/circuit/library/standard_gates/rzz.py b/qiskit/circuit/library/standard_gates/rzz.py
@@ -84,9 +84,11 @@ class RZZGate(Gate):
                                     \end{pmatrix}
     """
 
-    def __init__(self, theta: ParameterValueType, label: Optional[str] = None):
+    def __init__(
+        self, theta: ParameterValueType, label: Optional[str] = None, *, duration=None, unit="dt"
+    ):
         """Create new RZZ gate."""
-        super().__init__("rzz", 2, [theta], label=label)
+        super().__init__("rzz", 2, [theta], label=label, duration=duration, unit=unit)
 
     def _define(self):
         """

diff --git a/qiskit/circuit/library/standard_gates/s.py b/qiskit/circuit/library/standard_gates/s.py
@@ -59,7 +59,7 @@ class SGate(SingletonGate):
 
     def __init__(self, label: Optional[str] = None, *, duration=None, unit="dt"):
         """Create new S gate."""
-        super().__init__("s", 1, [], label=label, duration=None, unit="dt")
+        super().__init__("s", 1, [], label=label, duration=duration, unit=unit)
 
     _singleton_lookup_key = stdlib_singleton_key()
 
@@ -124,7 +124,7 @@ class SdgGate(SingletonGate):
 
     def __init__(self, label: Optional[str] = None, *, duration=None, unit="dt"):
         """Create new Sdg gate."""
-        super().__init__("sdg", 1, [], label=label, duration=None, unit="dt")
+        super().__init__("sdg", 1, [], label=label, duration=duration, unit=unit)
 
     _singleton_lookup_key = stdlib_singleton_key()
 

diff --git a/qiskit/circuit/library/standard_gates/u.py b/qiskit/circuit/library/standard_gates/u.py
@@ -73,9 +73,12 @@ def __init__(
         phi: ParameterValueType,
         lam: ParameterValueType,
         label: Optional[str] = None,
+        *,
+        duration=None,
+        unit="dt",
     ):
         """Create new U gate."""
-        super().__init__("u", 1, [theta, phi, lam], label=label)
+        super().__init__("u", 1, [theta, phi, lam], label=label, duration=duration, unit=unit)
 
     def inverse(self):
         r"""Return inverted U gate.
@@ -234,6 +237,10 @@ def __init__(
         gamma: ParameterValueType,
         label: Optional[str] = None,
         ctrl_state: Optional[Union[str, int]] = None,
+        *,
+        duration=None,
+        unit="dt",
+        _base_label=None,
     ):
         """Create new CU gate."""
         super().__init__(
@@ -243,7 +250,9 @@ def __init__(
             num_ctrl_qubits=1,
             label=label,
             ctrl_state=ctrl_state,
-            base_gate=UGate(theta, phi, lam),
+            base_gate=UGate(theta, phi, lam, label=_base_label),
+            duration=duration,
+            unit=unit,
         )
 
     def _define(self):

diff --git a/qiskit/circuit/library/standard_gates/u1.py b/qiskit/circuit/library/standard_gates/u1.py
@@ -92,9 +92,11 @@ class U1Gate(Gate):
         `1612.00858 <https://arxiv.org/abs/1612.00858>`_
     """
 
-    def __init__(self, theta: ParameterValueType, label: str | None = None):
+    def __init__(
+        self, theta: ParameterValueType, label: str | None = None, *, duration=None, unit="dt"
+    ):
         """Create new U1 gate."""
-        super().__init__("u1", 1, [theta], label=label)
+        super().__init__("u1", 1, [theta], label=label, duration=duration, unit=unit)
 
     def _define(self):
         # pylint: disable=cyclic-import
@@ -189,6 +191,10 @@ def __init__(
         theta: ParameterValueType,
         label: str | None = None,
         ctrl_state: str | int | None = None,
+        *,
+        duration=None,
+        unit="dt",
+        _base_label=None,
     ):
         """Create new CU1 gate."""
         super().__init__(
@@ -198,7 +204,9 @@ def __init__(
             num_ctrl_qubits=1,
             label=label,
             ctrl_state=ctrl_state,
-            base_gate=U1Gate(theta),
+            base_gate=U1Gate(theta, label=_base_label),
+            duration=duration,
+            unit=unit,
         )
 
     def _define(self):
@@ -303,6 +311,10 @@ def __init__(
         num_ctrl_qubits: int,
         label: str | None = None,
         ctrl_state: str | int | None = None,
+        *,
+        duration=None,
+        unit="dt",
+        _base_label=None,
     ):
         """Create new MCU1 gate."""
         super().__init__(
@@ -312,7 +324,9 @@ def __init__(
             num_ctrl_qubits=num_ctrl_qubits,
             label=label,
             ctrl_state=ctrl_state,
-            base_gate=U1Gate(lam),
+            base_gate=U1Gate(lam, label=_base_label),
+            duration=duration,
+            unit=unit,
         )
 
     def _define(self):

diff --git a/qiskit/circuit/library/standard_gates/u2.py b/qiskit/circuit/library/standard_gates/u2.py
@@ -87,10 +87,16 @@ class U2Gate(Gate):
     """
 
     def __init__(
-        self, phi: ParameterValueType, lam: ParameterValueType, label: Optional[str] = None
+        self,
+        phi: ParameterValueType,
+        lam: ParameterValueType,
+        label: Optional[str] = None,
+        *,
+        duration=None,
+        unit="dt",
     ):
         """Create new U2 gate."""
-        super().__init__("u2", 1, [phi, lam], label=label)
+        super().__init__("u2", 1, [phi, lam], label=label, duration=duration, unit=unit)
 
     def _define(self):
         # pylint: disable=cyclic-import