line_search.py 1.77 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 14 15 16 17
#
# Copyright(C) 2013-2017 Max-Planck-Society
#
# 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 future.utils import with_metaclass
21

22

Martin Reinecke's avatar
Martin Reinecke committed
23 24 25 26
class LineSearch(with_metaclass(abc.ABCMeta,
                                with_metaclass(abc.ABCMeta,
                                               type('NewBase',
                                                    (object,), {})))):
27
    """Class for determining the optimal step size along some descent direction.
28

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

33 34 35 36
    Attributes
    ----------
    line_energy : LineEnergy Object
        LineEnergy object from which we can extract energy at a specific point.
37
    preferred_initial_step_size : float
38
        Initial guess for the step length.
39
    """
40

41
    def __init__(self):
42
        self.preferred_initial_step_size = None
43 44

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