minimizer.py 1.61 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
19
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.

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

Martin Reinecke's avatar
Martin Reinecke committed
22

Martin Reinecke's avatar
Martin Reinecke committed
23
class Minimizer(NiftyMetaBase()):
Martin Reinecke's avatar
Martin Reinecke committed
24
    """ A base class used by all minimizers."""
Martin Reinecke's avatar
Martin Reinecke committed
25

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

        Parameters
        ----------
Martin Reinecke's avatar
Martin Reinecke committed
33
        energy : Energy
Martin Reinecke's avatar
Martin Reinecke committed
34
           Energy object at the starting point of the iteration
Martin Reinecke's avatar
Martin Reinecke committed
35

36
37
38
        preconditioner : LinearOperator, optional
           Preconditioner to accelerate the minimization

Martin Reinecke's avatar
Martin Reinecke committed
39
40
        Returns
        -------
Martin Reinecke's avatar
Martin Reinecke committed
41
42
43
        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
44
45
        """
        raise NotImplementedError