operator.py 15.5 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.
    """

Martin Reinecke's avatar
Martin Reinecke committed
30
    @property
Martin Reinecke's avatar
Martin Reinecke committed
31
    def domain(self):
Philipp Arras's avatar
Docs    
Philipp Arras committed
32
        """The domain on which the Operator's input Field is defined.
Martin Reinecke's avatar
Martin Reinecke committed
33

Philipp Arras's avatar
Docs    
Philipp Arras committed
34
35
36
37
        Returns
        -------
        domain : DomainTuple or MultiDomain
        """
Martin Reinecke's avatar
Martin Reinecke committed
38
        return self._domain
Martin Reinecke's avatar
Martin Reinecke committed
39

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

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

Martin Reinecke's avatar
Martin Reinecke committed
49
        return self._target
Martin Reinecke's avatar
Martin Reinecke committed
50

Martin Reinecke's avatar
Martin Reinecke committed
51
52
53
54
55
56
    @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
57
            if not isinstance(dom_op, (DomainTuple, MultiDomain,)):
Martin Reinecke's avatar
Martin Reinecke committed
58
59
60
61
                s += " Your operator's domain is neither a `DomainTuple`" \
                     " nor a `MultiDomain`."
            raise ValueError(s)

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
62
63
64
65
    def scale(self, factor):
        if factor == 1:
            return self
        from .scaling_operator import ScalingOperator
66
        return ScalingOperator(self.target, factor)(self)
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
67
68
69
70
71

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

72
73
74
75
76
    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
77
78
79
80
81
82
83
84
85
86
        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()
87

Martin Reinecke's avatar
Martin Reinecke committed
88
89
90
91
92
    @property
    def real(self):
        from .simple_linear_operators import Realizer
        return Realizer(self.target)(self)

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
93
94
95
    def __neg__(self):
        return self.scale(-1)

Martin Reinecke's avatar
Martin Reinecke committed
96
97
98
    def __matmul__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
99
        return _OpChain.make((self, x))
Martin Reinecke's avatar
Martin Reinecke committed
100

101
102
103
104
105
    def __rmatmul__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
        return _OpChain.make((x, self))

Philipp Arras's avatar
Philipp Arras committed
106
107
108
109
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
    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
135
    def __mul__(self, x):
136
137
138
139
140
        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
141

142
143
144
    def __rmul__(self, x):
        return self.__mul__(x)

Philipp Arras's avatar
Philipp Arras committed
145
146
147
    def __add__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
148
        return _OpSum(self, x)
Philipp Arras's avatar
Philipp Arras committed
149

150
151
152
153
154
    def __sub__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
        return _OpSum(self, -x)

Martin Reinecke's avatar
Martin Reinecke committed
155
156
157
158
159
    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
160
161
162
    def clip(self, min=None, max=None):
        if min is None and max is None:
            return self
Jakob Knollmueller's avatar
Jakob Knollmueller committed
163
        return _OpChain.make((_Clipper(self.target, min, max), self))
Martin Reinecke's avatar
Martin Reinecke committed
164

Philipp Arras's avatar
Philipp Arras committed
165
    def apply(self, x):
166
        """Applies the operator to a Field or MultiField.
Philipp Arras's avatar
Docs    
Philipp Arras committed
167
168
169
170
171
172

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

Philipp Arras's avatar
Philipp Arras committed
176
    def force(self, x):
Philipp Arras's avatar
Docs    
Philipp Arras committed
177
178
        """Extract subset of domain of x according to `self.domain` and apply
        operator."""
Philipp Arras's avatar
Fix    
Philipp Arras committed
179
        return self.apply(x.extract(self.domain))
Philipp Arras's avatar
Philipp Arras committed
180

181
    def _check_input(self, x):
Philipp Arras's avatar
Philipp Arras committed
182
        from ..linearization import Linearization
Philipp Arras's avatar
Philipp Arras committed
183
        from .scaling_operator import ScalingOperator
Philipp Arras's avatar
Philipp Arras committed
184
        if not isinstance(x, (Field, MultiField, Linearization)):
Philipp Arras's avatar
Philipp Arras committed
185
            raise TypeError
Philipp Arras's avatar
Philipp Arras committed
186
187
188
189
190
        if isinstance(x, Linearization):
            if not isinstance(x.jac, ScalingOperator):
                raise ValueError
            if x.jac._factor != 1:
                raise ValueError
Philipp Arras's avatar
Philipp Arras committed
191
        self._check_domain_equality(self._domain, x.domain)
192

Martin Reinecke's avatar
Martin Reinecke committed
193
    def __call__(self, x):
Philipp Arras's avatar
Philipp Arras committed
194
195
196
197
        from ..linearization import Linearization
        from ..field import Field
        from ..multi_field import MultiField
        if isinstance(x, Linearization):
Philipp Arras's avatar
Philipp Arras committed
198
            return self.apply(x.trivial_jac()).prepend_jac(x.jac)
Philipp Arras's avatar
Philipp Arras committed
199
        elif isinstance(x, (Field, MultiField)):
Philipp Arras's avatar
Philipp Arras committed
200
            return self.apply(x)
201
        return self @ x
Martin Reinecke's avatar
Martin Reinecke committed
202

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

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

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

214
    def simplify_for_constant_input(self, c_inp):
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
215
        if c_inp is None:
216
            return None, self
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
217
218
219
220
221
222
223
        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
224

Martin Reinecke's avatar
Martin Reinecke committed
225

226
227
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
228
229
    def func(f):
        def func2(self):
230
            fa = _FunctionApplier(self.target, f)
Martin Reinecke's avatar
Martin Reinecke committed
231
232
233
234
235
            return _OpChain.make((fa, self))
        return func2
    setattr(Operator, f, func(f))


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
262
263
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
264
265
                    {key: const[key]
                     for key in const.keys() if key not in self._nc})
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
            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
284
    def apply(self, x):
285
286
287
        from ..linearization import Linearization
        from .simple_linear_operators import NullOperator
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
288
289
        if isinstance(x, Linearization):
            return x.new(self._output, NullOperator(self._domain, self._target))
Philipp Arras's avatar
Philipp Arras committed
290
        return self._output
291
292
293

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


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

Philipp Arras's avatar
Philipp Arras committed
302
    def apply(self, x):
303
        self._check_input(x)
Martin Reinecke's avatar
Martin Reinecke committed
304
305
306
        return getattr(x, self._funcname)()


Martin Reinecke's avatar
Martin Reinecke committed
307
308
309
310
311
312
313
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
314
    def apply(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
315
316
317
318
        self._check_input(x)
        return x.clip(self._min, self._max)


Martin Reinecke's avatar
Martin Reinecke committed
319
320
321
322
323
324
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
325
    def apply(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
326
327
328
329
        self._check_input(x)
        return x**self._power


Martin Reinecke's avatar
Martin Reinecke committed
330
331
332
333
334
335
336
337
338
339
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
340
                res = cls.unpack(op._ops, res)
Martin Reinecke's avatar
Martin Reinecke committed
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
            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
356
357
        self._domain = self._ops[-1].domain
        self._target = self._ops[0].target
Martin Reinecke's avatar
Martin Reinecke committed
358
359
360
        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
361

Philipp Arras's avatar
Philipp Arras committed
362
    def apply(self, x):
363
        self._check_input(x)
Martin Reinecke's avatar
Martin Reinecke committed
364
365
366
367
        for op in reversed(self._ops):
            x = op(x)
        return x

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
368
    def _simplify_for_constant_input_nontrivial(self, c_inp):
369
370
371
372
373
374
375
376
377
        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
378

Philipp Arras's avatar
Philipp Arras committed
379
380
381
382
383
    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
384
385
386
387
388
389
390
391
392
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
393

Philipp Arras's avatar
Philipp Arras committed
394
    def apply(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
395
396
        from ..linearization import Linearization
        from ..sugar import makeOp
397
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
398
399
400
        lin = isinstance(x, Linearization)
        wm = x.want_metric if lin else None
        x = x.val if lin else x
Philipp Arras's avatar
Philipp Arras committed
401
402
        v1 = x.extract(self._op1.domain)
        v2 = x.extract(self._op2.domain)
Philipp Arras's avatar
Philipp Arras committed
403
        if not lin:
404
            return self._op1(v1) * self._op2(v2)
405
406
        lin1 = self._op1(Linearization.make_var(v1, wm))
        lin2 = self._op2(Linearization.make_var(v2, wm))
Philipp Arras's avatar
Philipp Arras committed
407
408
        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
409

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
410
    def _simplify_for_constant_input_nontrivial(self, c_inp):
411
412
413
414
415
416
417
418
419
420
421
422
423
        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
424

Philipp Arras's avatar
Philipp Arras committed
425
426
427
428
429
    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
430
431
class _OpSum(Operator):
    def __init__(self, op1, op2):
Philipp Arras's avatar
Philipp Arras committed
432
        from ..sugar import domain_union
Martin Reinecke's avatar
Martin Reinecke committed
433
434
435
436
        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
437

Philipp Arras's avatar
Philipp Arras committed
438
    def apply(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
439
        from ..linearization import Linearization
440
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
441
442
443
        if not isinstance(x, Linearization):
            v1 = x.extract(self._op1.domain)
            v2 = x.extract(self._op2.domain)
Martin Reinecke's avatar
Martin Reinecke committed
444
            return self._op1(v1).unite(self._op2(v2))
Philipp Arras's avatar
Philipp Arras committed
445
446
447
        v1 = x.val.extract(self._op1.domain)
        v2 = x.val.extract(self._op2.domain)
        wm = x.want_metric
448
449
        lin1 = self._op1(Linearization.make_var(v1, wm))
        lin2 = self._op2(Linearization.make_var(v2, wm))
Martin Reinecke's avatar
Martin Reinecke committed
450
        op = lin1._jac._myadd(lin2._jac, False)
Philipp Arras's avatar
Philipp Arras committed
451
        res = lin1.new(lin1._val.unite(lin2._val), op)
Martin Reinecke's avatar
Martin Reinecke committed
452
        if lin1._metric is not None and lin2._metric is not None:
Philipp Arras's avatar
Philipp Arras committed
453
            res = res.add_metric(lin1._metric._myadd(lin2._metric, False))
Philipp Arras's avatar
Philipp Arras committed
454
        return res
455

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
456
    def _simplify_for_constant_input_nontrivial(self, c_inp):
457
458
459
460
461
462
463
464
465
466
467
468
469
        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
470
471
472
473

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