qiskit 1.3.0b1__cp39-abi3-macosx_10_9_x86_64.whl

qiskit/circuit/library/n_local/two_local.py

@@ -0,0 +1,282 @@
+# 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 two-local gate circuit."""
+
+from __future__ import annotations
+import typing
+from collections.abc import Callable, Sequence
+
+from qiskit.circuit.quantumcircuit import QuantumCircuit
+from qiskit.circuit import Gate, Instruction
+
+from .n_local import NLocal
+from ..standard_gates import get_standard_gate_name_mapping
+
+if typing.TYPE_CHECKING:
+    import qiskit  # pylint: disable=cyclic-import
+
+
+class TwoLocal(NLocal):
+    r"""The two-local circuit.
+
+    The two-local circuit is a parameterized circuit consisting of alternating rotation layers and
+    entanglement layers. The rotation layers are single qubit gates applied on all qubits.
+    The entanglement layer uses two-qubit gates to entangle the qubits according to a strategy set
+    using ``entanglement``. Both the rotation and entanglement gates can be specified as
+    string (e.g. ``'ry'`` or ``'cx'``), as gate-type (e.g. ``RYGate`` or ``CXGate``) or
+    as QuantumCircuit (e.g. a 1-qubit circuit or 2-qubit circuit).
+
+    A set of default entanglement strategies is provided:
+
+    * ``'full'`` entanglement is each qubit is entangled with all the others.
+    * ``'linear'`` entanglement is qubit :math:`i` entangled with qubit :math:`i + 1`,
+      for all :math:`i \in \{0, 1, ... , n - 2\}`, where :math:`n` is the total number of qubits.
+    * ``'reverse_linear'`` entanglement is qubit :math:`i` entangled with qubit :math:`i + 1`,
+      for all :math:`i \in \{n-2, n-3, ... , 1, 0\}`, where :math:`n` is the total number of qubits.
+      Note that if ``entanglement_blocks = 'cx'`` then this option provides the same unitary as
+      ``'full'`` with fewer entangling gates.
+    * ``'pairwise'`` entanglement is one layer where qubit :math:`i` is entangled with qubit
+      :math:`i + 1`, for all even values of :math:`i`, and then a second layer where qubit :math:`i`
+      is entangled with qubit :math:`i + 1`, for all odd values of :math:`i`.
+    * ``'circular'`` entanglement is linear entanglement but with an additional entanglement of the
+      first and last qubit before the linear part.
+    * ``'sca'`` (shifted-circular-alternating) entanglement is a generalized and modified version
+      of the proposed circuit 14 in `Sim et al. <https://arxiv.org/abs/1905.10876>`__.
+      It consists of circular entanglement where the 'long' entanglement connecting the first with
+      the last qubit is shifted by one each block.  Furthermore the role of control and target
+      qubits are swapped every block (therefore alternating).
+
+    The entanglement can further be specified using an entangler map, which is a list of index
+    pairs, such as
+
+    >>> entangler_map = [(0, 1), (1, 2), (2, 0)]
+
+    If different entanglements per block should be used, provide a list of entangler maps.
+    See the examples below on how this can be used.
+
+    >>> entanglement = [entangler_map_layer_1, entangler_map_layer_2, ... ]
+
+    Barriers can be inserted in between the different layers for better visualization using the
+    ``insert_barriers`` attribute.
+
+    For each parameterized gate a new parameter is generated using a
+    :class:`~qiskit.circuit.library.ParameterVector`. The name of these parameters can be chosen
+    using the ``parameter_prefix``.
+
+    Examples:
+
+        >>> two = TwoLocal(3, 'ry', 'cx', 'linear', reps=2, insert_barriers=True)
+        >>> print(two)  # decompose the layers into standard gates
+             ┌──────────┐ ░            ░ ┌──────────┐ ░            ░ ┌──────────┐
+        q_0: ┤ Ry(θ[0]) ├─░───■────────░─┤ Ry(θ[3]) ├─░───■────────░─┤ Ry(θ[6]) ├
+             ├──────────┤ ░ ┌─┴─┐      ░ ├──────────┤ ░ ┌─┴─┐      ░ ├──────────┤
+        q_1: ┤ Ry(θ[1]) ├─░─┤ X ├──■───░─┤ Ry(θ[4]) ├─░─┤ X ├──■───░─┤ Ry(θ[7]) ├
+             ├──────────┤ ░ └───┘┌─┴─┐ ░ ├──────────┤ ░ └───┘┌─┴─┐ ░ ├──────────┤
+        q_2: ┤ Ry(θ[2]) ├─░──────┤ X ├─░─┤ Ry(θ[5]) ├─░──────┤ X ├─░─┤ Ry(θ[8]) ├
+             └──────────┘ ░      └───┘ ░ └──────────┘ ░      └───┘ ░ └──────────┘
+
+        >>> two = TwoLocal(3, ['ry','rz'], 'cz', 'full', reps=1, insert_barriers=True)
+        >>> qc = QuantumCircuit(3)
+        >>> qc &= two
+        >>> print(qc.decompose().draw())
+             ┌──────────┐┌──────────┐ ░           ░ ┌──────────┐ ┌──────────┐
+        q_0: ┤ Ry(θ[0]) ├┤ Rz(θ[3]) ├─░──■──■─────░─┤ Ry(θ[6]) ├─┤ Rz(θ[9]) ├
+             ├──────────┤├──────────┤ ░  │  │     ░ ├──────────┤┌┴──────────┤
+        q_1: ┤ Ry(θ[1]) ├┤ Rz(θ[4]) ├─░──■──┼──■──░─┤ Ry(θ[7]) ├┤ Rz(θ[10]) ├
+             ├──────────┤├──────────┤ ░     │  │  ░ ├──────────┤├───────────┤
+        q_2: ┤ Ry(θ[2]) ├┤ Rz(θ[5]) ├─░─────■──■──░─┤ Ry(θ[8]) ├┤ Rz(θ[11]) ├
+             └──────────┘└──────────┘ ░           ░ └──────────┘└───────────┘
+
+        >>> entangler_map = [[0, 1], [1, 2], [2, 0]]  # circular entanglement for 3 qubits
+        >>> two = TwoLocal(3, 'x', 'crx', entangler_map, reps=1)
+        >>> print(two)  # note: no barriers inserted this time!
+                ┌───┐                             ┌──────────┐┌───┐
+        q_0: |0>┤ X ├─────■───────────────────────┤ Rx(θ[2]) ├┤ X ├
+                ├───┤┌────┴─────┐            ┌───┐└─────┬────┘└───┘
+        q_1: |0>┤ X ├┤ Rx(θ[0]) ├─────■──────┤ X ├──────┼──────────
+                ├───┤└──────────┘┌────┴─────┐└───┘      │     ┌───┐
+        q_2: |0>┤ X ├────────────┤ Rx(θ[1]) ├───────────■─────┤ X ├
+                └───┘            └──────────┘                 └───┘
+
+        >>> entangler_map = [[0, 3], [0, 2]]  # entangle the first and last two-way
+        >>> two = TwoLocal(4, [], 'cry', entangler_map, reps=1)
+        >>> circuit = two.compose(two)
+        >>> print(circuit.decompose().draw())  # note, that the parameters are the same!
+        q_0: ─────■───────────■───────────■───────────■──────
+                  │           │           │           │
+        q_1: ─────┼───────────┼───────────┼───────────┼──────
+                  │      ┌────┴─────┐     │      ┌────┴─────┐
+        q_2: ─────┼──────┤ Ry(θ[1]) ├─────┼──────┤ Ry(θ[1]) ├
+             ┌────┴─────┐└──────────┘┌────┴─────┐└──────────┘
+        q_3: ┤ Ry(θ[0]) ├────────────┤ Ry(θ[0]) ├────────────
+             └──────────┘            └──────────┘
+
+        >>> layer_1 = [(0, 1), (0, 2)]
+        >>> layer_2 = [(1, 2)]
+        >>> two = TwoLocal(3, 'x', 'cx', [layer_1, layer_2], reps=2, insert_barriers=True)
+        >>> print(two)
+             ┌───┐ ░            ░ ┌───┐ ░       ░ ┌───┐
+        q_0: ┤ X ├─░───■────■───░─┤ X ├─░───────░─┤ X ├
+             ├───┤ ░ ┌─┴─┐  │   ░ ├───┤ ░       ░ ├───┤
+        q_1: ┤ X ├─░─┤ X ├──┼───░─┤ X ├─░───■───░─┤ X ├
+             ├───┤ ░ └───┘┌─┴─┐ ░ ├───┤ ░ ┌─┴─┐ ░ ├───┤
+        q_2: ┤ X ├─░──────┤ X ├─░─┤ X ├─░─┤ X ├─░─┤ X ├
+             └───┘ ░      └───┘ ░ └───┘ ░ └───┘ ░ └───┘
+
+    """
+
+    def __init__(
+        self,
+        num_qubits: int | None = None,
+        rotation_blocks: (
+            str
+            | type
+            | qiskit.circuit.Instruction
+            | QuantumCircuit
+            | list[str | type | qiskit.circuit.Instruction | QuantumCircuit]
+            | None
+        ) = None,
+        entanglement_blocks: (
+            str
+            | type
+            | qiskit.circuit.Instruction
+            | QuantumCircuit
+            | list[str | type | qiskit.circuit.Instruction | QuantumCircuit]
+            | None
+        ) = None,
+        entanglement: str | list[list[int]] | Callable[[int], list[int]] = "full",
+        reps: int = 3,
+        skip_unentangled_qubits: bool = False,
+        skip_final_rotation_layer: bool = False,
+        parameter_prefix: str = "θ",
+        insert_barriers: bool = False,
+        initial_state: QuantumCircuit | None = None,
+        name: str = "TwoLocal",
+        flatten: bool | None = None,
+    ) -> None:
+        """
+        Args:
+            num_qubits: The number of qubits of the two-local circuit.
+            rotation_blocks: The gates used in the rotation layer. Can be specified via the name of
+                a gate (e.g. ``'ry'``) or the gate type itself (e.g. :class:`.RYGate`).
+                If only one gate is provided, the gate same gate is applied to each qubit.
+                If a list of gates is provided, all gates are applied to each qubit in the provided
+                order.
+                See the Examples section for more detail.
+            entanglement_blocks: The gates used in the entanglement layer. Can be specified in
+                the same format as ``rotation_blocks``.
+            entanglement: Specifies the entanglement structure. Can be a string (``'full'``,
+                ``'linear'``, ``'reverse_linear'``, ``'circular'`` or ``'sca'``),
+                a list of integer-pairs specifying the indices
+                of qubits entangled with one another, or a callable returning such a list provided with
+                the index of the entanglement layer.
+                Default to ``'full'`` entanglement.
+                Note that if ``entanglement_blocks = 'cx'``, then ``'full'`` entanglement provides the
+                same unitary as ``'reverse_linear'`` but the latter option has fewer entangling gates.
+                See the Examples section for more detail.
+            reps: Specifies how often a block consisting of a rotation layer and entanglement
+                layer is repeated.
+            skip_unentangled_qubits: If ``True``, the single qubit gates are only applied to qubits
+                that are entangled with another qubit. If ``False``, the single qubit gates are applied
+                to each qubit in the ansatz. Defaults to ``False``.
+            skip_final_rotation_layer: If ``False``, a rotation layer is added at the end of the
+                ansatz. If ``True``, no rotation layer is added.
+            parameter_prefix: The parameterized gates require a parameter to be defined, for which
+                we use instances of :class:`~qiskit.circuit.Parameter`. The name of each parameter will
+                be this specified prefix plus its index.
+            insert_barriers: If ``True``, barriers are inserted in between each layer. If ``False``,
+                no barriers are inserted. Defaults to ``False``.
+            initial_state: A :class:`.QuantumCircuit` object to prepend to the circuit.
+            flatten: Set this to ``True`` to output a flat circuit instead of nesting it inside multiple
+                layers of gate objects. By default currently the contents of
+                the output circuit will be wrapped in nested objects for
+                cleaner visualization. However, if you're using this circuit
+                for anything besides visualization its **strongly** recommended
+                to set this flag to ``True`` to avoid a large performance
+                overhead for parameter binding.
+
+        """
+        super().__init__(
+            num_qubits=num_qubits,
+            rotation_blocks=rotation_blocks,
+            entanglement_blocks=entanglement_blocks,
+            entanglement=entanglement,
+            reps=reps,
+            skip_final_rotation_layer=skip_final_rotation_layer,
+            skip_unentangled_qubits=skip_unentangled_qubits,
+            insert_barriers=insert_barriers,
+            initial_state=initial_state,
+            parameter_prefix=parameter_prefix,
+            name=name,
+            flatten=flatten,
+        )
+
+    def _convert_to_block(self, layer: str | type | Gate | QuantumCircuit) -> QuantumCircuit:
+        """For a layer provided as str (e.g. ``'ry'``) or type (e.g. :class:`.RYGate`) this function
+         returns the
+         according layer type along with the number of parameters (e.g. ``(RYGate, 1)``).
+
+        Args:
+            layer: The qubit layer.
+
+        Returns:
+            The specified layer with the required number of parameters.
+
+        Raises:
+            TypeError: The type of ``layer`` is invalid.
+            ValueError: The type of ``layer`` is str but the name is unknown.
+            ValueError: The type of ``layer`` is type but the layer type is unknown.
+
+        Note:
+            Outlook: If layers knew their number of parameters as static property, we could also
+            allow custom layer types.
+        """
+        if isinstance(layer, QuantumCircuit):
+            return layer
+
+        valid_layers = get_standard_gate_name_mapping()
+
+        # try to exchange `layer` from a string to a gate instance
+        if isinstance(layer, str):
+            try:
+                layer = valid_layers[layer]
+            except KeyError as ex:
+                raise ValueError(f"Unknown layer name `{layer}`.") from ex
+
+        # try to exchange `layer` from a type to a gate instance
+        if isinstance(layer, type):
+            # iterate over the layer types and look for the specified layer
+            instance = None
+            for gate in valid_layers.values():
+                if isinstance(gate, layer):
+                    instance = gate
+            if instance is None:
+                raise ValueError(f"Unknown layer type`{layer}`.")
+            layer = instance
+
+        if isinstance(layer, Instruction):
+            circuit = QuantumCircuit(layer.num_qubits)
+            circuit.append(layer, list(range(layer.num_qubits)))
+            return circuit
+
+        raise TypeError(
+            f"Invalid input type {type(layer)}. " + "`layer` must be a type, str or QuantumCircuit."
+        )
+
+    def get_entangler_map(
+        self, rep_num: int, block_num: int, num_block_qubits: int
+    ) -> Sequence[Sequence[int]]:
+        """Overloading to handle the special case of 1 qubit where the entanglement are ignored."""
+        if self.num_qubits <= 1:
+            return []
+        return super().get_entangler_map(rep_num, block_num, num_block_qubits)

qiskit/circuit/library/overlap.py

@@ -0,0 +1,117 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2023.
+#
+# 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.
+
+"""Unitary overlap circuit."""
+
+from qiskit.circuit import QuantumCircuit, Gate
+from qiskit.circuit.parametervector import ParameterVector
+from qiskit.circuit.exceptions import CircuitError
+from qiskit.circuit import Barrier
+
+
+class UnitaryOverlap(QuantumCircuit):
+    r"""Circuit that returns the overlap between two unitaries :math:`U_2^{\dag} U_1`.
+
+    The input quantum circuits must represent unitary operations, since they must be invertible.
+    If the inputs will have parameters, they are replaced by :class:`.ParameterVector`\s with
+    names `"p1"` (for circuit ``unitary1``) and `"p2"` (for circuit ``unitary_2``) in the output
+    circuit.
+
+    This circuit is usually employed in computing the fidelity:
+
+    .. math::
+
+        \left|\langle 0| U_2^{\dag} U_1|0\rangle\right|^{2}
+
+    by computing the probability of being in the all-zeros bit-string, or equivalently,
+    the expectation value of projector :math:`|0\rangle\langle 0|`.
+
+    Example::
+
+        import numpy as np
+        from qiskit.circuit.library import EfficientSU2, UnitaryOverlap
+        from qiskit.primitives import Sampler
+
+        # get two circuit to prepare states of which we comput the overlap
+        circuit = EfficientSU2(2, reps=1)
+        unitary1 = circuit.assign_parameters(np.random.random(circuit.num_parameters))
+        unitary2 = circuit.assign_parameters(np.random.random(circuit.num_parameters))
+
+        # create the overlap circuit
+        overlap = UnitaryOverap(unitary1, unitary2)
+
+        # sample from the overlap
+        sampler = Sampler(options={"shots": 100})
+        result = sampler.run(overlap).result()
+
+        # the fidelity is the probability to measure 0
+        fidelity = result.quasi_dists[0].get(0, 0)
+
+    """
+
+    def __init__(
+        self,
+        unitary1: QuantumCircuit,
+        unitary2: QuantumCircuit,
+        prefix1: str = "p1",
+        prefix2: str = "p2",
+        insert_barrier: bool = False,
+    ):
+        """
+        Args:
+            unitary1: Unitary acting on the ket vector.
+            unitary2: Unitary whose inverse operates on the bra vector.
+            prefix1: The name of the parameter vector associated to ``unitary1``,
+                if it is parameterized. Defaults to ``"p1"``.
+            prefix2: The name of the parameter vector associated to ``unitary2``,
+                if it is parameterized. Defaults to ``"p2"``.
+            insert_barrier: Whether to insert a barrier between the two unitaries.
+
+        Raises:
+            CircuitError: Number of qubits in ``unitary1`` and ``unitary2`` does not match.
+            CircuitError: Inputs contain measurements and/or resets.
+        """
+        # check inputs are valid
+        if unitary1.num_qubits != unitary2.num_qubits:
+            raise CircuitError(
+                f"Number of qubits in unitaries does "
+                f"not match: {unitary1.num_qubits} != {unitary2.num_qubits}."
+            )
+
+        unitaries = [unitary1, unitary2]
+        for unitary in unitaries:
+            _check_unitary(unitary)
+
+        # Vectors of new parameters, if any. Need the unitaries in a list here to ensure
+        # we can overwrite them.
+        for i, prefix in enumerate([prefix1, prefix2]):
+            if unitaries[i].num_parameters > 0:
+                new_params = ParameterVector(prefix, unitaries[i].num_parameters)
+                unitaries[i] = unitaries[i].assign_parameters(new_params)
+
+        # Generate the actual overlap circuit
+        super().__init__(unitaries[0].num_qubits, name="UnitaryOverlap")
+        self.compose(unitaries[0], inplace=True)
+        if insert_barrier:
+            self.barrier()
+        self.compose(unitaries[1].inverse(), inplace=True)
+
+
+def _check_unitary(circuit):
+    """Check a circuit is unitary by checking if all operations are of type ``Gate``."""
+
+    for instruction in circuit.data:
+        if not isinstance(instruction.operation, (Gate, Barrier)):
+            raise CircuitError(
+                "One or more instructions cannot be converted to"
+                f' a gate. "{instruction.operation.name}" is not a gate instruction'
+            )

qiskit/circuit/library/pauli_evolution.py

@@ -0,0 +1,184 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2021, 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.
+
+"""A gate to implement time-evolution of operators."""
+
+from __future__ import annotations
+
+from typing import Union, Optional, TYPE_CHECKING
+import numpy as np
+
+from qiskit.circuit.gate import Gate
+from qiskit.circuit.parameterexpression import ParameterExpression
+from qiskit.quantum_info import Pauli, SparsePauliOp
+
+if TYPE_CHECKING:
+    from qiskit.synthesis.evolution import EvolutionSynthesis
+
+
+class PauliEvolutionGate(Gate):
+    r"""Time-evolution of an operator consisting of Paulis.
+
+    For an operator :math:`H` consisting of Pauli terms and (real) evolution time :math:`t`
+    this gate implements
+
+    .. math::
+
+        U(t) = e^{-itH}.
+
+    This gate serves as a high-level definition of the evolution and can be synthesized into
+    a circuit using different algorithms.
+
+    The evolution gates are related to the Pauli rotation gates by a factor of 2. For example
+    the time evolution of the Pauli :math:`X` operator is connected to the Pauli :math:`X` rotation
+    :math:`R_X` by
+
+    .. math::
+
+        U(t) = e^{-itX} = R_X(2t).
+
+    **Examples:**
+
+    .. code-block:: python
+
+        from qiskit.circuit import QuantumCircuit
+        from qiskit.circuit.library import PauliEvolutionGate
+        from qiskit.quantum_info import SparsePauliOp
+
+        X = SparsePauliOp("X")
+        Z = SparsePauliOp("Z")
+
+        # build the evolution gate
+        operator = (Z ^ Z) - 0.1 * (X ^ I)
+        evo = PauliEvolutionGate(operator, time=0.2)
+
+        # plug it into a circuit
+        circuit = QuantumCircuit(2)
+        circuit.append(evo, range(2))
+        print(circuit.draw())
+
+    The above will print (note that the ``-0.1`` coefficient is not printed!)::
+
+             ┌──────────────────────────┐
+        q_0: ┤0                         ├
+             │  exp(-it (ZZ + XI))(0.2) │
+        q_1: ┤1                         ├
+             └──────────────────────────┘
+
+
+    **References:**
+
+    [1] G. Li et al. Paulihedral: A Generalized Block-Wise Compiler Optimization
+    Framework For Quantum Simulation Kernels (2021).
+    [`arXiv:2109.03371 <https://arxiv.org/abs/2109.03371>`_]
+    """
+
+    def __init__(
+        self,
+        operator,
+        time: Union[int, float, ParameterExpression] = 1.0,
+        label: Optional[str] = None,
+        synthesis: Optional[EvolutionSynthesis] = None,
+    ) -> None:
+        """
+        Args:
+            operator (Pauli | SparsePauliOp | list):
+                The operator to evolve. Can also be provided as list of non-commuting
+                operators where the elements are sums of commuting operators.
+                For example: ``[XY + YX, ZZ + ZI + IZ, YY]``.
+            time: The evolution time.
+            label: A label for the gate to display in visualizations. Per default, the label is
+                set to ``exp(-it <operators>)`` where ``<operators>`` is the sum of the Paulis.
+                Note that the label does not include any coefficients of the Paulis. See the
+                class docstring for an example.
+            synthesis: A synthesis strategy. If None, the default synthesis is the Lie-Trotter
+                product formula with a single repetition.
+        """
+        if isinstance(operator, list):
+            operator = [_to_sparse_pauli_op(op) for op in operator]
+        else:
+            operator = _to_sparse_pauli_op(operator)
+
+        if synthesis is None:
+            from qiskit.synthesis.evolution import LieTrotter
+
+            synthesis = LieTrotter()
+
+        if label is None:
+            label = _get_default_label(operator)
+
+        num_qubits = operator[0].num_qubits if isinstance(operator, list) else operator.num_qubits
+        super().__init__(name="PauliEvolution", num_qubits=num_qubits, params=[time], label=label)
+        self.operator = operator
+        self.synthesis = synthesis
+
+    @property
+    def time(self) -> Union[float, ParameterExpression]:
+        """Return the evolution time as stored in the gate parameters.
+
+        Returns:
+            The evolution time.
+        """
+        return self.params[0]
+
+    @time.setter
+    def time(self, time: Union[float, ParameterExpression]) -> None:
+        """Set the evolution time.
+
+        Args:
+            time: The evolution time.
+        """
+        self.params = [time]
+
+    def _define(self):
+        """Unroll, where the default synthesis is matrix based."""
+        self.definition = self.synthesis.synthesize(self)
+
+    def validate_parameter(
+        self, parameter: Union[int, float, ParameterExpression]
+    ) -> Union[float, ParameterExpression]:
+        """Gate parameters should be int, float, or ParameterExpression"""
+        if isinstance(parameter, int):
+            parameter = float(parameter)
+
+        return super().validate_parameter(parameter)
+
+
+def _to_sparse_pauli_op(operator):
+    """Cast the operator to a SparsePauliOp."""
+
+    if isinstance(operator, Pauli):
+        sparse_pauli = SparsePauliOp(operator)
+    elif isinstance(operator, SparsePauliOp):
+        sparse_pauli = operator
+    else:
+        raise ValueError(f"Unsupported operator type for evolution: {type(operator)}.")
+
+    if any(np.iscomplex(sparse_pauli.coeffs)):
+        raise ValueError("Operator contains complex coefficients, which are not supported.")
+    if any(isinstance(coeff, ParameterExpression) for coeff in sparse_pauli.coeffs):
+        raise ValueError("Operator contains ParameterExpression, which are not supported.")
+
+    return sparse_pauli
+
+
+def _get_default_label(operator):
+    if isinstance(operator, list):
+        label = f"exp(-it ({[' + '.join(op.paulis.to_labels()) for op in operator]}))"
+    else:
+        if len(operator.paulis) == 1:
+            label = f"exp(-it {operator.paulis.to_labels()[0]})"
+        # for just a single Pauli don't add brackets around the sum
+        else:
+            label = f"exp(-it ({' + '.join(operator.paulis.to_labels())}))"
+
+    return label

qiskit/circuit/library/phase_estimation.py

@@ -0,0 +1,99 @@
+# 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.
+
+"""Phase estimation circuit."""
+
+from typing import Optional
+
+from qiskit.circuit import QuantumCircuit, QuantumRegister
+
+from .basis_change import QFT
+
+
+class PhaseEstimation(QuantumCircuit):
+    r"""Phase Estimation circuit.
+
+    In the Quantum Phase Estimation (QPE) algorithm [1, 2, 3], the Phase Estimation circuit is used
+    to estimate the phase :math:`\phi` of an eigenvalue :math:`e^{2\pi i\phi}` of a unitary operator
+    :math:`U`, provided with the corresponding eigenstate :math:`|\psi\rangle`.
+    That is
+
+    .. math::
+
+        U|\psi\rangle = e^{2\pi i\phi} |\psi\rangle
+
+    This estimation (and thereby this circuit) is a central routine to several well-known
+    algorithms, such as Shor's algorithm or Quantum Amplitude Estimation.
+
+    **References:**
+
+    [1]: Kitaev, A. Y. (1995). Quantum measurements and the Abelian Stabilizer Problem. 1–22.
+        `quant-ph/9511026 <http://arxiv.org/abs/quant-ph/9511026>`_
+
+    [2]: Michael A. Nielsen and Isaac L. Chuang. 2011.
+         Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.).
+         Cambridge University Press, New York, NY, USA.
+
+    [3]: Qiskit
+        `textbook <https://github.com/Qiskit/textbook/blob/main/notebooks/ch-algorithms/
+        quantum-phase-estimation.ipynb>`_
+
+    """
+
+    def __init__(
+        self,
+        num_evaluation_qubits: int,
+        unitary: QuantumCircuit,
+        iqft: Optional[QuantumCircuit] = None,
+        name: str = "QPE",
+    ) -> None:
+        """
+        Args:
+            num_evaluation_qubits: The number of evaluation qubits.
+            unitary: The unitary operation :math:`U` which will be repeated and controlled.
+            iqft: A inverse Quantum Fourier Transform, per default the inverse of
+                :class:`~qiskit.circuit.library.QFT` is used. Note that the QFT should not include
+                the usual swaps!
+            name: The name of the circuit.
+
+        .. note::
+
+            The inverse QFT should not include a swap of the qubit order.
+
+        Reference Circuit:
+            .. plot::
+
+               from qiskit.circuit import QuantumCircuit
+               from qiskit.circuit.library import PhaseEstimation
+               from qiskit.visualization.library import _generate_circuit_library_visualization
+               unitary = QuantumCircuit(2)
+               unitary.x(0)
+               unitary.y(1)
+               circuit = PhaseEstimation(3, unitary)
+               _generate_circuit_library_visualization(circuit)
+        """
+        qr_eval = QuantumRegister(num_evaluation_qubits, "eval")
+        qr_state = QuantumRegister(unitary.num_qubits, "q")
+        circuit = QuantumCircuit(qr_eval, qr_state, name=name)
+
+        if iqft is None:
+            iqft = QFT(num_evaluation_qubits, inverse=True, do_swaps=False).reverse_bits()
+
+        circuit.h(qr_eval)  # hadamards on evaluation qubits
+
+        for j in range(num_evaluation_qubits):  # controlled powers
+            circuit.compose(unitary.power(2**j).control(), qubits=[j] + qr_state[:], inplace=True)
+
+        circuit.compose(iqft, qubits=qr_eval[:], inplace=True)  # final QFT
+
+        super().__init__(*circuit.qregs, name=circuit.name)
+        self.compose(circuit.to_gate(), qubits=self.qubits, inplace=True)