sum_operator.py 6.72 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1 2 3 4 5 6 7 8 9 10 11 12 13
# 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/>.
#
14
# Copyright(C) 2013-2018 Max-Planck-Society
Martin Reinecke's avatar
Martin Reinecke committed
15 16 17 18
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.

19 20
from __future__ import absolute_import, division, print_function
from ..compat import *
Martin Reinecke's avatar
Martin Reinecke committed
21
from ..utilities import my_sum
Martin Reinecke's avatar
Martin Reinecke committed
22
from .linear_operator import LinearOperator
Martin Reinecke's avatar
Martin Reinecke committed
23
import numpy as np
Martin Reinecke's avatar
Martin Reinecke committed
24 25 26


class SumOperator(LinearOperator):
Martin Reinecke's avatar
Martin Reinecke committed
27 28
    """Class representing sums of operators."""

Martin Reinecke's avatar
Martin Reinecke committed
29
    def __init__(self, ops, neg, dom, tgt, _callingfrommake=False):
30 31
        if not _callingfrommake:
            raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
32
        super(SumOperator, self).__init__()
33 34
        self._ops = ops
        self._neg = neg
Martin Reinecke's avatar
Martin Reinecke committed
35 36
        self._domain = dom
        self._target = tgt
37 38 39 40 41 42 43 44 45
        self._capability = self.TIMES | self.ADJOINT_TIMES
        for op in ops:
            self._capability &= op.capability

    @staticmethod
    def simplify(ops, neg):
        from .scaling_operator import ScalingOperator
        from .diagonal_operator import DiagonalOperator
        # Step 1: verify domains
Martin Reinecke's avatar
Martin Reinecke committed
46 47
        dom = ops[0].domain
        tgt = ops[0].target
48
        for op in ops[1:]:
Martin Reinecke's avatar
Martin Reinecke committed
49 50
            if dom is not op.domain or tgt is not op.target:
                raise ValueError("Domain mismatch")
Martin Reinecke's avatar
Martin Reinecke committed
51

52 53 54
        # Step 2: unpack SumOperators
        opsnew = []
        negnew = []
55
        for op, ng in zip(ops, neg):
56 57 58
            if isinstance(op, SumOperator):
                opsnew += op._ops
                if ng:
Martin Reinecke's avatar
fixes  
Martin Reinecke committed
59
                    negnew += [not n for n in op._neg]
60
                else:
Martin Reinecke's avatar
fixes  
Martin Reinecke committed
61
                    negnew += list(op._neg)
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
            else:
                opsnew.append(op)
                negnew.append(ng)
        ops = opsnew
        neg = negnew
        # Step 3: collect ScalingOperators
        sum = 0.
        opsnew = []
        negnew = []
        lastdom = ops[-1].domain
        for op, ng in zip(ops, neg):
            if isinstance(op, ScalingOperator):
                sum += op._factor * (-1 if ng else 1)
            else:
                opsnew.append(op)
                negnew.append(ng)
        if sum != 0.:
            # try to absorb the factor into a DiagonalOperator
            for i in range(len(opsnew)):
                if isinstance(opsnew[i], DiagonalOperator):
                    sum *= (-1 if negnew[i] else 1)
Martin Reinecke's avatar
Martin Reinecke committed
83
                    opsnew[i] = opsnew[i]._add(sum)
84 85 86 87 88
                    sum = 0.
                    break
        if sum != 0:
            # have to add the scaling operator at the end
            opsnew.append(ScalingOperator(sum, lastdom))
89
            negnew.append(False)
90 91 92
        ops = opsnew
        neg = negnew
        # Step 4: combine DiagonalOperators where possible
93 94 95 96 97 98
        processed = [False] * len(ops)
        opsnew = []
        negnew = []
        for i in range(len(ops)):
            if not processed[i]:
                if isinstance(ops[i], DiagonalOperator):
Martin Reinecke's avatar
Martin Reinecke committed
99 100
                    op = ops[i]
                    opneg = neg[i]
101
                    for j in range(i+1, len(ops)):
Martin Reinecke's avatar
Martin Reinecke committed
102 103 104
                        if isinstance(ops[j], DiagonalOperator):
                            op = op._combine_sum(ops[j], opneg, neg[j])
                            opneg = False
105
                            processed[j] = True
Martin Reinecke's avatar
Martin Reinecke committed
106 107
                    opsnew.append(op)
                    negnew.append(opneg)
108 109 110 111 112
                else:
                    opsnew.append(ops[i])
                    negnew.append(neg[i])
        ops = opsnew
        neg = negnew
Martin Reinecke's avatar
Martin Reinecke committed
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
        # Step 5: combine BlockDiagonalOperators where possible
        from ..multi.block_diagonal_operator import BlockDiagonalOperator
        processed = [False] * len(ops)
        opsnew = []
        negnew = []
        for i in range(len(ops)):
            if not processed[i]:
                if isinstance(ops[i], BlockDiagonalOperator):
                    op = ops[i]
                    opneg = neg[i]
                    for j in range(i+1, len(ops)):
                        if isinstance(ops[j], BlockDiagonalOperator):
                            op = op._combine_sum(ops[j], opneg, neg[j])
                            opneg = False
                            processed[j] = True
                    opsnew.append(op)
                    negnew.append(opneg)
                else:
                    opsnew.append(ops[i])
                    negnew.append(neg[i])
        ops = opsnew
        neg = negnew
Martin Reinecke's avatar
Martin Reinecke committed
135
        return ops, neg, dom, tgt
136 137 138

    @staticmethod
    def make(ops, neg):
139 140 141 142 143 144
        """Build a SumOperator (or something simpler if possible)

        Parameters
        ----------
        ops: list of LinearOperator
            Individual operators of the sum.
Martin Reinecke's avatar
typo  
Martin Reinecke committed
145
        neg: list of bool
146
            Same length as ops.
Martin Reinecke's avatar
typo  
Martin Reinecke committed
147
            If True then the equivalent operator gets a minus in the sum.
148
        """
149 150
        ops = tuple(ops)
        neg = tuple(neg)
Martin Reinecke's avatar
bug fix  
Martin Reinecke committed
151 152
        if len(ops) == 0:
            raise ValueError("ops is empty")
153
        if len(ops) != len(neg):
154
            raise ValueError("length mismatch between ops and neg")
Martin Reinecke's avatar
Martin Reinecke committed
155
        ops, neg, dom, tgt = SumOperator.simplify(ops, neg)
156 157
        if len(ops) == 1 and not neg[0]:
            return ops[0]
Martin Reinecke's avatar
Martin Reinecke committed
158
        return SumOperator(ops, neg, dom, tgt, _callingfrommake=True)
Martin Reinecke's avatar
Martin Reinecke committed
159 160 161

    @property
    def domain(self):
Martin Reinecke's avatar
Martin Reinecke committed
162
        return self._domain
Martin Reinecke's avatar
Martin Reinecke committed
163 164 165

    @property
    def target(self):
Martin Reinecke's avatar
Martin Reinecke committed
166
        return self._target
Martin Reinecke's avatar
Martin Reinecke committed
167

Martin Reinecke's avatar
Martin Reinecke committed
168 169 170 171
    @property
    def adjoint(self):
        return self.make([op.adjoint for op in self._ops], self._neg)

Martin Reinecke's avatar
Martin Reinecke committed
172 173
    @property
    def capability(self):
Martin Reinecke's avatar
Martin Reinecke committed
174
        return self._capability
Martin Reinecke's avatar
Martin Reinecke committed
175 176 177

    def apply(self, x, mode):
        self._check_mode(mode)
178 179 180 181
        res = None
        for op, neg in zip(self._ops, self._neg):
            if res is None:
                res = -op.apply(x, mode) if neg else op.apply(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
182
            else:
183 184
                if neg:
                    res = res - op.apply(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
185
                else:
186
                    res = res + op.apply(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
187
        return res
Martin Reinecke's avatar
Martin Reinecke committed
188

189 190
    def draw_sample(self, from_inverse=False, dtype=np.float64):
        if from_inverse:
191 192
            raise NotImplementedError(
                "cannot draw from inverse of this operator")
Martin Reinecke's avatar
Martin Reinecke committed
193 194
        return my_sum(map(lambda op: op.draw_sample(from_inverse, dtype),
                          self._ops))