multi_field.py 8.31 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
27
28
29
from .multi_domain import MultiDomain


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

    @staticmethod
Martin Reinecke's avatar
Martin Reinecke committed
53
54
55
56
    def from_dict(dict, domain=None):
        if domain is None:
            domain = MultiDomain.make({key: v._domain
                                       for key, v in dict.items()})
Martin Reinecke's avatar
Martin Reinecke committed
57
        res = tuple(dict[key] if key in dict else Field(dom, 0)
Martin Reinecke's avatar
tweak    
Martin Reinecke committed
58
59
                    for key, dom in zip(domain.keys(), domain.domains()))
        return MultiField(domain, res)
Martin Reinecke's avatar
Martin Reinecke committed
60
61

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

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

    def keys(self):
Martin Reinecke's avatar
Martin Reinecke committed
68
        return self._domain.keys()
Martin Reinecke's avatar
Martin Reinecke committed
69
70

    def items(self):
Martin Reinecke's avatar
Martin Reinecke committed
71
        return zip(self._domain.keys(), self._val)
Martin Reinecke's avatar
Martin Reinecke committed
72
73

    def values(self):
Martin Reinecke's avatar
Martin Reinecke committed
74
        return self._val
Martin Reinecke's avatar
Martin Reinecke committed
75
76
77

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

Martin Reinecke's avatar
Martin Reinecke committed
80
81
82
83
84
#    @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
85
        return MultiField(self._domain, tuple(op(v) for v in self._val))
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
86

87
88
89
    @property
    def real(self):
        """MultiField : The real part of the multi field"""
Martin Reinecke's avatar
Martin Reinecke committed
90
        return self._transform(lambda x: x.real)
91
92
93
94

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

97
98
    @staticmethod
    def from_random(random_type, domain, dtype=np.float64, **kwargs):
Martin Reinecke's avatar
Martin Reinecke committed
99
100
101
102
        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
103
                          for dom in domain._domains))
104

Martin Reinecke's avatar
Martin Reinecke committed
105
    def _check_domain(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
106
        if other._domain != self._domain:
Martin Reinecke's avatar
Martin Reinecke committed
107
108
109
110
111
            raise ValueError("domains are incompatible.")

    def vdot(self, x):
        result = 0.
        self._check_domain(x)
Martin Reinecke's avatar
Martin Reinecke committed
112
        for v1, v2 in zip(self._val, x._val):
Martin Reinecke's avatar
Martin Reinecke committed
113
            result += v1.vdot(v2)
Martin Reinecke's avatar
Martin Reinecke committed
114
115
        return result

Martin Reinecke's avatar
Martin Reinecke committed
116
117
118
119
120
121
122
#    @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
123

Martin Reinecke's avatar
Martin Reinecke committed
124
    @staticmethod
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
125
    def full(domain, val):
Martin Reinecke's avatar
more    
Martin Reinecke committed
126
        domain = MultiDomain.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
127
        return MultiField(domain, tuple(Field(dom, val)
Martin Reinecke's avatar
Martin Reinecke committed
128
                          for dom in domain._domains))
Martin Reinecke's avatar
Martin Reinecke committed
129

Martin Reinecke's avatar
fixes    
Martin Reinecke committed
130
    def to_global_data(self):
Martin Reinecke's avatar
Martin Reinecke committed
131
132
        return {key: val.to_global_data()
                for key, val in zip(self._domain.keys(), self._val)}
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
133
134
135

    @staticmethod
    def from_global_data(domain, arr, sum_up=False):
Martin Reinecke's avatar
Martin Reinecke committed
136
137
        return MultiField(
            domain, tuple(Field.from_global_data(domain[key], arr[key], sum_up)
Martin Reinecke's avatar
Martin Reinecke committed
138
                          for key in domain.keys()))
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
139

Martin Reinecke's avatar
Martin Reinecke committed
140
141
142
143
144
145
146
    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
147
148
149
150

        Returns
        -------
        norm : float
Martin Reinecke's avatar
Martin Reinecke committed
151
            The norm of the field values.
Martin Reinecke's avatar
Martin Reinecke committed
152
        """
Martin Reinecke's avatar
Martin Reinecke committed
153
154
155
156
157
        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
158

159
160
161
162
163
164
165
166
    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
167
        return utilities.my_sum(map(lambda v: v.sum(), self._val))
168
169
170
171
172
173
174
175
176
177

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

Martin Reinecke's avatar
Martin Reinecke committed
180
    def __neg__(self):
Martin Reinecke's avatar
Martin Reinecke committed
181
        return self._transform(lambda x: -x)
Martin Reinecke's avatar
Martin Reinecke committed
182

183
    def __abs__(self):
Martin Reinecke's avatar
Martin Reinecke committed
184
        return self._transform(lambda x: abs(x))
185

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

189
    def all(self):
Martin Reinecke's avatar
Martin Reinecke committed
190
        for v in self._val:
Martin Reinecke's avatar
Martin Reinecke committed
191
            if not v.all():
192
193
194
195
                return False
        return True

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

Martin Reinecke's avatar
Martin Reinecke committed
201
    def extract(self, subset):
Martin Reinecke's avatar
Martin Reinecke committed
202
203
204
205
        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
206

Martin Reinecke's avatar
more    
Martin Reinecke committed
207
    def unite(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
208
209
        if self._domain is other._domain:
            return self + other
Martin Reinecke's avatar
Martin Reinecke committed
210
211
212
        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
213
        return MultiField.from_dict(res)
Martin Reinecke's avatar
Martin Reinecke committed
214

Martin Reinecke's avatar
Martin Reinecke committed
215
216
217
218
219
220
221
222
223
224
225
    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
226
227
228
    def _binary_op(self, other, op):
        f = getattr(Field, op)
        if isinstance(other, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
229
            if self._domain != other._domain:
Martin Reinecke's avatar
Martin Reinecke committed
230
231
232
233
234
235
236
                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
237

Martin Reinecke's avatar
Martin Reinecke committed
238
239
240
for op in ["__add__", "__radd__",
           "__sub__", "__rsub__",
           "__mul__", "__rmul__",
Martin Reinecke's avatar
Martin Reinecke committed
241
242
243
244
           "__div__", "__rdiv__",
           "__truediv__", "__rtruediv__",
           "__floordiv__", "__rfloordiv__",
           "__pow__", "__rpow__",
Martin Reinecke's avatar
Martin Reinecke committed
245
246
247
           "__lt__", "__le__", "__gt__", "__ge__", "__eq__", "__ne__"]:
    def func(op):
        def func2(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
248
            return self._binary_op(other, op)
Martin Reinecke's avatar
Martin Reinecke committed
249
250
        return func2
    setattr(MultiField, op, func(op))
251

Martin Reinecke's avatar
Martin Reinecke committed
252

253
254
255
256
257
258
259
260
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
261
262
263
264
265


for f in ["sqrt", "exp", "log", "tanh"]:
    def func(f):
        def func2(self):
Martin Reinecke's avatar
bug fix    
Martin Reinecke committed
266
            fu = getattr(Field, f)
Martin Reinecke's avatar
Martin Reinecke committed
267
            return MultiField(self.domain,
Martin Reinecke's avatar
bug fix    
Martin Reinecke committed
268
                              tuple(fu(val) for val in self.values()))
Martin Reinecke's avatar
Martin Reinecke committed
269
270
        return func2
    setattr(MultiField, f, func(f))