operator.py 12.3 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1 2
from __future__ import absolute_import, division, print_function

Martin Reinecke's avatar
Martin Reinecke committed
3
import numpy as np
Martin Reinecke's avatar
Martin Reinecke committed
4
from ..compat import *
Philipp Arras's avatar
Philipp Arras committed
5
from ..utilities import NiftyMetaBase
Martin Reinecke's avatar
Martin Reinecke committed
6 7 8 9 10 11 12


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
13
    @property
Martin Reinecke's avatar
Martin Reinecke committed
14 15 16 17
    def domain(self):
        """DomainTuple or MultiDomain : the operator's input domain

            The domain on which the Operator's input Field lives."""
Martin Reinecke's avatar
Martin Reinecke committed
18
        return self._domain
Martin Reinecke's avatar
Martin Reinecke committed
19

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

            The domain on which the Operator's output Field lives."""
Martin Reinecke's avatar
Martin Reinecke committed
25
        return self._target
Martin Reinecke's avatar
Martin Reinecke committed
26

Martin Reinecke's avatar
Martin Reinecke committed
27 28 29 30 31 32
    @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
33
            if not isinstance(dom_op, (DomainTuple, MultiDomain,)):
Martin Reinecke's avatar
Martin Reinecke committed
34 35 36 37
                s += " Your operator's domain is neither a `DomainTuple`" \
                     " nor a `MultiDomain`."
            raise ValueError(s)

Martin Reinecke's avatar
cleanup  
Martin Reinecke committed
38 39 40 41 42 43 44 45 46 47
    def scale(self, factor):
        if factor == 1:
            return self
        from .scaling_operator import ScalingOperator
        return ScalingOperator(factor, self.target)(self)

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

Martin Reinecke's avatar
Martin Reinecke committed
48 49 50 51 52
    @property
    def real(self):
        from .simple_linear_operators import Realizer
        return Realizer(self.target)(self)

Martin Reinecke's avatar
cleanup  
Martin Reinecke committed
53 54 55
    def __neg__(self):
        return self.scale(-1)

Martin Reinecke's avatar
Martin Reinecke committed
56 57 58
    def __matmul__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
59
        return _OpChain.make((self, x))
Martin Reinecke's avatar
Martin Reinecke committed
60

Martin Reinecke's avatar
Martin Reinecke committed
61 62 63
    def __mul__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
64
        return _OpProd(self, x)
Martin Reinecke's avatar
Martin Reinecke committed
65

Philipp Arras's avatar
Philipp Arras committed
66 67 68
    def __add__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
Martin Reinecke's avatar
Martin Reinecke committed
69
        return _OpSum(self, x)
Philipp Arras's avatar
Philipp Arras committed
70

71 72 73 74 75
    def __sub__(self, x):
        if not isinstance(x, Operator):
            return NotImplemented
        return _OpSum(self, -x)

Martin Reinecke's avatar
Martin Reinecke committed
76 77 78 79 80
    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
81 82
    def apply(self, x):
        raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
83

Philipp Arras's avatar
Philipp Arras committed
84
    def force(self, x):
Philipp Arras's avatar
Philipp Arras committed
85
        """Extract correct subset of domain of x and apply operator."""
Philipp Arras's avatar
Philipp Arras committed
86 87
        return self.apply(x.extract(self.domain))

88 89 90
    def _check_input(self, x):
        from ..linearization import Linearization
        d = x.target if isinstance(x, Linearization) else x.domain
Martin Reinecke's avatar
Martin Reinecke committed
91
        self._check_domain_equality(self._domain, d)
92

Martin Reinecke's avatar
Martin Reinecke committed
93
    def __call__(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
94 95 96
        if isinstance(x, Operator):
            return _OpChain.make((self, x))
        return self.apply(x)
Martin Reinecke's avatar
Martin Reinecke committed
97

Martin Reinecke's avatar
Martin Reinecke committed
98 99 100 101 102 103 104 105
    def ducktape(self, name):
        from .simple_linear_operators import ducktape
        return self(ducktape(self, None, name))

    def ducktape_left(self, name):
        from .simple_linear_operators import ducktape
        return ducktape(None, self, name)(self)

Martin Reinecke's avatar
Martin Reinecke committed
106 107 108
    def __repr__(self):
        return self.__class__.__name__

109 110 111 112 113 114
    def simplify_for_constant_input(self, c_inp):
        if c_inp is None or c_inp.domain != self.domain:
            return None, self
        op = _ConstantOperator(self.domain, self(c_inp))
        return op(c_inp), op

Martin Reinecke's avatar
Martin Reinecke committed
115

Philipp Arras's avatar
Philipp Arras committed
116
for f in ["sqrt", "exp", "log", "tanh", "positive_tanh", 'clipped_exp']:
Martin Reinecke's avatar
Martin Reinecke committed
117 118
    def func(f):
        def func2(self):
119
            fa = _FunctionApplier(self.target, f)
Martin Reinecke's avatar
Martin Reinecke committed
120 121 122 123 124
            return _OpChain.make((fa, self))
        return func2
    setattr(Operator, f, func(f))


125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
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(
                    {key: const[key] for key in const.keys() if key not in self._nc})
            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

    def apply(self, x):
        from ..linearization import Linearization
        from .simple_linear_operators import NullOperator
        self._check_input(x)
        if not isinstance(x, Linearization):
            return self._output
        return x.new(self._output, NullOperator(self._domain, self._target))

    def __repr__(self):
        return 'ConstantOperator <- {}'.format(self.domain.keys())
Philipp Arras's avatar
Philipp Arras committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210


class _ConstantOperator2(Operator):
    def __init__(self, target, constant_output):
        from ..sugar import makeDomain
        self._target = makeDomain(target)
        dom_keys = set(target.keys())-set(constant_output.domain.keys())
        self._domain = makeDomain({key: self._target[key] for key in dom_keys})
        self._constant_output = constant_output

    def apply(self, x):
        from ..linearization import Linearization
        self._check_input(x)
        if not isinstance(x, Linearization):
            return x.unite(self._constant_output)
        from .simple_linear_operators import _PartialExtractor

        op = _PartialExtractor(self.target, x.jac.target).adjoint
        val = x.val.unite(self._constant_output)

        assert val.domain is self.target
        assert val.domain is op.target

        return x.new(val, op(x.jac))

    def __repr__(self):
        return 'ConstantOperator2: {} <- {}'.format(self.target.keys(), self.domain.keys())


Martin Reinecke's avatar
Martin Reinecke committed
211 212 213
class _FunctionApplier(Operator):
    def __init__(self, domain, funcname):
        from ..sugar import makeDomain
Martin Reinecke's avatar
Martin Reinecke committed
214
        self._domain = self._target = makeDomain(domain)
Martin Reinecke's avatar
Martin Reinecke committed
215 216
        self._funcname = funcname

Martin Reinecke's avatar
Martin Reinecke committed
217
    def apply(self, x):
218
        self._check_input(x)
Martin Reinecke's avatar
Martin Reinecke committed
219 220 221
        return getattr(x, self._funcname)()


Martin Reinecke's avatar
Martin Reinecke committed
222 223 224 225 226 227 228 229 230 231 232
class _PowerOp(Operator):
    def __init__(self, domain, power):
        from ..sugar import makeDomain
        self._domain = self._target = makeDomain(domain)
        self._power = power

    def apply(self, x):
        self._check_input(x)
        return x**self._power


Martin Reinecke's avatar
Martin Reinecke committed
233 234 235 236 237 238 239 240 241 242
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
243
                res = cls.unpack(op._ops, res)
Martin Reinecke's avatar
Martin Reinecke committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
            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
259 260
        self._domain = self._ops[-1].domain
        self._target = self._ops[0].target
Martin Reinecke's avatar
Martin Reinecke committed
261 262 263
        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
264

Martin Reinecke's avatar
Martin Reinecke committed
265
    def apply(self, x):
266
        self._check_input(x)
Martin Reinecke's avatar
Martin Reinecke committed
267 268 269 270
        for op in reversed(self._ops):
            x = op(x)
        return x

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
    def simplify_for_constant_input(self, c_inp):
        if c_inp is None:
            return None, self
        if c_inp.domain == self.domain:
            op = _ConstantOperator(self.domain, self(c_inp))
            return op(c_inp), op

        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
287

Martin Reinecke's avatar
Martin Reinecke committed
288 289 290 291 292 293 294 295 296
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
297

Martin Reinecke's avatar
Martin Reinecke committed
298
    def apply(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
299 300
        from ..linearization import Linearization
        from ..sugar import makeOp
301
        self._check_input(x)
Martin Reinecke's avatar
Martin Reinecke committed
302
        lin = isinstance(x, Linearization)
303 304 305
        v = x._val if lin else x
        v1 = v.extract(self._op1.domain)
        v2 = v.extract(self._op2.domain)
Martin Reinecke's avatar
Martin Reinecke committed
306
        if not lin:
307
            return self._op1(v1) * self._op2(v2)
308 309 310
        wm = x.want_metric
        lin1 = self._op1(Linearization.make_var(v1, wm))
        lin2 = self._op2(Linearization.make_var(v2, wm))
Martin Reinecke's avatar
Martin Reinecke committed
311 312
        op = (makeOp(lin1._val)(lin2._jac))._myadd(
            makeOp(lin2._val)(lin1._jac), False)
313
        return lin1.new(lin1._val*lin2._val, op(x.jac))
Martin Reinecke's avatar
Martin Reinecke committed
314

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    def simplify_for_constant_input(self, c_inp):
        if c_inp is None:
            return None, self
        if c_inp.domain == self.domain:
            op = _ConstantOperator(self.domain, self(c_inp))
            return op(c_inp), op

        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
335

Martin Reinecke's avatar
Martin Reinecke committed
336 337
class _OpSum(Operator):
    def __init__(self, op1, op2):
Philipp Arras's avatar
Philipp Arras committed
338
        from ..sugar import domain_union
Martin Reinecke's avatar
Martin Reinecke committed
339 340 341 342
        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
343 344

    def apply(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
345
        from ..linearization import Linearization
346
        self._check_input(x)
Martin Reinecke's avatar
Martin Reinecke committed
347 348 349 350
        lin = isinstance(x, Linearization)
        v = x._val if lin else x
        v1 = v.extract(self._op1.domain)
        v2 = v.extract(self._op2.domain)
Philipp Arras's avatar
Philipp Arras committed
351
        res = None
Martin Reinecke's avatar
Martin Reinecke committed
352 353
        if not lin:
            return self._op1(v1).unite(self._op2(v2))
354 355 356
        wm = x.want_metric
        lin1 = self._op1(Linearization.make_var(v1, wm))
        lin2 = self._op2(Linearization.make_var(v2, wm))
Martin Reinecke's avatar
Martin Reinecke committed
357
        op = lin1._jac._myadd(lin2._jac, False)
Martin Reinecke's avatar
bug fix  
Martin Reinecke committed
358
        res = lin1.new(lin1._val.unite(lin2._val), op(x.jac))
Martin Reinecke's avatar
Martin Reinecke committed
359 360
        if lin1._metric is not None and lin2._metric is not None:
            res = res.add_metric(lin1._metric + lin2._metric)
Philipp Arras's avatar
Philipp Arras committed
361
        return res
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382

    def simplify_for_constant_input(self, c_inp):
        if c_inp is None:
            return None, self
        if c_inp.domain == self.domain:
            op = _ConstantOperator(self.domain, self(c_inp))
            return op(c_inp), op

        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)