File size: 4,915 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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# This code is part of Qiskit.
#
# (C) Copyright IBM 2020, 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.
"""The Eigensolver interface"""
from __future__ import annotations
from abc import ABC, abstractmethod
import numpy as np
from qiskit.opflow import OperatorBase
from qiskit.utils.deprecation import deprecate_func
from ..algorithm_result import AlgorithmResult
from ..list_or_dict import ListOrDict
class Eigensolver(ABC):
"""Deprecated: Eigensolver Interface.
The Eigensolver interface has been superseded by the
:class:`qiskit.algorithms.eigensolvers.Eigensolver` interface.
This interface will be deprecated in a future release and subsequently
removed after that.
Algorithms that can compute eigenvalues for an operator
may implement this interface to allow different algorithms to be
used interchangeably.
"""
@deprecate_func(
additional_msg=(
"Instead, use the interface ``qiskit.algorithms.eigensolvers.Eigensolver``. See "
"https://qisk.it/algo_migration for a migration guide."
),
since="0.24.0",
)
def __init__(self) -> None:
pass
@abstractmethod
def compute_eigenvalues(
self, operator: OperatorBase, aux_operators: ListOrDict[OperatorBase] | None = None
) -> "EigensolverResult":
"""
Computes eigenvalues. Operator and aux_operators can be supplied here and
if not None will override any already set into algorithm so it can be reused with
different operators. While an operator is required by algorithms, aux_operators
are optional. To 'remove' a previous aux_operators array use an empty list here.
Args:
operator: Qubit operator of the Observable
aux_operators: Optional list of auxiliary operators to be evaluated with the
eigenstate of the minimum eigenvalue main result and their expectation values
returned. For instance in chemistry these can be dipole operators, total particle
count operators so we can get values for these at the ground state.
Returns:
EigensolverResult
"""
return EigensolverResult()
@classmethod
def supports_aux_operators(cls) -> bool:
"""Whether computing the expectation value of auxiliary operators is supported.
Returns:
True if aux_operator expectations can be evaluated, False otherwise
"""
return False
class EigensolverResult(AlgorithmResult):
"""Deprecated: Eigensolver Result.
The EigensolverResult class has been superseded by the
:class:`qiskit.algorithms.eigensolvers.EigensolverResult` class.
This class will be deprecated in a future release and subsequently
removed after that.
"""
@deprecate_func(
additional_msg=(
"Instead, use the class ``qiskit.algorithms.eigensolvers.EigensolverResult``. "
"See https://qisk.it/algo_migration for a migration guide."
),
since="0.24.0",
)
def __init__(self) -> None:
super().__init__()
self._eigenvalues: np.ndarray | None = None
self._eigenstates: np.ndarray | None = None
self._aux_operator_eigenvalues: list[ListOrDict[tuple[complex, complex]]] | None = None
@property
def eigenvalues(self) -> np.ndarray | None:
"""returns eigen values"""
return self._eigenvalues
@eigenvalues.setter
def eigenvalues(self, value: np.ndarray) -> None:
"""set eigen values"""
self._eigenvalues = value
@property
def eigenstates(self) -> np.ndarray | None:
"""return eigen states"""
return self._eigenstates
@eigenstates.setter
def eigenstates(self, value: np.ndarray) -> None:
"""set eigen states"""
self._eigenstates = value
@property
def aux_operator_eigenvalues(self) -> list[ListOrDict[tuple[complex, complex]]] | None:
"""Return aux operator expectation values.
These values are in fact tuples formatted as (mean, standard deviation).
"""
return self._aux_operator_eigenvalues
@aux_operator_eigenvalues.setter
def aux_operator_eigenvalues(self, value: list[ListOrDict[tuple[complex, complex]]]) -> None:
"""set aux operator eigen values"""
self._aux_operator_eigenvalues = value
|