domain_tuple.py 4.91 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.

19
from __future__ import absolute_import, division, print_function
20

21
from .compat import *
Martin Reinecke's avatar
Martin Reinecke committed
22
from .domains.domain import Domain
Martin Reinecke's avatar
Martin Reinecke committed
23

Martin Reinecke's avatar
Martin Reinecke committed
24

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

28
29
    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
30
31
    This corresponds to a tensor product of the corresponding vector
    fields.
Martin Reinecke's avatar
Martin Reinecke committed
32
33
34
35
36
37
38

    Notes
    -----

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

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

    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
58
        return tuple(res)
Martin Reinecke's avatar
Martin Reinecke committed
59
60
61

    @staticmethod
    def make(domain):
Martin Reinecke's avatar
Martin Reinecke committed
62
63
64
65
66
67
68
69
70
71
72
73
        """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
74
75
        if isinstance(domain, DomainTuple):
            return domain
76
77
78
79
        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
80
        obj = DomainTuple(domain, _callingfrommake=True)
81
82
        DomainTuple._tupleCache[domain] = obj
        return obj
Martin Reinecke's avatar
Martin Reinecke committed
83
84
85
86
87

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

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

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

    @property
    def shape(self):
Martin Reinecke's avatar
Martin Reinecke committed
105
106
107
108
109
        """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
110
111
        return self._shape

112
113
114
115
116
117
118
119
120
121
    @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
122
    @property
Martin Reinecke's avatar
Martin Reinecke committed
123
    def size(self):
Martin Reinecke's avatar
Martin Reinecke committed
124
125
126
127
        """int : total number of pixels.

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

    @property
    def axes(self):
Martin Reinecke's avatar
Martin Reinecke committed
132
        """tuple of tuple of int : axis indices of the underlying domains"""
Martin Reinecke's avatar
Martin Reinecke committed
133
134
135
136
137
138
139
140
141
        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
142
143
        if self is x:
            return True
Martin Reinecke's avatar
Martin Reinecke committed
144
        return self._dom == x._dom
Martin Reinecke's avatar
Martin Reinecke committed
145
146

    def __ne__(self, x):
Martin Reinecke's avatar
Martin Reinecke committed
147
        return not self.__eq__(x)
148
149

    def __str__(self):
Martin Reinecke's avatar
Martin Reinecke committed
150
151
        res = "DomainTuple, len: " + str(len(self))
        for i in self:
152
153
            res += "\n" + str(i)
        return res
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
154
155
156
157
158
159

    @staticmethod
    def scalar_domain():
        if DomainTuple._scalarDomain is None:
            DomainTuple._scalarDomain = DomainTuple.make(())
        return DomainTuple._scalarDomain