multi_field.py 8.68 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.

Martin Reinecke's avatar
Martin Reinecke committed
19
from __future__ import absolute_import, division, print_function
20
21
22

import numpy as np

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


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

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

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

Philipp Arras's avatar
Philipp Arras committed
68
69
70
71
72
    def update(self, other):
        foo = self.to_dict()
        foo.update(other.to_dict())
        return MultiField.from_dict(foo)

Martin Reinecke's avatar
Martin Reinecke committed
73
    def __getitem__(self, key):
Martin Reinecke's avatar
Martin Reinecke committed
74
        return self._val[self._domain.idx[key]]
Martin Reinecke's avatar
Martin Reinecke committed
75
76

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

    def items(self):
Martin Reinecke's avatar
Martin Reinecke committed
80
        return zip(self._domain.keys(), self._val)
Martin Reinecke's avatar
Martin Reinecke committed
81
82

    def values(self):
Martin Reinecke's avatar
Martin Reinecke committed
83
        return self._val
Martin Reinecke's avatar
Martin Reinecke committed
84
85
86

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

Martin Reinecke's avatar
Martin Reinecke committed
89
90
91
92
93
#    @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
94
        return MultiField(self._domain, tuple(op(v) for v in self._val))
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
95

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

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

106
107
    @staticmethod
    def from_random(random_type, domain, dtype=np.float64, **kwargs):
Martin Reinecke's avatar
Martin Reinecke committed
108
109
110
111
        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
112
                          for dom in domain._domains))
113

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

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

Martin Reinecke's avatar
Martin Reinecke committed
125
126
127
128
129
130
131
#    @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
132

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

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

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

Martin Reinecke's avatar
Martin Reinecke committed
149
150
151
152
153
154
155
    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
156
157
158
159

        Returns
        -------
        norm : float
Martin Reinecke's avatar
Martin Reinecke committed
160
            The norm of the field values.
Martin Reinecke's avatar
Martin Reinecke committed
161
        """
Martin Reinecke's avatar
Martin Reinecke committed
162
163
164
165
166
        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
167

168
169
170
171
172
173
174
175
    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
176
        return utilities.my_sum(map(lambda v: v.sum(), self._val))
177
178
179
180
181
182
183
184
185
186

    @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
187
        return utilities.my_sum(map(lambda d: d.size, self._domain.domains()))
188

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

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

Martin Reinecke's avatar
Martin Reinecke committed
195
    def conjugate(self):
Martin Reinecke's avatar
Martin Reinecke committed
196
        return self._transform(lambda x: x.conjugate())
Martin Reinecke's avatar
Martin Reinecke committed
197

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

    def any(self):
Martin Reinecke's avatar
Martin Reinecke committed
205
        for v in self._val:
Martin Reinecke's avatar
Martin Reinecke committed
206
            if v.any():
207
208
209
                return True
        return False

Martin Reinecke's avatar
Martin Reinecke committed
210
    def extract(self, subset):
Martin Reinecke's avatar
Martin Reinecke committed
211
212
213
214
        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
215

Martin Reinecke's avatar
more    
Martin Reinecke committed
216
    def unite(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
217
218
        if self._domain is other._domain:
            return self + other
Martin Reinecke's avatar
Martin Reinecke committed
219
220
221
        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
222
        return MultiField.from_dict(res)
Martin Reinecke's avatar
Martin Reinecke committed
223

Martin Reinecke's avatar
Martin Reinecke committed
224
225
226
227
228
229
230
231
232
233
234
    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
235
236
237
    def _binary_op(self, other, op):
        f = getattr(Field, op)
        if isinstance(other, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
238
            if self._domain != other._domain:
Martin Reinecke's avatar
Martin Reinecke committed
239
240
241
242
243
244
245
                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
246

Martin Reinecke's avatar
Martin Reinecke committed
247
248
249
for op in ["__add__", "__radd__",
           "__sub__", "__rsub__",
           "__mul__", "__rmul__",
Martin Reinecke's avatar
Martin Reinecke committed
250
251
252
253
           "__div__", "__rdiv__",
           "__truediv__", "__rtruediv__",
           "__floordiv__", "__rfloordiv__",
           "__pow__", "__rpow__",
Martin Reinecke's avatar
Martin Reinecke committed
254
255
256
           "__lt__", "__le__", "__gt__", "__ge__", "__eq__", "__ne__"]:
    def func(op):
        def func2(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
257
            return self._binary_op(other, op)
Martin Reinecke's avatar
Martin Reinecke committed
258
259
        return func2
    setattr(MultiField, op, func(op))
260

Martin Reinecke's avatar
Martin Reinecke committed
261

262
263
264
265
266
267
268
269
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
270
271
272
273
274


for f in ["sqrt", "exp", "log", "tanh"]:
    def func(f):
        def func2(self):
Martin Reinecke's avatar
bug fix    
Martin Reinecke committed
275
            fu = getattr(Field, f)
Martin Reinecke's avatar
Martin Reinecke committed
276
            return MultiField(self.domain,
Martin Reinecke's avatar
bug fix    
Martin Reinecke committed
277
                              tuple(fu(val) for val in self.values()))
Martin Reinecke's avatar
Martin Reinecke committed
278
279
        return func2
    setattr(MultiField, f, func(f))