quadratic_energy.py 2.43 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 .energy import Energy
Martin Reinecke's avatar
Martin Reinecke committed
20
21
22
23


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

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

    def at(self, position):
42
        return QuadraticEnergy(position=position, A=self._A, b=self._b)
Martin Reinecke's avatar
Martin Reinecke committed
43

Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
44
    def at_with_grad(self, position, grad):
Martin Reinecke's avatar
Martin Reinecke committed
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
        """ 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.
        """
63
64
        return QuadraticEnergy(position=position, A=self._A, b=self._b,
                               _grad=grad)
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
65

Martin Reinecke's avatar
Martin Reinecke committed
66
67
    @property
    def value(self):
Martin Reinecke's avatar
Martin Reinecke committed
68
        return self._value
Martin Reinecke's avatar
Martin Reinecke committed
69
70
71

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

    @property
    def curvature(self):
        return self._A