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

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.
    """

13
    @abc.abstractproperty
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."""
18
        raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
19

20
    @abc.abstractproperty
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."""
25
        raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
26 27 28 29

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

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

Martin Reinecke's avatar
Martin Reinecke committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
    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
59 60 61
for f in ["sqrt", "exp", "log", "tanh", "positive_tanh"]:
    def func(f):
        def func2(self):
62
            fa = _FunctionApplier(self.target, f)
Martin Reinecke's avatar
Martin Reinecke committed
63 64 65 66 67 68 69 70
            return _OpChain.make((fa, self))
        return func2
    setattr(Operator, f, func(f))


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

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

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

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


Martin Reinecke's avatar
Martin Reinecke committed
86 87 88 89 90 91 92 93 94 95
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
96
                res = cls.unpack(op._ops, res)
Martin Reinecke's avatar
Martin Reinecke committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
            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)
112 113 114 115 116 117 118 119

    @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
120 121 122 123 124 125 126 127 128 129

    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)
130 131 132 133 134 135 136 137

    @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
138 139

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


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])

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

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

Martin Reinecke's avatar
Martin Reinecke committed
158 159
    def __call__(self, x):
        raise NotImplementedError