operator.py 5.02 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
2
3
4
5
6
7
8
9
10
11
from __future__ import absolute_import, division, print_function

from ..compat import *
from ..utilities import NiftyMetaBase


class Operator(NiftyMetaBase()):
    """Transforms values living on one domain into values living on another
    domain, and can also provide the Jacobian.
    """

Martin Reinecke's avatar
Martin Reinecke committed
12
    @property
Martin Reinecke's avatar
Martin Reinecke committed
13
14
15
16
    def domain(self):
        """DomainTuple or MultiDomain : the operator's input domain

            The domain on which the Operator's input Field lives."""
17
        raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
18

Martin Reinecke's avatar
Martin Reinecke committed
19
    @property
Martin Reinecke's avatar
Martin Reinecke committed
20
21
22
23
    def target(self):
        """DomainTuple or MultiDomain : the operator's output domain

            The domain on which the Operator's output Field lives."""
24
        raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
25
26
27
28

    def __matmul__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
29
        return _OpChain.make((self, x))
Martin Reinecke's avatar
Martin Reinecke committed
30

Martin Reinecke's avatar
Martin Reinecke committed
31
32
33
34
35
    def __mul__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
        return _OpProd.make((self, x))

Martin Reinecke's avatar
Martin Reinecke committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
    def chain(self, x):
        res = self.__matmul__(x)
        if res == NotImplemented:
            raise TypeError("operator expected")
        return res

    def __call__(self, x):
        """Returns transformed x

        Parameters
        ----------
        x : Linearization
            input

        Returns
        -------
        Linearization
            output
        """
        raise NotImplementedError


Martin Reinecke's avatar
Martin Reinecke committed
58
59
60
for f in ["sqrt", "exp", "log", "tanh", "positive_tanh"]:
    def func(f):
        def func2(self):
61
            fa = _FunctionApplier(self.target, f)
Martin Reinecke's avatar
Martin Reinecke committed
62
63
64
65
66
67
68
69
            return _OpChain.make((fa, self))
        return func2
    setattr(Operator, f, func(f))


class _FunctionApplier(Operator):
    def __init__(self, domain, funcname):
        from ..sugar import makeDomain
70
        self._domain = makeDomain(domain)
Martin Reinecke's avatar
Martin Reinecke committed
71
72
        self._funcname = funcname

73
74
75
76
77
78
79
80
    @property
    def domain(self):
        return self._domain

    @property
    def target(self):
        return self._domain

Martin Reinecke's avatar
Martin Reinecke committed
81
82
83
84
    def __call__(self, x):
        return getattr(x, self._funcname)()


Martin Reinecke's avatar
Martin Reinecke committed
85
86
87
88
89
90
91
92
93
94
class _CombinedOperator(Operator):
    def __init__(self, ops, _callingfrommake=False):
        if not _callingfrommake:
            raise NotImplementedError
        self._ops = tuple(ops)

    @classmethod
    def unpack(cls, ops, res):
        for op in ops:
            if isinstance(op, cls):
Martin Reinecke's avatar
Martin Reinecke committed
95
                res = cls.unpack(op._ops, res)
Martin Reinecke's avatar
Martin Reinecke committed
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
            else:
                res = res + [op]
        return res

    @classmethod
    def make(cls, ops):
        res = cls.unpack(ops, [])
        if len(res) == 1:
            return res[0]
        return cls(res, _callingfrommake=True)


class _OpChain(_CombinedOperator):
    def __init__(self, ops, _callingfrommake=False):
        super(_OpChain, self).__init__(ops, _callingfrommake)
111
112
113
114
115
116
117
118

    @property
    def domain(self):
        return self._ops[-1].domain

    @property
    def target(self):
        return self._ops[0].target
Martin Reinecke's avatar
Martin Reinecke committed
119
120
121
122
123
124
125
126
127
128

    def __call__(self, x):
        for op in reversed(self._ops):
            x = op(x)
        return x


class _OpProd(_CombinedOperator):
    def __init__(self, ops, _callingfrommake=False):
        super(_OpProd, self).__init__(ops, _callingfrommake)
129
130
131
132
133
134
135
136

    @property
    def domain(self):
        return self._ops[0].domain

    @property
    def target(self):
        return self._ops[0].target
Martin Reinecke's avatar
Martin Reinecke committed
137
138

    def __call__(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
139
140
        from ..utilities import my_product
        return my_product(map(lambda op: op(x), self._ops))
Martin Reinecke's avatar
Martin Reinecke committed
141
142
143
144
145
146
147
148


class _OpSum(_CombinedOperator):
    def __init__(self, ops, _callingfrommake=False):
        super(_OpSum, self).__init__(ops, _callingfrommake)
        self._domain = domain_union([op.domain for op in self._ops])
        self._target = domain_union([op.target for op in self._ops])

149
150
151
152
153
154
155
156
    @property
    def domain(self):
        return self._domain

    @property
    def target(self):
        return self._target

Martin Reinecke's avatar
Martin Reinecke committed
157
158
    def __call__(self, x):
        raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201


class SquaredNormOperator(Operator):
    def __init__(self, domain):
        super(SquaredNormOperator, self).__init__()
        self._domain = domain
        self._target = DomainTuple.scalar_domain()

    @property
    def domain(self):
        return self._domain

    @property
    def target(self):
        return self._target

    def __call__(self, x):
        return Field(self._target, x.vdot(x))


class QuadraticFormOperator(Operator):
    def __init__(self, op):
        from .endomorphic_operator import EndomorphicOperator
        super(QuadraticFormOperator, self).__init__()
        if not isinstance(op, EndomorphicOperator):
            raise TypeError("op must be an EndomorphicOperator")
        self._op = op
        self._target = DomainTuple.scalar_domain()

    @property
    def domain(self):
        return self._op.domain

    @property
    def target(self):
        return self._target

    def __call__(self, x):
        if isinstance(x, Linearization):
            jac = self._op(x)
            val = Field(self._target, 0.5 * x.vdot(jac))
            return Linearization(val, jac)
        return Field(self._target, 0.5 * x.vdot(self._op(x)))