multi_field.py 9.47 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# 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-2018 Max-Planck-Society
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.

19
20
import numpy as np

Philipp Arras's avatar
Philipp Arras committed
21
from . import utilities
Martin Reinecke's avatar
Martin Reinecke committed
22
23
from .compat import *
from .field import Field
Martin Reinecke's avatar
Martin Reinecke committed
24
from .multi_domain import MultiDomain
25
from .domain_tuple import DomainTuple
Martin Reinecke's avatar
Martin Reinecke committed
26
27
28


class MultiField(object):
Martin Reinecke's avatar
Martin Reinecke committed
29
    def __init__(self, domain, val):
Martin Reinecke's avatar
Martin Reinecke committed
30
31
32
        """
        Parameters
        ----------
Martin Reinecke's avatar
Martin Reinecke committed
33
        domain: MultiDomain
Martin Reinecke's avatar
Martin Reinecke committed
34
        val: tuple containing Field entries
Martin Reinecke's avatar
Martin Reinecke committed
35
        """
Martin Reinecke's avatar
Martin Reinecke committed
36
37
38
39
40
41
        if not isinstance(domain, MultiDomain):
            raise TypeError("domain must be of type MultiDomain")
        if not isinstance(val, tuple):
            raise TypeError("val must be a tuple")
        if len(val) != len(domain):
            raise ValueError("length mismatch")
Martin Reinecke's avatar
Martin Reinecke committed
42
        for d, v in zip(domain._domains, val):
Martin Reinecke's avatar
Martin Reinecke committed
43
            if isinstance(v, Field):
Martin Reinecke's avatar
Martin Reinecke committed
44
                if v._domain != d:
Martin Reinecke's avatar
Martin Reinecke committed
45
                    raise ValueError("domain mismatch")
Martin Reinecke's avatar
Martin Reinecke committed
46
47
            else:
                raise TypeError("bad entry in val (must be Field)")
Martin Reinecke's avatar
Martin Reinecke committed
48
49
50
51
        self._domain = domain
        self._val = val

    @staticmethod
Martin Reinecke's avatar
Martin Reinecke committed
52
53
    def from_dict(dict, domain=None):
        if domain is None:
54
55
            for dd in dict.values():
                if not isinstance(dd.domain, DomainTuple):
Martin Reinecke's avatar
Martin Reinecke committed
56
57
                    raise TypeError('Values of dictionary need to be Fields '
                                    'defined on DomainTuples.')
Martin Reinecke's avatar
Martin Reinecke committed
58
59
            domain = MultiDomain.make({key: v._domain
                                       for key, v in dict.items()})
Martin Reinecke's avatar
Martin Reinecke committed
60
        res = tuple(dict[key] if key in dict else Field(dom, 0)
Martin Reinecke's avatar
tweak    
Martin Reinecke committed
61
62
                    for key, dom in zip(domain.keys(), domain.domains()))
        return MultiField(domain, res)
Martin Reinecke's avatar
Martin Reinecke committed
63
64

    def to_dict(self):
Martin Reinecke's avatar
Martin Reinecke committed
65
        return {key: val for key, val in zip(self._domain.keys(), self._val)}
Martin Reinecke's avatar
Martin Reinecke committed
66
67

    def __getitem__(self, key):
Martin Reinecke's avatar
Martin Reinecke committed
68
        return self._val[self._domain.idx[key]]
Martin Reinecke's avatar
Martin Reinecke committed
69

Martin Reinecke's avatar
fix #72    
Martin Reinecke committed
70
    def __contains__(self, key):
Martin Reinecke's avatar
Martin Reinecke committed
71
        return key in self._domain.idx
Martin Reinecke's avatar
fix #72    
Martin Reinecke committed
72

Martin Reinecke's avatar
Martin Reinecke committed
73
    def keys(self):
Martin Reinecke's avatar
Martin Reinecke committed
74
        return self._domain.keys()
Martin Reinecke's avatar
Martin Reinecke committed
75
76

    def items(self):
Martin Reinecke's avatar
Martin Reinecke committed
77
        return zip(self._domain.keys(), self._val)
Martin Reinecke's avatar
Martin Reinecke committed
78
79

    def values(self):
Martin Reinecke's avatar
Martin Reinecke committed
80
        return self._val
Martin Reinecke's avatar
Martin Reinecke committed
81
82
83

    @property
    def domain(self):
84
        return self._domain
Martin Reinecke's avatar
Martin Reinecke committed
85

Martin Reinecke's avatar
Martin Reinecke committed
86
87
88
89
90
#    @property
#    def dtype(self):
#        return {key: val.dtype for key, val in self._val.items()}

    def _transform(self, op):
Martin Reinecke's avatar
Martin Reinecke committed
91
        return MultiField(self._domain, tuple(op(v) for v in self._val))
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
92

93
94
95
    @property
    def real(self):
        """MultiField : The real part of the multi field"""
Martin Reinecke's avatar
Martin Reinecke committed
96
        return self._transform(lambda x: x.real)
97
98
99
100

    @property
    def imag(self):
        """MultiField : The imaginary part of the multi field"""
Martin Reinecke's avatar
Martin Reinecke committed
101
        return self._transform(lambda x: x.imag)
102

103
104
    @staticmethod
    def from_random(random_type, domain, dtype=np.float64, **kwargs):
Martin Reinecke's avatar
Martin Reinecke committed
105
106
107
108
        domain = MultiDomain.make(domain)
#        dtype = MultiField.build_dtype(dtype, domain)
        return MultiField(
            domain, tuple(Field.from_random(random_type, dom, dtype, **kwargs)
Martin Reinecke's avatar
Martin Reinecke committed
109
                          for dom in domain._domains))
110

Martin Reinecke's avatar
Martin Reinecke committed
111
    def _check_domain(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
112
        if other._domain != self._domain:
Martin Reinecke's avatar
Martin Reinecke committed
113
114
115
116
117
            raise ValueError("domains are incompatible.")

    def vdot(self, x):
        result = 0.
        self._check_domain(x)
Martin Reinecke's avatar
Martin Reinecke committed
118
        for v1, v2 in zip(self._val, x._val):
Martin Reinecke's avatar
Martin Reinecke committed
119
            result += v1.vdot(v2)
Martin Reinecke's avatar
Martin Reinecke committed
120
121
        return result

Martin Reinecke's avatar
Martin Reinecke committed
122
123
124
125
126
127
128
#    @staticmethod
#    def build_dtype(dtype, domain):
#        if isinstance(dtype, dict):
#            return dtype
#        if dtype is None:
#            dtype = np.float64
#        return {key: dtype for key in domain.keys()}
Martin Reinecke's avatar
Martin Reinecke committed
129

Martin Reinecke's avatar
Martin Reinecke committed
130
    @staticmethod
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
131
    def full(domain, val):
Martin Reinecke's avatar
more    
Martin Reinecke committed
132
        domain = MultiDomain.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
133
        return MultiField(domain, tuple(Field(dom, val)
Martin Reinecke's avatar
Martin Reinecke committed
134
                          for dom in domain._domains))
Martin Reinecke's avatar
Martin Reinecke committed
135

Martin Reinecke's avatar
fixes    
Martin Reinecke committed
136
    def to_global_data(self):
Martin Reinecke's avatar
Martin Reinecke committed
137
138
        return {key: val.to_global_data()
                for key, val in zip(self._domain.keys(), self._val)}
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
139
140
141

    @staticmethod
    def from_global_data(domain, arr, sum_up=False):
Martin Reinecke's avatar
Martin Reinecke committed
142
143
        return MultiField(
            domain, tuple(Field.from_global_data(domain[key], arr[key], sum_up)
Martin Reinecke's avatar
Martin Reinecke committed
144
                          for key in domain.keys()))
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
145

Martin Reinecke's avatar
Martin Reinecke committed
146
147
148
149
150
151
152
    def norm(self, ord=2):
        """ Computes the norm of the field values.

        Parameters
        ----------
        ord : int, default=2
            accepted values: 1, 2, ..., np.inf
Martin Reinecke's avatar
Martin Reinecke committed
153
154
155
156

        Returns
        -------
        norm : float
Martin Reinecke's avatar
Martin Reinecke committed
157
            The norm of the field values.
Martin Reinecke's avatar
Martin Reinecke committed
158
        """
Martin Reinecke's avatar
Martin Reinecke committed
159
160
161
162
163
        nrm = np.asarray([f.norm(ord) for f in self._val])
        if ord == np.inf:
            return nrm.max()
        return (nrm ** ord).sum() ** (1./ord)
#        return np.sqrt(np.abs(self.vdot(x=self)))
Martin Reinecke's avatar
Martin Reinecke committed
164

165
166
167
168
169
170
171
172
    def sum(self):
        """ Computes the sum all field values.

        Returns
        -------
        norm : float
            The sum of the field values.
        """
Martin Reinecke's avatar
Martin Reinecke committed
173
        return utilities.my_sum(map(lambda v: v.sum(), self._val))
174
175
176
177
178
179
180
181
182
183

    @property
    def size(self):
        """ Computes the overall degrees of freedom.

        Returns
        -------
        size : int
            The sum of the size of the individual fields
        """
Martin Reinecke's avatar
Martin Reinecke committed
184
        return utilities.my_sum(map(lambda d: d.size, self._domain.domains()))
185

Martin Reinecke's avatar
Martin Reinecke committed
186
    def __neg__(self):
Martin Reinecke's avatar
Martin Reinecke committed
187
        return self._transform(lambda x: -x)
Martin Reinecke's avatar
Martin Reinecke committed
188

189
    def __abs__(self):
Martin Reinecke's avatar
Martin Reinecke committed
190
        return self._transform(lambda x: abs(x))
191

Martin Reinecke's avatar
Martin Reinecke committed
192
    def conjugate(self):
Martin Reinecke's avatar
Martin Reinecke committed
193
        return self._transform(lambda x: x.conjugate())
Martin Reinecke's avatar
Martin Reinecke committed
194

195
    def all(self):
Martin Reinecke's avatar
Martin Reinecke committed
196
        for v in self._val:
Martin Reinecke's avatar
Martin Reinecke committed
197
            if not v.all():
198
199
200
201
                return False
        return True

    def any(self):
Martin Reinecke's avatar
Martin Reinecke committed
202
        for v in self._val:
Martin Reinecke's avatar
Martin Reinecke committed
203
            if v.any():
204
205
206
                return True
        return False

Martin Reinecke's avatar
Martin Reinecke committed
207
    def extract(self, subset):
Martin Reinecke's avatar
Martin Reinecke committed
208
209
210
211
        if subset is self._domain:
            return self
        return MultiField(subset,
                          tuple(self[key] for key in subset.keys()))
Martin Reinecke's avatar
Martin Reinecke committed
212

Martin Reinecke's avatar
more    
Martin Reinecke committed
213
    def unite(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
214
215
        if self._domain is other._domain:
            return self + other
Martin Reinecke's avatar
Martin Reinecke committed
216
217
218
        res = self.to_dict()
        for key, val in other.items():
            res[key] = res[key]+val if key in res else val
Martin Reinecke's avatar
Martin Reinecke committed
219
        return MultiField.from_dict(res)
Martin Reinecke's avatar
Martin Reinecke committed
220

221
222
    @staticmethod
    def union(fields, domain=None):
Martin Reinecke's avatar
doc fix    
Martin Reinecke committed
223
224
        """ Returns the union of its input fields.

225
226
        Parameters
        ----------
Martin Reinecke's avatar
doc fix    
Martin Reinecke committed
227
        fields : iterable of MultiFields
Martin Reinecke's avatar
doc fix    
Martin Reinecke committed
228
            The set of input fields. Their domains need not be identical.
Martin Reinecke's avatar
doc fix    
Martin Reinecke committed
229
        domain : MultiDomain or None
Martin Reinecke's avatar
doc fix    
Martin Reinecke committed
230
            If supplied, this will be the domain of the resulting field.
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
            Providing this domain will accelerate the function.

        Returns
        -------
        MultiField
            The union of the input fields

        Notes
        -----
        If the same key occurs more than once in the input fields, the value
        associated with the last occurrence will be put into the output.
        No summation is performed!
        """
        res = {}
        for field in fields:
            res.update(field.to_dict())
        return MultiField.from_dict(res, domain)

Martin Reinecke's avatar
Martin Reinecke committed
249
250
251
252
253
254
255
256
257
258
259
    def flexible_addsub(self, other, neg):
        if self._domain is other._domain:
            return self-other if neg else self+other
        res = self.to_dict()
        for key, val in other.items():
            if key in res:
                res[key] = res[key]-val if neg else res[key]+val
            else:
                res[key] = -val if neg else val
        return MultiField.from_dict(res)

Martin Reinecke's avatar
Martin Reinecke committed
260
261
262
    def _binary_op(self, other, op):
        f = getattr(Field, op)
        if isinstance(other, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
263
            if self._domain != other._domain:
Martin Reinecke's avatar
Martin Reinecke committed
264
265
266
267
268
269
270
                raise ValueError("domain mismatch")
            val = tuple(f(v1, v2)
                        for v1, v2 in zip(self._val, other._val))
        else:
            val = tuple(f(v1, other) for v1 in self._val)
        return MultiField(self._domain, val)

Martin Reinecke's avatar
more    
Martin Reinecke committed
271

Martin Reinecke's avatar
Martin Reinecke committed
272
273
274
for op in ["__add__", "__radd__",
           "__sub__", "__rsub__",
           "__mul__", "__rmul__",
Martin Reinecke's avatar
Martin Reinecke committed
275
276
277
278
           "__div__", "__rdiv__",
           "__truediv__", "__rtruediv__",
           "__floordiv__", "__rfloordiv__",
           "__pow__", "__rpow__",
Martin Reinecke's avatar
Martin Reinecke committed
279
280
281
           "__lt__", "__le__", "__gt__", "__ge__", "__eq__", "__ne__"]:
    def func(op):
        def func2(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
282
            return self._binary_op(other, op)
Martin Reinecke's avatar
Martin Reinecke committed
283
284
        return func2
    setattr(MultiField, op, func(op))
285

Martin Reinecke's avatar
Martin Reinecke committed
286

287
288
289
290
291
292
293
294
for op in ["__iadd__", "__isub__", "__imul__", "__idiv__",
           "__itruediv__", "__ifloordiv__", "__ipow__"]:
    def func(op):
        def func2(self, other):
            raise TypeError(
                "In-place operations are deliberately not supported")
        return func2
    setattr(MultiField, op, func(op))
Martin Reinecke's avatar
Martin Reinecke committed
295
296


297
for f in ["sqrt", "exp", "log", "tanh", "clipped_exp"]:
Martin Reinecke's avatar
Martin Reinecke committed
298
299
    def func(f):
        def func2(self):
Martin Reinecke's avatar
bug fix    
Martin Reinecke committed
300
            fu = getattr(Field, f)
Martin Reinecke's avatar
Martin Reinecke committed
301
            return MultiField(self.domain,
Martin Reinecke's avatar
bug fix    
Martin Reinecke committed
302
                              tuple(fu(val) for val in self.values()))
Martin Reinecke's avatar
Martin Reinecke committed
303
304
        return func2
    setattr(MultiField, f, func(f))