minimizer.py 1.51 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/>.
#
14
# Copyright(C) 2013-2019 Max-Planck-Society
Martin Reinecke's avatar
Martin Reinecke committed
15
#
16
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
17

Martin Reinecke's avatar
Martin Reinecke committed
18
from ..utilities import NiftyMeta
Martin Reinecke's avatar
Martin Reinecke committed
19

Martin Reinecke's avatar
Martin Reinecke committed
20

Martin Reinecke's avatar
Martin Reinecke committed
21
class Minimizer(metaclass=NiftyMeta):
22
    """A base class used by all minimizers."""
Martin Reinecke's avatar
Martin Reinecke committed
23

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

        Parameters
        ----------
Martin Reinecke's avatar
Martin Reinecke committed
30
        energy : Energy
Martin Reinecke's avatar
Martin Reinecke committed
31
           Energy object at the starting point of the iteration
Martin Reinecke's avatar
Martin Reinecke committed
32

33
34
35
        preconditioner : LinearOperator, optional
           Preconditioner to accelerate the minimization

Martin Reinecke's avatar
Martin Reinecke committed
36
37
        Returns
        -------
Martin Reinecke's avatar
Martin Reinecke committed
38
39
40
        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
41
42
        """
        raise NotImplementedError