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

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


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 is not 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
        return MultiField(domain, tuple(dict[key] for key in domain.keys()))
Martin Reinecke's avatar
Martin Reinecke committed
58
59

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

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

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

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

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

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

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

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

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

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

Martin Reinecke's avatar
Martin Reinecke committed
103
    def _check_domain(self, other):
Martin Reinecke's avatar
Martin Reinecke committed
104
        if other._domain is not self._domain:
Martin Reinecke's avatar
Martin Reinecke committed
105
106
107
108
109
            raise ValueError("domains are incompatible.")

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

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

Martin Reinecke's avatar
Martin Reinecke committed
122
    @staticmethod
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
123
    def full(domain, val):
Martin Reinecke's avatar
Martin Reinecke committed
124
125
        return MultiField(domain, tuple(Field.full(dom, val)
                          for dom in domain._domains))
Martin Reinecke's avatar
Martin Reinecke committed
126

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

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

Martin Reinecke's avatar
Martin Reinecke committed
137
138
139
140
141
142
143
144
145
146
    def norm(self):
        """ Computes the L2-norm of the field values.

        Returns
        -------
        norm : float
            The L2-norm of the field values.
        """
        return np.sqrt(np.abs(self.vdot(x=self)))

147
148
149
150
151
152
153
154
    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
155
        return utilities.my_sum(map(lambda v: v.sum(), self._val))
156
157
158
159
160
161
162
163
164
165

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

168
169
170
171
172
173
174
175
176
177
    def squared_norm(self):
        """ Computes the square of the L2-norm of the field values.

        Returns
        -------
        float
            The square of the L2-norm of the field values.
        """
        return abs(self.vdot(x=self))

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

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

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

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

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

199
200
201
    def isEquivalentTo(self, other):
        """Determines (as quickly as possible) whether `self`'s content is
        identical to `other`'s content."""
202
203
204
205
        if self is other:
            return True
        if not isinstance(other, MultiField):
            return False
Martin Reinecke's avatar
Martin Reinecke committed
206
        if self._domain is not other._domain:
207
            return False
Martin Reinecke's avatar
Martin Reinecke committed
208
209
        for v1, v2 in zip(self._val, other._val):
            if not v1.isEquivalentTo(v2):
210
211
                return False
        return True
Martin Reinecke's avatar
Martin Reinecke committed
212

Martin Reinecke's avatar
Martin Reinecke committed
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
    def extract(self, subset):
        if isinstance(subset, MultiDomain):
            return MultiField(subset,
                              tuple(self[key] for key in subset.keys()))
        else:
            return MultiField.from_dict({key: self[key] for key in subset})

    @staticmethod
    def combine(fields):
        res = {}
        for f in fields:
            for key in f.keys():
                if key in res:
                    res[key] = res[key]+f[key]
                else:
                    res[key] = f[key]
        return MultiField.from_dict(res)
Martin Reinecke's avatar
Martin Reinecke committed
230

Martin Reinecke's avatar
Martin Reinecke committed
231
232
233
for op in ["__add__", "__radd__",
           "__sub__", "__rsub__",
           "__mul__", "__rmul__",
Martin Reinecke's avatar
Martin Reinecke committed
234
235
236
237
           "__div__", "__rdiv__",
           "__truediv__", "__rtruediv__",
           "__floordiv__", "__rfloordiv__",
           "__pow__", "__rpow__",
Martin Reinecke's avatar
Martin Reinecke committed
238
239
240
           "__lt__", "__le__", "__gt__", "__ge__", "__eq__", "__ne__"]:
    def func(op):
        def func2(self, other):
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
241
            if isinstance(other, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
242
243
                if self._domain is not other._domain:
                    raise ValueError("domain mismatch")
Martin Reinecke's avatar
Martin Reinecke committed
244
                val = tuple(getattr(v1, op)(v2)
Martin Reinecke's avatar
Martin Reinecke committed
245
                            for v1, v2 in zip(self._val, other._val))
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
246
            else:
Martin Reinecke's avatar
Martin Reinecke committed
247
248
                val = tuple(getattr(v1, op)(other) for v1 in self._val)
            return MultiField(self._domain, val)
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))