qiskit 2.1.0rc1__cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

qiskit/circuit/library/hamiltonian_gate.py

@@ -0,0 +1,142 @@
+# 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.
+
+"""
+Gate described by the time evolution of a Hermitian Hamiltonian operator.
+"""
+
+from __future__ import annotations
+import math
+import typing
+
+from numbers import Number
+import numpy as np
+
+from qiskit import _numpy_compat
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.quantumcircuit import QuantumCircuit
+from qiskit.circuit import QuantumRegister
+from qiskit.circuit.parameterexpression import ParameterExpression
+from qiskit.circuit.exceptions import CircuitError
+from qiskit.quantum_info.operators.predicates import matrix_equal
+from qiskit.quantum_info.operators.predicates import is_hermitian_matrix
+
+from .generalized_gates.unitary import UnitaryGate
+
+if typing.TYPE_CHECKING:
+    from qiskit.quantum_info.operators.base_operator import BaseOperator
+
+
+class HamiltonianGate(Gate):
+    r"""Class for representing evolution by a Hamiltonian operator as a gate.
+
+    This gate resolves to a :class:`~.library.UnitaryGate` as :math:`U(t) = \exp(-i t H)`,
+    which can be decomposed into basis gates if it is 2 qubits or less, or
+    simulated directly in Aer for more qubits.
+    """
+
+    def __init__(
+        self,
+        data: np.ndarray | Gate | BaseOperator,
+        time: float | ParameterExpression,
+        label: str | None = None,
+    ) -> None:
+        """
+        Args:
+            data: A hermitian operator.
+            time: Time evolution parameter.
+            label: Unitary name for backend [Default: ``None``].
+
+        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 np array in case not already an array
+        data = np.asarray(data, dtype=complex)
+        # Check input is unitary
+        if not is_hermitian_matrix(data):
+            raise ValueError("Input matrix is not Hermitian.")
+        if isinstance(time, Number) and time != np.real(time):
+            raise ValueError("Evolution time is not real.")
+        # Check input is N-qubit matrix
+        input_dim, output_dim = data.shape
+        num_qubits = int(math.log2(input_dim))
+        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__("hamiltonian", num_qubits, [data, time], label=label)
+
+    def __eq__(self, other):
+        if not isinstance(other, HamiltonianGate):
+            return False
+        if self.label != other.label:
+            return False
+        operators_eq = matrix_equal(self.params[0], other.params[0], ignore_phase=False)
+        times_eq = self.params[1] == other.params[1]
+        return operators_eq and times_eq
+
+    def __array__(self, dtype=None, copy=None):
+        """Return matrix for the unitary."""
+        import scipy.linalg
+
+        if copy is False:
+            raise ValueError("unable to avoid copy while creating an array as requested")
+        try:
+            time = float(self.params[1])
+        except TypeError as ex:
+            raise TypeError(
+                f"Unable to generate Unitary matrix for unbound t parameter {self.params[1]}"
+            ) from ex
+        arr = scipy.linalg.expm(-1j * self.params[0] * time)
+        dtype = complex if dtype is None else dtype
+        return np.array(arr, dtype=dtype, copy=_numpy_compat.COPY_ONLY_IF_NEEDED)
+
+    def inverse(self, annotated: bool = False):
+        """Return the adjoint of the unitary."""
+        return self.adjoint()
+
+    def conjugate(self):
+        """Return the conjugate of the Hamiltonian."""
+        return HamiltonianGate(np.conj(self.params[0]), -self.params[1])
+
+    def adjoint(self):
+        """Return the adjoint of the unitary."""
+        return HamiltonianGate(self.params[0], -self.params[1])
+
+    def transpose(self):
+        """Return the transpose of the Hamiltonian."""
+        return HamiltonianGate(np.transpose(self.params[0]), self.params[1])
+
+    def _define(self):
+        """Calculate a subcircuit that implements this unitary."""
+        q = QuantumRegister(self.num_qubits, "q")
+        qc = QuantumCircuit(q, name=self.name)
+        qc._append(UnitaryGate(self.to_matrix()), q[:], [])
+        self.definition = qc
+
+    def validate_parameter(self, parameter):
+        """Hamiltonian parameter has to be an ndarray, operator or float."""
+        if isinstance(parameter, (float, int, np.ndarray)):
+            return parameter
+        elif isinstance(parameter, ParameterExpression) and len(parameter.parameters) == 0:
+            return float(parameter)
+        else:
+            raise CircuitError(f"invalid param type {type(parameter)} for gate {self.name}")

qiskit/circuit/library/hidden_linear_function.py

@@ -0,0 +1,163 @@
+# 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.
+
+"""Hidden Linear Function circuit."""
+
+from __future__ import annotations
+
+import numpy as np
+from qiskit.circuit.quantumcircuit import QuantumCircuit
+from qiskit.circuit.exceptions import CircuitError
+from qiskit.utils.deprecation import deprecate_func
+
+
+class HiddenLinearFunction(QuantumCircuit):
+    r"""Circuit to solve the hidden linear function problem.
+
+    The 2D Hidden Linear Function problem is determined by a 2D adjacency
+    matrix A, where only elements that are nearest-neighbor on a grid have
+    non-zero entries. Each row/column corresponds to one binary variable
+    :math:`x_i`.
+
+    The hidden linear function problem is as follows:
+
+    Consider the quadratic form
+
+    .. math::
+
+        q(x) = \sum_{i,j=1}^{n}{x_i x_j} ~(\mathrm{mod}~ 4)
+
+    and restrict :math:`q(x)` onto the nullspace of A. This results in a linear
+    function.
+
+    .. math::
+
+        2 \sum_{i=1}^{n}{z_i x_i} ~(\mathrm{mod}~ 4)  \forall  x \in \mathrm{Ker}(A)
+
+    and the goal is to recover this linear function (equivalently a vector
+    :math:`[z_0, ..., z_{n-1}]`). There can be multiple solutions.
+
+    In [1] it is shown that the present circuit solves this problem
+    on a quantum computer in constant depth, whereas any corresponding
+    solution on a classical computer would require circuits that grow
+    logarithmically with :math:`n`. Thus this circuit is an example
+    of quantum advantage with shallow circuits.
+
+    **Reference Circuit:**
+
+        .. plot::
+           :alt: Diagram illustrating the previously described circuit.
+
+           from qiskit.circuit.library import HiddenLinearFunction
+           from qiskit.visualization.library import _generate_circuit_library_visualization
+           A = [[1, 1, 0], [1, 0, 1], [0, 1, 1]]
+           circuit = HiddenLinearFunction(A)
+           _generate_circuit_library_visualization(circuit)
+
+    **Reference:**
+
+    [1] S. Bravyi, D. Gosset, R. Koenig, Quantum Advantage with Shallow Circuits, 2017.
+    `arXiv:1704.00690 <https://arxiv.org/abs/1704.00690>`_
+    """
+
+    @deprecate_func(
+        since="2.1",
+        additional_msg="Use qiskit.circuit.library.hidden_linear_function instead.",
+        removal_timeline="in Qiskit 3.0",
+    )
+    def __init__(self, adjacency_matrix: list | np.ndarray) -> None:
+        """Create new HLF circuit.
+
+        Args:
+            adjacency_matrix: a symmetric n-by-n list of 0-1 lists.
+                n will be the number of qubits.
+
+        Raises:
+            CircuitError: If A is not symmetric.
+        """
+        circuit = hidden_linear_function(adjacency_matrix)
+        super().__init__(*circuit.qregs, name=circuit.name)
+        self.append(circuit.to_gate(), self.qubits)
+
+
+def hidden_linear_function(adjacency_matrix: list | np.ndarray) -> QuantumCircuit:
+    r"""Circuit to solve the hidden linear function problem.
+
+    The 2D Hidden Linear Function problem is determined by a 2D adjacency
+    matrix A, where only elements that are nearest-neighbor on a grid have
+    non-zero entries. Each row/column corresponds to one binary variable
+    :math:`x_i`.
+
+    The hidden linear function problem is as follows:
+
+    Consider the quadratic form
+
+    .. math::
+
+        q(x) = \sum_{i,j=1}^{n}{x_i x_j} ~(\mathrm{mod}~ 4)
+
+    and restrict :math:`q(x)` onto the nullspace of A. This results in a linear
+    function.
+
+    .. math::
+
+        2 \sum_{i=1}^{n}{z_i x_i} ~(\mathrm{mod}~ 4)  \forall  x \in \mathrm{Ker}(A)
+
+    and the goal is to recover this linear function (equivalently a vector
+    :math:`[z_0, ..., z_{n-1}]`). There can be multiple solutions.
+
+    In [1] it is shown that the present circuit solves this problem
+    on a quantum computer in constant depth, whereas any corresponding
+    solution on a classical computer would require circuits that grow
+    logarithmically with :math:`n`. Thus this circuit is an example
+    of quantum advantage with shallow circuits.
+
+    **Reference Circuit:**
+
+    .. plot::
+       :alt: Circuit diagram output by the previous code.
+       :include-source:
+
+       from qiskit.circuit.library import hidden_linear_function
+       A = [[1, 1, 0], [1, 0, 1], [0, 1, 1]]
+       circuit = hidden_linear_function(A)
+       circuit.draw('mpl')
+
+    Args:
+        adjacency_matrix: a symmetric n-by-n list of 0-1 lists.
+            n will be the number of qubits.
+
+    Raises:
+        CircuitError: If A is not symmetric.
+
+    **Reference:**
+
+    [1] S. Bravyi, D. Gosset, R. Koenig, Quantum Advantage with Shallow Circuits, 2017.
+    `arXiv:1704.00690 <https://arxiv.org/abs/1704.00690>`_
+    """
+    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)
+    circuit = QuantumCircuit(num_qubits, name=f"hlf: {adjacency_matrix}")
+
+    circuit.h(range(num_qubits))
+    for i in range(num_qubits):
+        for j in range(i + 1, num_qubits):
+            if adjacency_matrix[i][j]:
+                circuit.cz(i, j)
+    for i in range(num_qubits):
+        if adjacency_matrix[i][i]:
+            circuit.s(i)
+    circuit.h(range(num_qubits))
+    return circuit

qiskit/circuit/library/iqp.py

@@ -0,0 +1,180 @@
+# 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.
+
+"""Instantaneous quantum polynomial circuit."""
+
+from __future__ import annotations
+from collections.abc import Sequence
+
+import numpy as np
+from qiskit.circuit import QuantumCircuit
+from qiskit.utils.deprecation import deprecate_func
+from qiskit._accelerate.circuit_library import py_iqp, py_random_iqp
+
+
+class IQP(QuantumCircuit):
+    r"""Instantaneous quantum polynomial (IQP) circuit.
+
+    The circuit consists of a column of Hadamard gates,
+    a column of powers of T gates,
+    a sequence of powers of CS gates (up to
+    :math:`\frac{n^2-n}{2}` of them),
+    and a final column of Hadamard gates, as introduced in [1].
+
+    The circuit is parameterized by an n x n interactions matrix.
+    The powers of each T gate are given by the diagonal elements
+    of the interactions matrix. The powers of the CS gates are
+    given by the upper triangle of the interactions matrix.
+
+    **Reference Circuit:**
+
+    .. plot::
+       :alt: Diagram illustrating the previously described circuit.
+
+       from qiskit.circuit.library import IQP
+       A = [[6, 5, 3], [5, 4, 5], [3, 5, 1]]
+       circuit = IQP(A)
+       circuit.draw('mpl')
+
+    **Expanded Circuit:**
+
+        .. plot::
+           :alt: Diagram illustrating the previously described circuit.
+
+           from qiskit.circuit.library import IQP
+           from qiskit.visualization.library import _generate_circuit_library_visualization
+           A = [[6, 5, 3], [5, 4, 5], [3, 5, 1]]
+           circuit = IQP(A)
+           _generate_circuit_library_visualization(circuit.decompose())
+
+    **References:**
+
+    [1] M. J. Bremner et al. Average-case complexity versus approximate
+    simulation of commuting quantum computations,
+    Phys. Rev. Lett. 117, 080501 (2016).
+    `arXiv:1504.07999 <https://arxiv.org/abs/1504.07999>`_
+    """
+
+    @deprecate_func(
+        since="2.1",
+        additional_msg="Use the qiskit.circuit.library.iqp function instead.",
+        removal_timeline="in Qiskit 3.0",
+    )
+    def __init__(self, interactions: list | np.ndarray) -> None:
+        """Create IQP circuit.
+
+        Args:
+            interactions: input n-by-n symmetric matrix.
+
+        Raises:
+            CircuitError: if the inputs is not as symmetric matrix.
+        """
+        circuit = iqp(interactions)
+        super().__init__(*circuit.qregs, name=circuit.name)
+        self.compose(circuit.to_gate(), qubits=self.qubits, inplace=True)
+
+
+def iqp(
+    interactions: Sequence[Sequence[int]],
+) -> QuantumCircuit:
+    r"""Instantaneous quantum polynomial time (IQP) circuit.
+
+    The circuit consists of a column of Hadamard gates, a column of powers of T gates,
+    a sequence of powers of CS gates (up to :math:`\frac{n^2-n}{2}` of them), and a final column of
+    Hadamard gates, as introduced in [1].
+
+    The circuit is parameterized by an :math:`n \times n` interactions matrix. The powers of each
+    T gate are given by the diagonal elements of the interactions matrix. The powers of the CS gates
+    are given by the upper triangle of the interactions matrix.
+
+    **Reference Circuit:**
+
+    .. plot::
+       :alt: Diagram illustrating the previously described circuit.
+
+       from qiskit.circuit.library import iqp
+       A = [[6, 5, 3], [5, 4, 5], [3, 5, 1]]
+       circuit = iqp(A)
+       circuit.draw("mpl")
+
+    **Expanded Circuit:**
+
+        .. plot::
+           :alt: Diagram illustrating the previously described circuit.
+
+           from qiskit.circuit.library import iqp
+           from qiskit.visualization.library import _generate_circuit_library_visualization
+           A = [[6, 5, 3], [5, 4, 5], [3, 5, 1]]
+           circuit = iqp(A)
+           _generate_circuit_library_visualization(circuit)
+
+    **References:**
+
+    [1] M. J. Bremner et al. Average-case complexity versus approximate
+    simulation of commuting quantum computations,
+    Phys. Rev. Lett. 117, 080501 (2016).
+    `arXiv:1504.07999 <https://arxiv.org/abs/1504.07999>`_
+
+    Args:
+        interactions: The interactions as symmetric square matrix. If ``None``, then the
+            ``num_qubits`` argument must be set and a random IQP circuit will be generated.
+
+    Returns:
+        An IQP circuit.
+    """
+    # if no interactions are given, generate them
+    num_qubits = len(interactions)
+    interactions = np.asarray(interactions).astype(np.int64)
+
+    # set the label -- if the number of qubits is too large, do not show the interactions matrix
+    if num_qubits < 5 and interactions is not None:
+        label = np.array_str(interactions)
+        name = "iqp:" + label.replace("\n", ";")
+    else:
+        name = "iqp"
+
+    circuit = QuantumCircuit._from_circuit_data(py_iqp(interactions), add_regs=True)
+    circuit.name = name
+    return circuit
+
+
+def random_iqp(
+    num_qubits: int,
+    seed: int | None = None,
+) -> QuantumCircuit:
+    r"""A random instantaneous quantum polynomial time (IQP) circuit.
+
+    See :func:`iqp` for more details on the IQP circuit.
+
+    Example:
+
+    .. plot::
+       :alt: Circuit diagram output by the previous code.
+       :include-source:
+
+       from qiskit.circuit.library import random_iqp
+
+       circuit = random_iqp(3)
+       circuit.draw("mpl")
+
+    Args:
+        num_qubits: The number of qubits in the circuit.
+        seed: A seed for the random number generator, in case the interactions matrix is
+            randomly generated.
+
+    Returns:
+        An IQP circuit.
+    """
+    # set the label -- if the number of qubits is too large, do not show the interactions matrix
+    circuit = QuantumCircuit._from_circuit_data(py_random_iqp(num_qubits, seed), add_regs=True)
+    circuit.name = "iqp"
+    return circuit

qiskit/circuit/library/n_local/__init__.py

@@ -0,0 +1,45 @@
+# 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.
+
+"""The circuit library module containing N-local circuits."""
+
+from .n_local import NLocal, n_local
+from .two_local import TwoLocal
+from .pauli_two_design import PauliTwoDesign, pauli_two_design
+from .real_amplitudes import RealAmplitudes, real_amplitudes
+from .efficient_su2 import EfficientSU2, efficient_su2
+from .evolved_operator_ansatz import (
+    EvolvedOperatorAnsatz,
+    evolved_operator_ansatz,
+    hamiltonian_variational_ansatz,
+)
+from .excitation_preserving import ExcitationPreserving, excitation_preserving
+from .qaoa_ansatz import QAOAAnsatz, qaoa_ansatz
+
+__all__ = [
+    "n_local",
+    "NLocal",
+    "TwoLocal",
+    "real_amplitudes",
+    "RealAmplitudes",
+    "pauli_two_design",
+    "PauliTwoDesign",
+    "efficient_su2",
+    "EfficientSU2",
+    "hamiltonian_variational_ansatz",
+    "evolved_operator_ansatz",
+    "EvolvedOperatorAnsatz",
+    "excitation_preserving",
+    "ExcitationPreserving",
+    "qaoa_ansatz",
+    "QAOAAnsatz",
+]