sum_operator.py 6.95 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-2019 Max-Planck-Society
Martin Reinecke's avatar
Martin Reinecke committed
15
#
16
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
17

Philipp Arras's avatar
Philipp Arras committed
18 19
from collections import defaultdict

20 21
import numpy as np

22
from ..compat import *
Martin Reinecke's avatar
Martin Reinecke committed
23
from ..sugar import domain_union
Philipp Arras's avatar
Philipp Arras committed
24 25 26
from ..utilities import indent
from .block_diagonal_operator import BlockDiagonalOperator
from .linear_operator import LinearOperator
Martin Reinecke's avatar
Martin Reinecke committed
27 28 29


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

Martin Reinecke's avatar
Martin Reinecke committed
32
    def __init__(self, ops, neg, dom, tgt, _callingfrommake=False):
33 34 35 36
        if not _callingfrommake:
            raise NotImplementedError
        self._ops = ops
        self._neg = neg
Martin Reinecke's avatar
Martin Reinecke committed
37 38
        self._domain = dom
        self._target = tgt
39 40 41 42 43 44 45 46
        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
Martin Reinecke's avatar
Martin Reinecke committed
47 48

        # unpack SumOperators
49 50
        opsnew = []
        negnew = []
51
        for op, ng in zip(ops, neg):
52 53 54
            if isinstance(op, SumOperator):
                opsnew += op._ops
                if ng:
Martin Reinecke's avatar
fixes  
Martin Reinecke committed
55
                    negnew += [not n for n in op._neg]
56
                else:
Martin Reinecke's avatar
fixes  
Martin Reinecke committed
57
                    negnew += list(op._neg)
58 59 60 61 62
            else:
                opsnew.append(op)
                negnew.append(ng)
        ops = opsnew
        neg = negnew
Martin Reinecke's avatar
Martin Reinecke committed
63 64 65

        # sort operators according to domains
        sorted = defaultdict(list)
66
        for op, ng in zip(ops, neg):
Martin Reinecke's avatar
Martin Reinecke committed
67 68 69 70 71 72 73 74 75 76 77 78 79
            sorted[(op.domain, op.target)].append((op, ng))

        xxops = []
        xxneg = []
        for opset in sorted.values():
            # collect ScalingOperators
            sum = 0.
            opsnew = []
            negnew = []

            for op, ng in opset:
                if isinstance(op, ScalingOperator):
                    sum += op._factor * (-1 if ng else 1)
80
                else:
Martin Reinecke's avatar
Martin Reinecke committed
81
                    opsnew.append(op)
Martin Reinecke's avatar
Martin Reinecke committed
82 83 84 85 86 87 88 89 90 91 92
                    negnew.append(ng)

            lastdom = opset[0][0].domain
            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)
                        opsnew[i] = opsnew[i]._add(sum)
                        sum = 0.
                        break
Martin Reinecke's avatar
fix  
Martin Reinecke committed
93
            if sum != 0 or len(opsnew) == 0:
Martin Reinecke's avatar
Martin Reinecke committed
94 95 96 97 98 99 100 101 102 103 104 105 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 135 136 137 138 139 140 141 142 143 144 145 146
                # have to add the scaling operator at the end
                opsnew.append(ScalingOperator(sum, lastdom))
                negnew.append(False)

            ops = opsnew
            neg = negnew
            # Step 4: combine DiagonalOperators where possible
            processed = [False] * len(ops)
            opsnew = []
            negnew = []
            for i in range(len(ops)):
                if not processed[i]:
                    if isinstance(ops[i], DiagonalOperator):
                        op = ops[i]
                        opneg = neg[i]
                        for j in range(i+1, len(ops)):
                            if isinstance(ops[j], DiagonalOperator):
                                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

            # combine BlockDiagonalOperators where possible
            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])
            xxops += opsnew
            xxneg += negnew

        dom = domain_union([op.domain for op in xxops])
        tgt = domain_union([op.target for op in xxops])
        return xxops, xxneg, dom, tgt
147 148 149

    @staticmethod
    def make(ops, neg):
150 151 152 153 154 155
        """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
156
        neg: list of bool
157
            Same length as ops.
Martin Reinecke's avatar
typo  
Martin Reinecke committed
158
            If True then the equivalent operator gets a minus in the sum.
159
        """
160 161
        ops = tuple(ops)
        neg = tuple(neg)
Martin Reinecke's avatar
bug fix  
Martin Reinecke committed
162 163
        if len(ops) == 0:
            raise ValueError("ops is empty")
164
        if len(ops) != len(neg):
165
            raise ValueError("length mismatch between ops and neg")
Martin Reinecke's avatar
Martin Reinecke committed
166
        ops, neg, dom, tgt = SumOperator.simplify(ops, neg)
Martin Reinecke's avatar
Martin Reinecke committed
167 168
        if len(ops) == 1:
            return -ops[0] if neg[0] else ops[0]
Martin Reinecke's avatar
Martin Reinecke committed
169
        return SumOperator(ops, neg, dom, tgt, _callingfrommake=True)
Martin Reinecke's avatar
Martin Reinecke committed
170

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

Martin Reinecke's avatar
Martin Reinecke committed
175 176
    def apply(self, x, mode):
        self._check_mode(mode)
177 178
        res = None
        for op, neg in zip(self._ops, self._neg):
Martin Reinecke's avatar
Martin Reinecke committed
179
            tmp = op.apply(x.extract(op._dom(mode)), mode)
180
            if res is None:
Martin Reinecke's avatar
Martin Reinecke committed
181
                res = -tmp if neg else tmp
Martin Reinecke's avatar
Martin Reinecke committed
182
            else:
Martin Reinecke's avatar
Martin Reinecke committed
183
                res = res.flexible_addsub(tmp, neg)
Martin Reinecke's avatar
Martin Reinecke committed
184
        return res
Martin Reinecke's avatar
Martin Reinecke committed
185

186 187
    def draw_sample(self, from_inverse=False, dtype=np.float64):
        if from_inverse:
188 189
            raise NotImplementedError(
                "cannot draw from inverse of this operator")
Martin Reinecke's avatar
Martin Reinecke committed
190 191 192 193 194
        res = None
        for op in self._ops:
            tmp = op.draw_sample(from_inverse, dtype)
            res = tmp if res is None else res.unite(tmp)
        return res
Martin Reinecke's avatar
Martin Reinecke committed
195 196 197 198

    def __repr__(self):
        subs = "\n".join(sub.__repr__() for sub in self._ops)
        return "SumOperator:\n"+indent(subs)