domain_tuple.py 5.09 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/>.
#
Martin Reinecke's avatar
Martin Reinecke committed
14
# Copyright(C) 2013-2018 Max-Planck-Society
Martin Reinecke's avatar
Martin Reinecke committed
15
16
17
18
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.

Philipp Arras's avatar
Philipp Arras committed
19
from . import utilities
20
from .compat import *
Martin Reinecke's avatar
Martin Reinecke committed
21
from .domains.domain import Domain
Martin Reinecke's avatar
Martin Reinecke committed
22

Martin Reinecke's avatar
Martin Reinecke committed
23

Martin Reinecke's avatar
Martin Reinecke committed
24
class DomainTuple(object):
Martin Reinecke's avatar
Martin Reinecke committed
25
26
    """Ordered sequence of Domain objects.

27
28
    This class holds a tuple of :class:`Domain` objects, which together form
    the space on which a :class:`Field` is defined.
Reimar H Leike's avatar
Reimar H Leike committed
29
30
    This corresponds to a tensor product of the corresponding vector
    fields.
Martin Reinecke's avatar
Martin Reinecke committed
31
32
33
34
35
36
37

    Notes
    -----

    DomainTuples should never be created using the constructor, but rather
    via the factory function :attr:`make`!
    """
38
    _tupleCache = {}
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
39
    _scalarDomain = None
40

Martin Reinecke's avatar
step 1  
Martin Reinecke committed
41
42
43
    def __init__(self, domain, _callingfrommake=False):
        if not _callingfrommake:
            raise NotImplementedError
Martin Reinecke's avatar
Martin Reinecke committed
44
45
        self._dom = self._parse_domain(domain)
        self._axtuple = self._get_axes_tuple()
Martin Reinecke's avatar
Martin Reinecke committed
46
47
48
        self._shape = reduce(lambda x, y: x+y, (sp.shape for sp in self._dom),
                             ())
        self._size = reduce(lambda x, y: x*y, self._shape, 1)
Martin Reinecke's avatar
Martin Reinecke committed
49
50
51
52
53
54
55
56

    def _get_axes_tuple(self):
        i = 0
        res = [None]*len(self._dom)
        for idx, thing in enumerate(self._dom):
            nax = len(thing.shape)
            res[idx] = tuple(range(i, i+nax))
            i += nax
Martin Reinecke's avatar
Martin Reinecke committed
57
        return tuple(res)
Martin Reinecke's avatar
Martin Reinecke committed
58
59
60

    @staticmethod
    def make(domain):
Martin Reinecke's avatar
Martin Reinecke committed
61
62
63
64
65
66
67
68
69
70
71
72
        """Returns a DomainTuple matching `domain`.

        This function checks whether a matching DomainTuple already exists.
        If yes, this object is returned, otherwise a new DomainTuple object
        is created and returned.

        Parameters
        ----------
        domain : Domain or tuple of Domain or DomainTuple
            The geometrical structure for which the DomainTuple shall be
            obtained.
        """
Martin Reinecke's avatar
Martin Reinecke committed
73
74
        if isinstance(domain, DomainTuple):
            return domain
75
76
77
78
        domain = DomainTuple._parse_domain(domain)
        obj = DomainTuple._tupleCache.get(domain)
        if obj is not None:
            return obj
Martin Reinecke's avatar
step 1  
Martin Reinecke committed
79
        obj = DomainTuple(domain, _callingfrommake=True)
80
81
        DomainTuple._tupleCache[domain] = obj
        return obj
Martin Reinecke's avatar
Martin Reinecke committed
82
83
84
85
86

    @staticmethod
    def _parse_domain(domain):
        if domain is None:
            return ()
Martin Reinecke's avatar
Martin Reinecke committed
87
        if isinstance(domain, Domain):
Martin Reinecke's avatar
Martin Reinecke committed
88
89
90
91
92
            return (domain,)

        if not isinstance(domain, tuple):
            domain = tuple(domain)
        for d in domain:
Martin Reinecke's avatar
Martin Reinecke committed
93
            if not isinstance(d, Domain):
Martin Reinecke's avatar
Martin Reinecke committed
94
95
                raise TypeError(
                    "Given object contains something that is not an "
Martin Reinecke's avatar
Martin Reinecke committed
96
                    "instance of Domain class.")
Martin Reinecke's avatar
Martin Reinecke committed
97
98
99
100
101
102
103
        return domain

    def __getitem__(self, i):
        return self._dom[i]

    @property
    def shape(self):
Martin Reinecke's avatar
Martin Reinecke committed
104
105
106
107
108
        """tuple of int: number of pixels along each axis

        The shape of the array-like object required to store information
        living on the DomainTuple.
        """
Martin Reinecke's avatar
Martin Reinecke committed
109
110
        return self._shape

111
112
113
114
115
116
117
118
119
120
    @property
    def local_shape(self):
        """tuple of int: number of pixels along each axis on the local task

        The shape of the array-like object required to store information
        living on part of the domain which is stored on the local MPI task.
        """
        from .dobj import local_shape
        return local_shape(self._shape)

Martin Reinecke's avatar
Martin Reinecke committed
121
    @property
Martin Reinecke's avatar
Martin Reinecke committed
122
    def size(self):
Martin Reinecke's avatar
Martin Reinecke committed
123
124
125
126
        """int : total number of pixels.

        Equivalent to the products over all entries in the object's shape.
        """
Martin Reinecke's avatar
Martin Reinecke committed
127
        return self._size
Martin Reinecke's avatar
Martin Reinecke committed
128
129
130

    @property
    def axes(self):
Martin Reinecke's avatar
Martin Reinecke committed
131
        """tuple of tuple of int : axis indices of the underlying domains"""
Martin Reinecke's avatar
Martin Reinecke committed
132
133
134
135
136
137
138
139
140
        return self._axtuple

    def __len__(self):
        return len(self._dom)

    def __hash__(self):
        return self._dom.__hash__()

    def __eq__(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
141
        return (self is x) or (self._dom == x._dom)
Martin Reinecke's avatar
Martin Reinecke committed
142
143

    def __ne__(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
144
        return not self.__eq__(x)
145
146

    def __str__(self):
Martin Reinecke's avatar
Martin Reinecke committed
147
148
        return ("DomainTuple, len: {}\n".format(len(self)) +
                "\n".join(str(i) for i in self))
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
149

150
151
152
    def __reduce__(self):
        return (_unpickleDomainTuple, (self._dom,))

Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
153
154
155
156
157
    @staticmethod
    def scalar_domain():
        if DomainTuple._scalarDomain is None:
            DomainTuple._scalarDomain = DomainTuple.make(())
        return DomainTuple._scalarDomain
158
159
160
161

    def __repr__(self):
        subs = "\n".join(sub.__repr__() for sub in self._dom)
        return "DomainTuple:\n"+utilities.indent(subs)
162
163
164
165


def _unpickleDomainTuple(*args):
    return DomainTuple.make(*args)