operator.py 16 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 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/>.
#
# Copyright(C) 2013-2019 Max-Planck-Society
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
Martin Reinecke's avatar
Martin Reinecke committed
17

Martin Reinecke's avatar
Martin Reinecke committed
18
import numpy as np
Philipp Arras's avatar
Philipp Arras committed
19
20
21

from ..field import Field
from ..multi_field import MultiField
Martin Reinecke's avatar
Martin Reinecke committed
22
from ..utilities import NiftyMeta, indent
Martin Reinecke's avatar
Martin Reinecke committed
23
24


Martin Reinecke's avatar
Martin Reinecke committed
25
class Operator(metaclass=NiftyMeta):
Philipp Arras's avatar
Philipp Arras committed
26
    """Transforms values defined on one domain into values defined on another
Martin Reinecke's avatar
Martin Reinecke committed
27
28
29
    domain, and can also provide the Jacobian.
    """

Philipp Arras's avatar
Philipp Arras committed
30
31
32
33
    VALUE_ONLY = 0
    WITH_JAC = 1
    WITH_METRIC = 2

Martin Reinecke's avatar
Martin Reinecke committed
34
    @property
Martin Reinecke's avatar
Martin Reinecke committed
35
    def domain(self):
Philipp Arras's avatar
Docs    
Philipp Arras committed
36
        """The domain on which the Operator's input Field is defined.
Martin Reinecke's avatar
Martin Reinecke committed
37

Philipp Arras's avatar
Docs    
Philipp Arras committed
38
39
40
41
        Returns
        -------
        domain : DomainTuple or MultiDomain
        """
Martin Reinecke's avatar
Martin Reinecke committed
42
        return self._domain
Martin Reinecke's avatar
Martin Reinecke committed
43

Martin Reinecke's avatar
Martin Reinecke committed
44
    @property
Martin Reinecke's avatar
Martin Reinecke committed
45
    def target(self):
Philipp Arras's avatar
Docs    
Philipp Arras committed
46
47
48
49
50
51
        """The domain on which the Operator's output Field is defined.

        Returns
        -------
        target : DomainTuple or MultiDomain
        """
Martin Reinecke's avatar
Martin Reinecke committed
52

Martin Reinecke's avatar
Martin Reinecke committed
53
        return self._target
Martin Reinecke's avatar
Martin Reinecke committed
54

Martin Reinecke's avatar
Martin Reinecke committed
55
56
57
58
59
60
    @staticmethod
    def _check_domain_equality(dom_op, dom_field):
        if dom_op != dom_field:
            s = "The operator's and field's domains don't match."
            from ..domain_tuple import DomainTuple
            from ..multi_domain import MultiDomain
Sebastian Hutschenreuter's avatar
fix    
Sebastian Hutschenreuter committed
61
            if not isinstance(dom_op, (DomainTuple, MultiDomain,)):
Martin Reinecke's avatar
Martin Reinecke committed
62
63
64
65
                s += " Your operator's domain is neither a `DomainTuple`" \
                     " nor a `MultiDomain`."
            raise ValueError(s)

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
66
67
68
69
    def scale(self, factor):
        if factor == 1:
            return self
        from .scaling_operator import ScalingOperator
70
        return ScalingOperator(self.target, factor)(self)
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
71
72
73
74
75

    def conjugate(self):
        from .simple_linear_operators import ConjugationOperator
        return ConjugationOperator(self.target)(self)

76
77
78
79
80
    def sum(self, spaces=None):
        from .contraction_operator import ContractionOperator
        return ContractionOperator(self.target, spaces)(self)

    def vdot(self, other):
Philipp Arras's avatar
Philipp Arras committed
81
82
83
84
85
86
87
88
89
90
        from ..field import Field
        from ..multi_field import MultiField
        from ..sugar import makeOp
        if isinstance(other, Operator):
            res = self.conjugate()*other
        elif isinstance(other, (Field, MultiField)):
            res = makeOp(other) @ self.conjugate()
        else:
            raise TypeError
        return res.sum()
91

Martin Reinecke's avatar
Martin Reinecke committed
92
93
94
95
96
    @property
    def real(self):
        from .simple_linear_operators import Realizer
        return Realizer(self.target)(self)

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
97
98
99
    def __neg__(self):
        return self.scale(-1)

Martin Reinecke's avatar
Martin Reinecke committed
100
101
102
    def __matmul__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
103
        return _OpChain.make((self, x))
Martin Reinecke's avatar
Martin Reinecke committed
104

105
106
107
108
109
    def __rmatmul__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
        return _OpChain.make((x, self))

Philipp Arras's avatar
Philipp Arras committed
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
    def partial_insert(self, x):
        from ..multi_domain import MultiDomain
        if not isinstance(x, Operator):
            raise TypeError
        if not isinstance(self.domain, MultiDomain):
            raise TypeError
        if not isinstance(x.target, MultiDomain):
            raise TypeError
        bigdom = MultiDomain.union([self.domain, x.target])
        k1, k2 = set(self.domain.keys()), set(x.target.keys())
        le, ri = k2 - k1, k1 - k2
        leop, riop = self, x
        if len(ri) > 0:
            riop = riop + self.identity_operator(
                MultiDomain.make({kk: bigdom[kk]
                                  for kk in ri}))
        if len(le) > 0:
            leop = leop + self.identity_operator(
                MultiDomain.make({kk: bigdom[kk]
                                  for kk in le}))
        return leop @ riop

    @staticmethod
    def identity_operator(dom):
        from .block_diagonal_operator import BlockDiagonalOperator
        from .scaling_operator import ScalingOperator
        idops = {kk: ScalingOperator(dd, 1.) for kk, dd in dom.items()}
        return BlockDiagonalOperator(dom, idops)

Martin Reinecke's avatar
Martin Reinecke committed
139
    def __mul__(self, x):
140
141
142
143
144
        if isinstance(x, Operator):
            return _OpProd(self, x)
        if np.isscalar(x):
            return self.scale(x)
        return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
145

146
147
148
    def __rmul__(self, x):
        return self.__mul__(x)

Philipp Arras's avatar
Philipp Arras committed
149
150
151
    def __add__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
152
        return _OpSum(self, x)
Philipp Arras's avatar
Philipp Arras committed
153

154
155
156
157
158
    def __sub__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
        return _OpSum(self, -x)

Martin Reinecke's avatar
Martin Reinecke committed
159
160
161
162
163
    def __pow__(self, power):
        if not np.isscalar(power):
            return NotImplemented
        return _OpChain.make((_PowerOp(self.target, power), self))

Martin Reinecke's avatar
Martin Reinecke committed
164
165
166
    def clip(self, min=None, max=None):
        if min is None and max is None:
            return self
Jakob Knollmueller's avatar
Jakob Knollmueller committed
167
        return _OpChain.make((_Clipper(self.target, min, max), self))
Martin Reinecke's avatar
Martin Reinecke committed
168

Philipp Arras's avatar
Philipp Arras committed
169
    def apply(self, x, difforder):
170
        """Applies the operator to a Field or MultiField.
Philipp Arras's avatar
Docs    
Philipp Arras committed
171
172
173
174
175
176

        Parameters
        ----------
        x : Field or MultiField
            Input on which the operator shall act. Needs to be defined on
            :attr:`domain`.
177
        """
Martin Reinecke's avatar
Martin Reinecke committed
178
        raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
179

Philipp Arras's avatar
Philipp Arras committed
180
    def force(self, x):
Philipp Arras's avatar
Docs    
Philipp Arras committed
181
182
        """Extract subset of domain of x according to `self.domain` and apply
        operator."""
Philipp Arras's avatar
Philipp Arras committed
183
184
        return self.apply(x.extract(self.domain))

185
    def _check_input(self, x):
Philipp Arras's avatar
Philipp Arras committed
186
187
188
        if not isinstance(x, (Field, MultiField)):
            raise TypeError
        self._check_domain_equality(self._domain, x.domain)
189

Martin Reinecke's avatar
Martin Reinecke committed
190
    def __call__(self, x):
Philipp Arras's avatar
Philipp Arras committed
191
192
193
194
195
196
197
198
199
        from ..linearization import Linearization
        from ..field import Field
        from ..multi_field import MultiField
        if isinstance(x, Linearization):
            difforder = self.WITH_METRIC if x.want_metric else self.WITH_JAC
            return self.apply(x.val, difforder).prepend_jac(x.jac)
        elif isinstance(x, (Field, MultiField)):
            return self.apply(x, self.VALUE_ONLY)
        raise TypeError('Operator can only consume Field, MultiFields and Linearizations')
Martin Reinecke's avatar
Martin Reinecke committed
200

Martin Reinecke's avatar
Martin Reinecke committed
201
202
    def ducktape(self, name):
        from .simple_linear_operators import ducktape
Philipp Arras's avatar
Philipp Arras committed
203
        return self @ ducktape(self, None, name)
Martin Reinecke's avatar
Martin Reinecke committed
204
205
206

    def ducktape_left(self, name):
        from .simple_linear_operators import ducktape
Philipp Arras's avatar
Philipp Arras committed
207
        return ducktape(None, self, name) @ self
Martin Reinecke's avatar
Martin Reinecke committed
208

Martin Reinecke's avatar
Martin Reinecke committed
209
210
211
    def __repr__(self):
        return self.__class__.__name__

212
    def simplify_for_constant_input(self, c_inp):
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
213
        if c_inp is None:
214
            return None, self
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
215
216
217
218
219
220
221
        if c_inp.domain == self.domain:
            op = _ConstantOperator(self.domain, self(c_inp))
            return op(c_inp), op
        return self._simplify_for_constant_input_nontrivial(c_inp)

    def _simplify_for_constant_input_nontrivial(self, c_inp):
        return None, self
222

Martin Reinecke's avatar
Martin Reinecke committed
223

224
225
for f in ["sqrt", "exp", "log", "sin", "cos", "tan", "sinh", "cosh", "tanh",
          "sinc", "sigmoid", "absolute", "one_over", "log10", "log1p", "expm1"]:
Martin Reinecke's avatar
Martin Reinecke committed
226
227
    def func(f):
        def func2(self):
228
            fa = _FunctionApplier(self.target, f)
Martin Reinecke's avatar
Martin Reinecke committed
229
230
231
232
233
            return _OpChain.make((fa, self))
        return func2
    setattr(Operator, f, func(f))


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
class _ConstCollector(object):
    def __init__(self):
        self._const = None
        self._nc = set()

    def mult(self, const, fulldom):
        if const is None:
            self._nc |= set(fulldom)
        else:
            self._nc |= set(fulldom) - set(const)
            if self._const is None:
                from ..multi_field import MultiField
                self._const = MultiField.from_dict(
                    {key: const[key] for key in const if key not in self._nc})
            else:
                from ..multi_field import MultiField
                self._const = MultiField.from_dict(
                    {key: self._const[key]*const[key]
                     for key in const if key not in self._nc})

    def add(self, const, fulldom):
        if const is None:
            self._nc |= set(fulldom.keys())
        else:
            from ..multi_field import MultiField
            self._nc |= set(fulldom.keys()) - set(const.keys())
            if self._const is None:
                self._const = MultiField.from_dict(
Martin Reinecke's avatar
Martin Reinecke committed
262
263
                    {key: const[key]
                     for key in const.keys() if key not in self._nc})
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
            else:
                self._const = self._const.unite(const)
                self._const = MultiField.from_dict(
                    {key: self._const[key]
                     for key in self._const if key not in self._nc})

    @property
    def constfield(self):
        return self._const


class _ConstantOperator(Operator):
    def __init__(self, dom, output):
        from ..sugar import makeDomain
        self._domain = makeDomain(dom)
        self._target = output.domain
        self._output = output

Philipp Arras's avatar
Philipp Arras committed
282
    def apply(self, x, difforder):
283
284
285
        from ..linearization import Linearization
        from .simple_linear_operators import NullOperator
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
286
287
288
        if difforder >= self.WITH_JAC:
            return Linearization(self._output, NullOperator(self._domain, self._target))
        return self._output
289
290
291

    def __repr__(self):
        return 'ConstantOperator <- {}'.format(self.domain.keys())
Philipp Arras's avatar
Philipp Arras committed
292
293


Martin Reinecke's avatar
Martin Reinecke committed
294
295
296
class _FunctionApplier(Operator):
    def __init__(self, domain, funcname):
        from ..sugar import makeDomain
Martin Reinecke's avatar
Martin Reinecke committed
297
        self._domain = self._target = makeDomain(domain)
Martin Reinecke's avatar
Martin Reinecke committed
298
299
        self._funcname = funcname

Philipp Arras's avatar
Philipp Arras committed
300
    def apply(self, x, difforder):
301
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
302
303
304
        from ..linearization import Linearization
        if difforder >= self.WITH_JAC:
            x = Linearization.make_var(x, difforder == self.WITH_METRIC)
Martin Reinecke's avatar
Martin Reinecke committed
305
306
307
        return getattr(x, self._funcname)()


Martin Reinecke's avatar
Martin Reinecke committed
308
309
310
311
312
313
314
class _Clipper(Operator):
    def __init__(self, domain, min=None, max=None):
        from ..sugar import makeDomain
        self._domain = self._target = makeDomain(domain)
        self._min = min
        self._max = max

Philipp Arras's avatar
Philipp Arras committed
315
    def apply(self, x, difforder):
Martin Reinecke's avatar
Martin Reinecke committed
316
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
317
318
319
        from ..linearization import Linearization
        if difforder >= self.WITH_JAC:
            x = Linearization.make_var(x, difforder == self.WITH_METRIC)
Martin Reinecke's avatar
Martin Reinecke committed
320
321
322
        return x.clip(self._min, self._max)


Martin Reinecke's avatar
Martin Reinecke committed
323
324
325
326
327
328
class _PowerOp(Operator):
    def __init__(self, domain, power):
        from ..sugar import makeDomain
        self._domain = self._target = makeDomain(domain)
        self._power = power

Philipp Arras's avatar
Philipp Arras committed
329
    def apply(self, x, difforder):
Martin Reinecke's avatar
Martin Reinecke committed
330
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
331
332
333
        from ..linearization import Linearization
        if difforder >= self.WITH_JAC:
            x = Linearization.make_var(x, difforder == self.WITH_METRIC)
Martin Reinecke's avatar
Martin Reinecke committed
334
335
336
        return x**self._power


Martin Reinecke's avatar
Martin Reinecke committed
337
338
339
340
341
342
343
344
345
346
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
347
                res = cls.unpack(op._ops, res)
Martin Reinecke's avatar
Martin Reinecke committed
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
            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)
Martin Reinecke's avatar
Martin Reinecke committed
363
364
        self._domain = self._ops[-1].domain
        self._target = self._ops[0].target
Martin Reinecke's avatar
Martin Reinecke committed
365
366
367
        for i in range(1, len(self._ops)):
            if self._ops[i-1].domain != self._ops[i].target:
                raise ValueError("domain mismatch")
Martin Reinecke's avatar
Martin Reinecke committed
368

Philipp Arras's avatar
Philipp Arras committed
369
    def apply(self, x, difforder):
370
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
371
372
373
        if difforder >= self.WITH_JAC:
            from ..linearization import Linearization
            x = Linearization.make_var(x, difforder == self.WITH_METRIC)
Martin Reinecke's avatar
Martin Reinecke committed
374
375
376
377
        for op in reversed(self._ops):
            x = op(x)
        return x

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
378
    def _simplify_for_constant_input_nontrivial(self, c_inp):
379
380
381
382
383
384
385
386
387
        from ..multi_domain import MultiDomain
        if not isinstance(self._domain, MultiDomain):
            return None, self

        newop = None
        for op in reversed(self._ops):
            c_inp, t_op = op.simplify_for_constant_input(c_inp)
            newop = t_op if newop is None else op(newop)
        return c_inp, newop
Martin Reinecke's avatar
Martin Reinecke committed
388

Philipp Arras's avatar
Philipp Arras committed
389
390
391
392
393
    def __repr__(self):
        subs = "\n".join(sub.__repr__() for sub in self._ops)
        return "_OpChain:\n" + indent(subs)


Martin Reinecke's avatar
Martin Reinecke committed
394
395
396
397
398
399
400
401
402
class _OpProd(Operator):
    def __init__(self, op1, op2):
        from ..sugar import domain_union
        self._domain = domain_union((op1.domain, op2.domain))
        self._target = op1.target
        if op1.target != op2.target:
            raise ValueError("target mismatch")
        self._op1 = op1
        self._op2 = op2
Martin Reinecke's avatar
Martin Reinecke committed
403

Philipp Arras's avatar
Philipp Arras committed
404
    def apply(self, x, difforder):
Martin Reinecke's avatar
Martin Reinecke committed
405
406
        from ..linearization import Linearization
        from ..sugar import makeOp
407
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
408
409
410
        v1 = x.extract(self._op1.domain)
        v2 = x.extract(self._op2.domain)
        if difforder == self.VALUE_ONLY:
411
            return self._op1(v1) * self._op2(v2)
Philipp Arras's avatar
Philipp Arras committed
412
        wm = difforder == self.WITH_METRIC
413
414
        lin1 = self._op1(Linearization.make_var(v1, wm))
        lin2 = self._op2(Linearization.make_var(v2, wm))
Philipp Arras's avatar
Philipp Arras committed
415
416
        jac = (makeOp(lin1._val)(lin2._jac))._myadd(makeOp(lin2._val)(lin1._jac), False)
        return lin1.new(lin1._val*lin2._val, jac)
Martin Reinecke's avatar
Martin Reinecke committed
417

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
418
    def _simplify_for_constant_input_nontrivial(self, c_inp):
419
420
421
422
423
424
425
426
427
428
429
430
431
        f1, o1 = self._op1.simplify_for_constant_input(
            c_inp.extract_part(self._op1.domain))
        f2, o2 = self._op2.simplify_for_constant_input(
            c_inp.extract_part(self._op2.domain))

        from ..multi_domain import MultiDomain
        if not isinstance(self._target, MultiDomain):
            return None, _OpProd(o1, o2)

        cc = _ConstCollector()
        cc.mult(f1, o1.target)
        cc.mult(f2, o2.target)
        return cc.constfield, _OpProd(o1, o2)
Martin Reinecke's avatar
Martin Reinecke committed
432

Philipp Arras's avatar
Philipp Arras committed
433
434
435
436
437
    def __repr__(self):
        subs = "\n".join(sub.__repr__() for sub in (self._op1, self._op2))
        return "_OpProd:\n"+indent(subs)


Martin Reinecke's avatar
Martin Reinecke committed
438
439
class _OpSum(Operator):
    def __init__(self, op1, op2):
Philipp Arras's avatar
Philipp Arras committed
440
        from ..sugar import domain_union
Martin Reinecke's avatar
Martin Reinecke committed
441
442
443
444
        self._domain = domain_union((op1.domain, op2.domain))
        self._target = domain_union((op1.target, op2.target))
        self._op1 = op1
        self._op2 = op2
Philipp Arras's avatar
Philipp Arras committed
445

Philipp Arras's avatar
Philipp Arras committed
446
    def apply(self, x, difforder):
Martin Reinecke's avatar
Martin Reinecke committed
447
        from ..linearization import Linearization
448
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
449
450
451
        v1 = x.extract(self._op1.domain)
        v2 = x.extract(self._op2.domain)
        if difforder == self.VALUE_ONLY:
Martin Reinecke's avatar
Martin Reinecke committed
452
            return self._op1(v1).unite(self._op2(v2))
Philipp Arras's avatar
Philipp Arras committed
453
        wm = difforder == self.WITH_METRIC
454
455
        lin1 = self._op1(Linearization.make_var(v1, wm))
        lin2 = self._op2(Linearization.make_var(v2, wm))
Martin Reinecke's avatar
Martin Reinecke committed
456
        op = lin1._jac._myadd(lin2._jac, False)
Philipp Arras's avatar
Philipp Arras committed
457
        res = lin1.new(lin1._val.unite(lin2._val), op)
Martin Reinecke's avatar
Martin Reinecke committed
458
        if lin1._metric is not None and lin2._metric is not None:
Philipp Arras's avatar
Philipp Arras committed
459
            res = res.add_metric(lin1._metric._myadd(lin2._metric, False))
Philipp Arras's avatar
Philipp Arras committed
460
        return res
461

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
462
    def _simplify_for_constant_input_nontrivial(self, c_inp):
463
464
465
466
467
468
469
470
471
472
473
474
475
        f1, o1 = self._op1.simplify_for_constant_input(
            c_inp.extract_part(self._op1.domain))
        f2, o2 = self._op2.simplify_for_constant_input(
            c_inp.extract_part(self._op2.domain))

        from ..multi_domain import MultiDomain
        if not isinstance(self._target, MultiDomain):
            return None, _OpSum(o1, o2)

        cc = _ConstCollector()
        cc.add(f1, o1.target)
        cc.add(f2, o2.target)
        return cc.constfield, _OpSum(o1, o2)
Philipp Arras's avatar
Philipp Arras committed
476
477
478
479

    def __repr__(self):
        subs = "\n".join(sub.__repr__() for sub in (self._op1, self._op2))
        return "_OpSum:\n"+indent(subs)