minimizer.py 1.7 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
2
3
4
5
6
7
8
9
10
11
12
13
# 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/>.
#
Martin Reinecke's avatar
Martin Reinecke committed
14
# Copyright(C) 2013-2018 Max-Planck-Society
Martin Reinecke's avatar
Martin Reinecke committed
15
16
17
18
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.

Martin Reinecke's avatar
Martin Reinecke committed
19
from __future__ import absolute_import, division, print_function
20

Martin Reinecke's avatar
Martin Reinecke committed
21
import abc
22
23

from ..compat import *
Martin Reinecke's avatar
Martin Reinecke committed
24
from ..utilities import NiftyMetaBase
Martin Reinecke's avatar
Martin Reinecke committed
25

Martin Reinecke's avatar
Martin Reinecke committed
26

Martin Reinecke's avatar
Martin Reinecke committed
27
class Minimizer(NiftyMetaBase()):
Martin Reinecke's avatar
Martin Reinecke committed
28
    """ A base class used by all minimizers."""
Martin Reinecke's avatar
Martin Reinecke committed
29

Martin Reinecke's avatar
Martin Reinecke committed
30
    # MR FIXME: the docstring is partially ignored by Sphinx. Why?
Martin Reinecke's avatar
Martin Reinecke committed
31
    @abc.abstractmethod
32
    def __call__(self, energy, preconditioner=None):
Martin Reinecke's avatar
Martin Reinecke committed
33
34
35
36
        """ Performs the minimization of the provided Energy functional.

        Parameters
        ----------
Martin Reinecke's avatar
Martin Reinecke committed
37
        energy : Energy
Martin Reinecke's avatar
Martin Reinecke committed
38
           Energy object at the starting point of the iteration
Martin Reinecke's avatar
Martin Reinecke committed
39

40
41
42
        preconditioner : LinearOperator, optional
           Preconditioner to accelerate the minimization

Martin Reinecke's avatar
Martin Reinecke committed
43
44
        Returns
        -------
Martin Reinecke's avatar
Martin Reinecke committed
45
46
47
        Energy : Latest `energy` of the minimization.
        int : exit status of the minimization
            Can be controller.CONVERGED or controller.ERROR
Martin Reinecke's avatar
Martin Reinecke committed
48
49
        """
        raise NotImplementedError