quadratic_energy.py 2.51 KB
Newer Older
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
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
from ..compat import *
Martin Reinecke's avatar
Martin Reinecke committed
22
from .energy import Energy
Martin Reinecke's avatar
Martin Reinecke committed
23
24
25
26


class QuadraticEnergy(Energy):
    """The Energy for a quadratic form.
Martin Reinecke's avatar
Martin Reinecke committed
27
    The most important aspect of this energy is that its metric must be
Martin Reinecke's avatar
Martin Reinecke committed
28
    position-independent.
Martin Reinecke's avatar
Martin Reinecke committed
29
30
    """

31
    def __init__(self, position, A, b, _grad=None):
Martin Reinecke's avatar
Martin Reinecke committed
32
33
34
        super(QuadraticEnergy, self).__init__(position=position)
        self._A = A
        self._b = b
35
        if _grad is not None:
Martin Reinecke's avatar
Martin Reinecke committed
36
            self._grad = _grad
37
            Ax = _grad if b is None else _grad + b
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
38
        else:
Martin Reinecke's avatar
Martin Reinecke committed
39
            Ax = self._A(self._position)
40
            self._grad = Ax if b is None else Ax - b
Martin Reinecke's avatar
Martin Reinecke committed
41
        self._value = 0.5*self._position.vdot(Ax)
42
        if b is not None:
Martin Reinecke's avatar
Martin Reinecke committed
43
            self._value -= b.vdot(self._position)
Martin Reinecke's avatar
Martin Reinecke committed
44
45

    def at(self, position):
Martin Reinecke's avatar
Martin Reinecke committed
46
        return QuadraticEnergy(position, self._A, self._b)
Martin Reinecke's avatar
Martin Reinecke committed
47

Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
48
    def at_with_grad(self, position, grad):
Martin Reinecke's avatar
Martin Reinecke committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
        """ Specialized version of `at`, taking also a gradient.

        This custom method is meant for use within :class:ConjugateGradient`
        minimizers, which already have the gradient available. It saves time
        by not recomputing it.

        Parameters
        ----------
        position : Field
            Location in parameter space for the new Energy object.
        grad : Field
            Energy gradient at the new position.

        Returns
        -------
        Energy
            Energy object at new position.
        """
Martin Reinecke's avatar
Martin Reinecke committed
67
        return QuadraticEnergy(position, self._A, self._b, grad)
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
68

Martin Reinecke's avatar
Martin Reinecke committed
69
70
    @property
    def value(self):
Martin Reinecke's avatar
Martin Reinecke committed
71
        return self._value
Martin Reinecke's avatar
Martin Reinecke committed
72
73
74

    @property
    def gradient(self):
Martin Reinecke's avatar
Martin Reinecke committed
75
        return self._grad
Martin Reinecke's avatar
Martin Reinecke committed
76
77

    @property
Martin Reinecke's avatar
Martin Reinecke committed
78
    def metric(self):
Martin Reinecke's avatar
Martin Reinecke committed
79
        return self._A