minimizer.py 1.64 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 NiftyMeta
Martin Reinecke's avatar
Martin Reinecke committed
21
from future.utils import with_metaclass
Martin Reinecke's avatar
Martin Reinecke committed
22

Martin Reinecke's avatar
Martin Reinecke committed
23

Martin Reinecke's avatar
Martin Reinecke committed
24
class Minimizer(with_metaclass(NiftyMeta, type('NewBase', (object,), {}))):
Martin Reinecke's avatar
Martin Reinecke committed
25
    """ A base class used by all minimizers."""
Martin Reinecke's avatar
Martin Reinecke committed
26
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
35
36
           Energy object which provides value, gradient and curvature at a
           specific position in parameter space.

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

Martin Reinecke's avatar
Martin Reinecke committed
40
41
        Returns
        -------
Martin Reinecke's avatar
Martin Reinecke committed
42
        Energy
Martin Reinecke's avatar
Martin Reinecke committed
43
            Latest `energy` of the minimization.
Martin Reinecke's avatar
Martin Reinecke committed
44
45
        int
            exit status of the minimization
Martin Reinecke's avatar
Martin Reinecke committed
46
47
        """
        raise NotImplementedError