File size: 2,002 Bytes
b7d9967 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# This code is part of Qiskit.
#
# (C) Copyright IBM 2021, 2022.
#
# 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.
"""Interface for Quantum Imaginary Time Evolution."""
from abc import ABC, abstractmethod
from qiskit.utils.deprecation import deprecate_func
from .evolution_problem import EvolutionProblem
from .evolution_result import EvolutionResult
class ImaginaryEvolver(ABC):
"""Deprecated: Interface for Quantum Imaginary Time Evolution.
The ImaginaryEvolver interface has been superseded by the
:class:`qiskit.algorithms.time_evolvers.ImaginaryTimeEvolver` interface.
This interface will be deprecated in a future release and subsequently
removed after that.
"""
@deprecate_func(
additional_msg=(
"Instead, use the interface ``qiskit.algorithms.time_evolvers.ImaginaryTimeEvolver``. "
"See https://qisk.it/algo_migration for a migration guide."
),
since="0.24.0",
)
def __init__(self) -> None:
pass
@abstractmethod
def evolve(self, evolution_problem: EvolutionProblem) -> EvolutionResult:
r"""Perform imaginary time evolution :math:`\exp(-\tau H)|\Psi\rangle`.
Evolves an initial state :math:`|\Psi\rangle` for an imaginary time :math:`\tau`
under a Hamiltonian :math:`H`, as provided in the ``evolution_problem``.
Args:
evolution_problem: The definition of the evolution problem.
Returns:
Evolution result which includes an evolved quantum state.
"""
raise NotImplementedError()
|