line_search.py 1.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
Theo Steininger's avatar
Theo Steininger committed
13
#
Martin Reinecke's avatar
Martin Reinecke committed
14
# Copyright(C) 2013-2018 Max-Planck-Society
Theo Steininger's avatar
Theo Steininger committed
15
16
17
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.
18

19
import abc
Martin Reinecke's avatar
Martin Reinecke committed
20
from ..utilities import NiftyMetaBase
21

22

Martin Reinecke's avatar
Martin Reinecke committed
23
class LineSearch(NiftyMetaBase()):
24
    """Class for determining the optimal step size along some descent direction.
25

26
    Initialize the line search procedure which can be used by a specific line
Martin Reinecke's avatar
Martin Reinecke committed
27
    search method. It finds the step size in a specific direction in the
28
    minimization process.
29
    """
30

Martin Reinecke's avatar
Martin Reinecke committed
31
32
    def __init__(self, preferred_initial_step_size=None):
        self.preferred_initial_step_size = preferred_initial_step_size
33
34

    @abc.abstractmethod
35
    def perform_line_search(self, energy, pk, f_k_minus_1=None):
36
        raise NotImplementedError