qiskit 1.3.0__cp39-abi3-macosx_11_0_arm64.whl

qiskit/circuit/library/generalized_gates/ucrx.py

@@ -0,0 +1,32 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 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.
+
+"""Uniformly controlled Pauli-X rotations."""
+
+from __future__ import annotations
+
+from .uc_pauli_rot import UCPauliRotGate
+
+
+class UCRXGate(UCPauliRotGate):
+    r"""Uniformly controlled Pauli-X rotations.
+
+    Implements the :class:`.UCGate` for the special case that all unitaries are Pauli-X rotations,
+    :math:`U_i = R_X(a_i)` where :math:`a_i \in \mathbb{R}` is the rotation angle.
+    """
+
+    def __init__(self, angle_list: list[float]) -> None:
+        r"""
+        Args:
+            angle_list: List of rotation angles :math:`[a_0, ..., a_{2^{k-1}}]`.
+        """
+        super().__init__(angle_list, "X")

qiskit/circuit/library/generalized_gates/ucry.py

@@ -0,0 +1,32 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 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.
+
+"""Uniformly controlled Pauli-Y rotations."""
+
+from __future__ import annotations
+
+from .uc_pauli_rot import UCPauliRotGate
+
+
+class UCRYGate(UCPauliRotGate):
+    r"""Uniformly controlled Pauli-Y rotations.
+
+    Implements the :class:`.UCGate` for the special case that all unitaries are Pauli-Y rotations,
+    :math:`U_i = R_Y(a_i)` where :math:`a_i \in \mathbb{R}` is the rotation angle.
+    """
+
+    def __init__(self, angle_list: list[float]) -> None:
+        r"""
+        Args:
+            angle_list: List of rotation angles :math:`[a_0, ..., a_{2^{k-1}}]`.
+        """
+        super().__init__(angle_list, "Y")

qiskit/circuit/library/generalized_gates/ucrz.py

@@ -0,0 +1,32 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 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.
+
+"""Uniformly controlled Pauli-Z rotations."""
+
+from __future__ import annotations
+
+from .uc_pauli_rot import UCPauliRotGate
+
+
+class UCRZGate(UCPauliRotGate):
+    r"""Uniformly controlled Pauli-Z rotations.
+
+    Implements the :class:`.UCGate` for the special case that all unitaries are Pauli-Z rotations,
+    :math:`U_i = R_Z(a_i)` where :math:`a_i \in \mathbb{R}` is the rotation angle.
+    """
+
+    def __init__(self, angle_list: list[float]):
+        r"""
+        Args:
+            angle_list: List of rotation angles :math:`[a_0, ..., a_{2^{k-1}}]`.
+        """
+        super().__init__(angle_list, "Z")

qiskit/circuit/library/generalized_gates/unitary.py

@@ -0,0 +1,215 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2024.
+#
+# 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.
+
+"""Arbitrary unitary circuit instruction."""
+
+from __future__ import annotations
+import math
+
+import typing
+import numpy
+
+from qiskit import _numpy_compat
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.controlledgate import ControlledGate
+from qiskit.circuit.annotated_operation import AnnotatedOperation, ControlModifier
+from qiskit.circuit.quantumcircuit import QuantumCircuit
+from qiskit.circuit.quantumregister import QuantumRegister
+from qiskit.circuit.exceptions import CircuitError
+from qiskit.circuit._utils import _compute_control_matrix
+from qiskit.circuit.library.standard_gates.u import UGate
+from qiskit.quantum_info.operators.predicates import matrix_equal
+from qiskit.quantum_info.operators.predicates import is_unitary_matrix
+
+from .isometry import Isometry
+
+if typing.TYPE_CHECKING:
+    from qiskit.quantum_info.operators.base_operator import BaseOperator
+
+
+class UnitaryGate(Gate):
+    """Class quantum gates specified by a unitary matrix.
+
+    Example:
+
+        We can create a unitary gate from a unitary matrix then add it to a
+        quantum circuit. The matrix can also be directly applied to the quantum
+        circuit, see :meth:`.QuantumCircuit.unitary`.
+
+        .. code-block:: python
+
+            from qiskit import QuantumCircuit
+            from qiskit.circuit.library import UnitaryGate
+
+            matrix = [[0, 0, 0, 1],
+                      [0, 0, 1, 0],
+                      [1, 0, 0, 0],
+                      [0, 1, 0, 0]]
+            gate = UnitaryGate(matrix)
+
+            circuit = QuantumCircuit(2)
+            circuit.append(gate, [0, 1])
+    """
+
+    def __init__(
+        self,
+        data: numpy.ndarray | Gate | BaseOperator,
+        label: str | None = None,
+        check_input: bool = True,
+        *,
+        num_qubits: int | None = None,
+    ) -> None:
+        """Create a gate from a numeric unitary matrix.
+
+        Args:
+            data: Unitary operator.
+            label: Unitary name for backend [Default: ``None``].
+            check_input: If set to ``False`` this asserts the input
+                is known to be unitary and the checking to validate this will
+                be skipped. This should only ever be used if you know the
+                input is unitary, setting this to ``False`` and passing in
+                a non-unitary matrix will result unexpected behavior and errors.
+            num_qubits: If given, the number of qubits in the matrix.  If not given, it is inferred.
+
+        Raises:
+            ValueError: If input data is not an N-qubit unitary operator.
+        """
+        if hasattr(data, "to_matrix"):
+            # If input is Gate subclass or some other class object that has
+            # a to_matrix method this will call that method.
+            data = data.to_matrix()
+        elif hasattr(data, "to_operator"):
+            # If input is a BaseOperator subclass this attempts to convert
+            # the object to an Operator so that we can extract the underlying
+            # numpy matrix from `Operator.data`.
+            data = data.to_operator().data
+        # Convert to numpy array in case not already an array
+        data = numpy.asarray(data, dtype=complex)
+        input_dim, output_dim = data.shape
+        num_qubits = num_qubits if num_qubits is not None else int(math.log2(input_dim))
+        if check_input:
+            # Check input is unitary
+            if not is_unitary_matrix(data):
+                raise ValueError("Input matrix is not unitary.")
+            # Check input is N-qubit matrix
+            if input_dim != output_dim or 2**num_qubits != input_dim:
+                raise ValueError("Input matrix is not an N-qubit operator.")
+        # Store instruction params
+        super().__init__("unitary", num_qubits, [data], label=label)
+
+    def __eq__(self, other):
+        if not isinstance(other, UnitaryGate):
+            return False
+        if self.label != other.label:
+            return False
+        return matrix_equal(self.params[0], other.params[0])
+
+    def __array__(self, dtype=None, copy=_numpy_compat.COPY_ONLY_IF_NEEDED):
+        """Return matrix for the unitary."""
+        dtype = self.params[0].dtype if dtype is None else dtype
+        return numpy.array(self.params[0], dtype=dtype, copy=copy)
+
+    def inverse(self, annotated: bool = False):
+        """Return the adjoint of the unitary."""
+        return self.adjoint()
+
+    def conjugate(self):
+        """Return the conjugate of the unitary."""
+        return UnitaryGate(numpy.conj(self.to_matrix()))
+
+    def adjoint(self):
+        """Return the adjoint of the unitary."""
+        return self.transpose().conjugate()
+
+    def transpose(self):
+        """Return the transpose of the unitary."""
+        return UnitaryGate(numpy.transpose(self.to_matrix()))
+
+    def _define(self):
+        """Calculate a subcircuit that implements this unitary."""
+        if self.num_qubits == 1:
+            from qiskit.synthesis.one_qubit.one_qubit_decompose import OneQubitEulerDecomposer
+
+            q = QuantumRegister(1, "q")
+            qc = QuantumCircuit(q, name=self.name)
+            theta, phi, lam, global_phase = OneQubitEulerDecomposer("U").angles_and_phase(
+                self.to_matrix()
+            )
+            qc._append(UGate(theta, phi, lam), [q[0]], [])
+            qc.global_phase = global_phase
+            self.definition = qc
+        elif self.num_qubits == 2:
+            from qiskit.synthesis.two_qubit.two_qubit_decompose import (  # pylint: disable=cyclic-import
+                two_qubit_cnot_decompose,
+            )
+
+            self.definition = two_qubit_cnot_decompose(self.to_matrix())
+        else:
+            from qiskit.synthesis.unitary.qsd import (  # pylint: disable=cyclic-import
+                qs_decomposition,
+            )
+
+            self.definition = qs_decomposition(self.to_matrix())
+
+    def control(
+        self,
+        num_ctrl_qubits: int = 1,
+        label: str | None = None,
+        ctrl_state: int | str | None = None,
+        annotated: bool | None = None,
+    ) -> ControlledGate | AnnotatedOperation:
+        """Return controlled version of gate.
+
+        Args:
+            num_ctrl_qubits: Number of controls to add to gate (default is 1).
+            label: Optional gate label.
+            ctrl_state: The control state in decimal or as a bit string (e.g. ``"1011"``).
+                If ``None``, use ``2**num_ctrl_qubits - 1``.
+            annotated: indicates whether the controlled gate should be implemented
+                as an annotated gate. If ``None``, this is handled as ``False``.
+
+        Returns:
+            Controlled version of gate.
+        """
+        if not annotated:
+            mat = self.to_matrix()
+            cmat = _compute_control_matrix(mat, num_ctrl_qubits, ctrl_state=None)
+            iso = Isometry(cmat, 0, 0)
+            gate = ControlledGate(
+                "c-unitary",
+                num_qubits=self.num_qubits + num_ctrl_qubits,
+                params=[mat],
+                label=label,
+                num_ctrl_qubits=num_ctrl_qubits,
+                definition=iso.definition,
+                ctrl_state=ctrl_state,
+                base_gate=self.copy(),
+            )
+        else:
+            gate = AnnotatedOperation(
+                self, ControlModifier(num_ctrl_qubits=num_ctrl_qubits, ctrl_state=ctrl_state)
+            )
+        return gate
+
+    def _qasm2_decomposition(self):
+        """Return an unparameterized version of ourselves, so the OQ2 exporter doesn't choke on the
+        non-standard things in our `params` field."""
+        out = self.definition.to_gate()
+        out.name = self.name
+        return out
+
+    def validate_parameter(self, parameter):
+        """Unitary gate parameter has to be an ndarray."""
+        if isinstance(parameter, numpy.ndarray):
+            return parameter
+        else:
+            raise CircuitError(f"invalid param type {type(parameter)} in gate {self.name}")

qiskit/circuit/library/graph_state.py

@@ -0,0 +1,169 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2024.
+#
+# 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.
+
+"""Graph State circuit and gate."""
+
+from __future__ import annotations
+
+import numpy as np
+from qiskit.circuit.quantumcircuit import QuantumCircuit, Gate
+from qiskit.circuit.exceptions import CircuitError
+from qiskit.utils.deprecation import deprecate_func
+
+
+class GraphState(QuantumCircuit):
+    r"""Circuit to prepare a graph state.
+
+    Given a graph G = (V, E), with the set of vertices V and the set of edges E,
+    the corresponding graph state is defined as
+
+    .. math::
+
+        |G\rangle = \prod_{(a,b) \in E} CZ_{(a,b)} {|+\rangle}^{\otimes V}
+
+    Such a state can be prepared by first preparing all qubits in the :math:`+`
+    state, then applying a :math:`CZ` gate for each corresponding graph edge.
+
+    Graph state preparation circuits are Clifford circuits, and thus
+    easy to simulate classically. However, by adding a layer of measurements
+    in a product basis at the end, there is evidence that the circuit becomes
+    hard to simulate [2].
+
+    **Reference Circuit:**
+
+    .. plot::
+
+       from qiskit.circuit.library import GraphState
+       from qiskit.visualization.library import _generate_circuit_library_visualization
+       import rustworkx as rx
+       G = rx.generators.cycle_graph(5)
+       circuit = GraphState(rx.adjacency_matrix(G))
+       _generate_circuit_library_visualization(circuit)
+
+    **References:**
+
+    [1] M. Hein, J. Eisert, H.J. Briegel, Multi-party Entanglement in Graph States,
+        `arXiv:0307130 <https://arxiv.org/pdf/quant-ph/0307130.pdf>`_
+    [2] D. Koh, Further Extensions of Clifford Circuits & their Classical Simulation Complexities.
+        `arXiv:1512.07892 <https://arxiv.org/pdf/1512.07892.pdf>`_
+    """
+
+    @deprecate_func(
+        since="1.3",
+        additional_msg="Use qiskit.circuit.library.GraphStateGate instead.",
+        pending=True,
+    )
+    def __init__(self, adjacency_matrix: list | np.ndarray) -> None:
+        """Create graph state preparation circuit.
+
+        Args:
+            adjacency_matrix: input graph as n-by-n list of 0-1 lists
+
+        Raises:
+            CircuitError: If adjacency_matrix is not symmetric.
+
+        The circuit prepares a graph state with the given adjacency
+        matrix.
+        """
+
+        adjacency_matrix = np.asarray(adjacency_matrix)
+        if not np.allclose(adjacency_matrix, adjacency_matrix.transpose()):
+            raise CircuitError("The adjacency matrix must be symmetric.")
+
+        graph_state_gate = GraphStateGate(adjacency_matrix)
+        super().__init__(graph_state_gate.num_qubits, name=f"graph: {adjacency_matrix}")
+        self.compose(graph_state_gate, qubits=self.qubits, inplace=True)
+
+
+class GraphStateGate(Gate):
+    r"""A gate representing a graph state.
+
+    Given a graph G = (V, E), with the set of vertices V and the set of edges E,
+    the corresponding graph state is defined as
+
+    .. math::
+
+        |G\rangle = \prod_{(a,b) \in E} CZ_{(a,b)} {|+\rangle}^{\otimes V}
+
+    Such a state can be prepared by first preparing all qubits in the :math:`+`
+    state, then applying a :math:`CZ` gate for each corresponding graph edge.
+
+    Graph state preparation circuits are Clifford circuits, and thus
+    easy to simulate classically. However, by adding a layer of measurements
+    in a product basis at the end, there is evidence that the circuit becomes
+    hard to simulate [2].
+
+    **Reference Circuit:**
+
+    .. plot::
+        :include-source:
+
+        from qiskit.circuit import QuantumCircuit
+        from qiskit.circuit.library import GraphStateGate
+        import rustworkx as rx
+
+        G = rx.generators.cycle_graph(5)
+        circuit = QuantumCircuit(5)
+        circuit.append(GraphStateGate(rx.adjacency_matrix(G)), [0, 1, 2, 3, 4])
+        circuit.decompose().draw('mpl')
+
+    **References:**
+
+    [1] M. Hein, J. Eisert, H.J. Briegel, Multi-party Entanglement in Graph States,
+        `arXiv:0307130 <https://arxiv.org/pdf/quant-ph/0307130.pdf>`_
+    [2] D. Koh, Further Extensions of Clifford Circuits & their Classical Simulation Complexities.
+        `arXiv:1512.07892 <https://arxiv.org/pdf/1512.07892.pdf>`_
+    """
+
+    def __init__(self, adjacency_matrix: list | np.ndarray) -> None:
+        """
+        Args:
+            adjacency_matrix: input graph as n-by-n list of 0-1 lists
+
+        Raises:
+            CircuitError: If adjacency_matrix is not symmetric.
+
+        The gate represents a graph state with the given adjacency matrix.
+        """
+
+        adjacency_matrix = np.asarray(adjacency_matrix)
+        if not np.allclose(adjacency_matrix, adjacency_matrix.transpose()):
+            raise CircuitError("The adjacency matrix must be symmetric.")
+        num_qubits = len(adjacency_matrix)
+
+        super().__init__(name="graph_state", num_qubits=num_qubits, params=[adjacency_matrix])
+
+    def _define(self):
+        adjacency_matrix = self.adjacency_matrix
+        circuit = QuantumCircuit(self.num_qubits, name=self.name)
+        circuit.h(range(self.num_qubits))
+        for i in range(self.num_qubits):
+            for j in range(i + 1, self.num_qubits):
+                if adjacency_matrix[i][j] == 1:
+                    circuit.cz(i, j)
+        self.definition = circuit
+
+    def validate_parameter(self, parameter):
+        """Parameter validation"""
+        return parameter
+
+    @property
+    def adjacency_matrix(self):
+        """Returns the adjacency matrix."""
+        return self.params[0]
+
+    def __eq__(self, other):
+        return (
+            isinstance(other, GraphStateGate)
+            and self.num_qubits == other.num_qubits
+            and np.all(self.adjacency_matrix == other.adjacency_matrix)
+        )