field.py 25.2 KB
Newer Older
1
from enum import Enum
2
from itertools import chain
Martin Bauer's avatar
Martin Bauer committed
3
from typing import Tuple, Sequence, Optional, List
4
5
6
7
import numpy as np
import sympy as sp
from sympy.core.cache import cacheit
from sympy.tensor import IndexedBase
8

9
from pystencils.assignment import Assignment
10
from pystencils.alignedarray import aligned_empty
Martin Bauer's avatar
Martin Bauer committed
11
from pystencils.data_types import TypedSymbol, create_type, create_composite_type_from_string, StructType
Martin Bauer's avatar
Martin Bauer committed
12
from pystencils.sympyextensions import is_integer_sequence
13
14


15
16
17
18
19
20
21
22
23
24
class FieldType(Enum):
    # generic fields
    GENERIC = 0
    # index fields are currently only used for boundary handling
    # the coordinates are not the loop counters in that case, but are read from this index field
    INDEXED = 1
    # communication buffer, used for (un)packing data in communication.
    BUFFER = 2

    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
25
    def is_generic(field):
26
        assert isinstance(field, Field)
Martin Bauer's avatar
Martin Bauer committed
27
        return field.field_type == FieldType.GENERIC
28
29

    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
30
    def is_indexed(field):
31
        assert isinstance(field, Field)
Martin Bauer's avatar
Martin Bauer committed
32
        return field.field_type == FieldType.INDEXED
33
34

    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
35
    def is_buffer(field):
36
        assert isinstance(field, Field)
Martin Bauer's avatar
Martin Bauer committed
37
        return field.field_type == FieldType.BUFFER
38
39


Michael Kuron's avatar
Michael Kuron committed
40
class Field(object):
41
42
43
44
    """
    With fields one can formulate stencil-like update rules on structured grids.
    This Field class knows about the dimension, memory layout (strides) and optionally about the size of an array.

Martin Bauer's avatar
Martin Bauer committed
45
46
47
48
    Creating Fields:

        To create a field use one of the static create* members. There are two options:

49
        1. create a kernel with fixed loop sizes i.e. the shape of the array is already known. This is usually the
Martin Bauer's avatar
Martin Bauer committed
50
           case if just-in-time compilation directly from Python is done. (see :func:`Field.create_from_numpy_array`)
51
        2. create a more general kernel that works for variable array sizes. This can be used to create kernels
Martin Bauer's avatar
Martin Bauer committed
52
           beforehand for a library. (see :func:`Field.create_generic`)
53
54
55
56

    Dimensions:
        A field has spatial and index dimensions, where the spatial dimensions come first.
        The interpretation is that the field has multiple cells in (usually) two or three dimensional space which are
Martin Bauer's avatar
Martin Bauer committed
57
58
        looped over. Additionally  N values are stored per cell. In this case spatial_dimensions is two or three,
        and index_dimensions equals N. If you want to store a matrix on each point in a two dimensional grid, there
Martin Bauer's avatar
Martin Bauer committed
59
        are four dimensions, two spatial and two index dimensions: ``len(arr.shape) == spatial_dims + index_dims``
60
61
62

    Indexing:
        When accessing (indexing) a field the result is a FieldAccess which is derived from sympy Symbol.
Martin Bauer's avatar
Martin Bauer committed
63
        First specify the spatial offsets in [], then in case index_dimension>0 the indices in ()
Martin Bauer's avatar
Martin Bauer committed
64
        e.g. ``f[-1,0,0](7)``
65
66
67

    Example without index dimensions:
        >>> a = np.zeros([10, 10])
Martin Bauer's avatar
Martin Bauer committed
68
        >>> f = Field.create_from_numpy_array("f", a, index_dimensions=0)
69
70
71
72
        >>> jacobi = ( f[-1,0] + f[1,0] + f[0,-1] + f[0,1] ) / 4

    Example with index dimensions: LBM D2Q9 stream pull
        >>> stencil = np.array([[0,0], [0,1], [0,-1]])
Martin Bauer's avatar
Martin Bauer committed
73
74
        >>> src = Field.create_generic("src", spatial_dimensions=2, index_dimensions=1)
        >>> dst = Field.create_generic("dst", spatial_dimensions=2, index_dimensions=1)
75
        >>> for i, offset in enumerate(stencil):
76
77
78
79
        ...     Assignment(dst[0,0](i), src[-offset](i))
        Assignment(dst_C^0, src_C^0)
        Assignment(dst_C^1, src_S^1)
        Assignment(dst_C^2, src_N^2)
80
    """
81
82

    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
83
84
    def create_generic(field_name, spatial_dimensions, dtype=np.float64, index_dimensions=0, layout='numpy',
                       index_shape=None, field_type=FieldType.GENERIC) -> 'Field':
85
86
87
        """
        Creates a generic field where the field size is not fixed i.e. can be called with arrays of different sizes

Martin Bauer's avatar
Martin Bauer committed
88
89
90
91
92
93
94
        Args:
            field_name: symbolic name for the field
            dtype: numpy data type of the array the kernel is called with later
            spatial_dimensions: see documentation of Field
            index_dimensions: see documentation of Field
            layout: tuple specifying the loop ordering of the spatial dimensions e.g. (2, 1, 0 ) means that
                    the outer loop loops over dimension 2, the second outer over dimension 1, and the inner loop
Martin Bauer's avatar
Martin Bauer committed
95
                    over dimension 0. Also allowed: the strings 'numpy' (0,1,..d) or 'reverse_numpy' (d, ..., 1, 0)
Martin Bauer's avatar
Martin Bauer committed
96
97
98
99
100
            index_shape: optional shape of the index dimensions i.e. maximum values allowed for each index dimension,
                        has to be a list or tuple
            field_type: besides the normal GENERIC fields, there are INDEXED fields that store indices of the domain
                        that should be iterated over, and BUFFER fields that are used to generate
                        communication packing/unpacking kernels
101
        """
102
        if isinstance(layout, str):
Martin Bauer's avatar
Martin Bauer committed
103
104
105
106
107
108
            layout = spatial_layout_string_to_tuple(layout, dim=spatial_dimensions)
        shape_symbol = IndexedBase(TypedSymbol(Field.SHAPE_PREFIX + field_name, Field.SHAPE_DTYPE), shape=(1,))
        stride_symbol = IndexedBase(TypedSymbol(Field.STRIDE_PREFIX + field_name, Field.STRIDE_DTYPE), shape=(1,))
        total_dimensions = spatial_dimensions + index_dimensions
        if index_shape is None or len(index_shape) == 0:
            shape = tuple([shape_symbol[i] for i in range(total_dimensions)])
109
        else:
Martin Bauer's avatar
Martin Bauer committed
110
            shape = tuple([shape_symbol[i] for i in range(spatial_dimensions)] + list(index_shape))
111

Martin Bauer's avatar
Martin Bauer committed
112
        strides = tuple([stride_symbol[i] for i in range(total_dimensions)])
113

Martin Bauer's avatar
Martin Bauer committed
114
115
116
        np_data_type = np.dtype(dtype)
        if np_data_type.fields is not None:
            if index_dimensions != 0:
117
118
119
120
                raise ValueError("Structured arrays/fields are not allowed to have an index dimension")
            shape += (1,)
            strides += (1,)

Martin Bauer's avatar
Martin Bauer committed
121
        return Field(field_name, field_type, dtype, layout, shape, strides)
122

123
    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
124
125
126
    def create_from_numpy_array(field_name: str, array: np.ndarray, index_dimensions: int = 0) -> 'Field':
        """Creates a field based on the layout, data type, and shape of a given numpy array.

127
        Kernels created for these kind of fields can only be called with arrays of the same layout, shape and type.
Martin Bauer's avatar
Martin Bauer committed
128
129
130
131
132

        Args:
            field_name: symbolic name for the field
            array: numpy array
            index_dimensions: see documentation of Field
133
        """
Martin Bauer's avatar
Martin Bauer committed
134
135
        spatial_dimensions = len(array.shape) - index_dimensions
        if spatial_dimensions < 1:
136
137
            raise ValueError("Too many index dimensions. At least one spatial dimension required")

Martin Bauer's avatar
Martin Bauer committed
138
139
140
        full_layout = get_layout_of_array(array)
        spatial_layout = tuple([i for i in full_layout if i < spatial_dimensions])
        assert len(spatial_layout) == spatial_dimensions
141

Martin Bauer's avatar
Martin Bauer committed
142
143
        strides = tuple([s // np.dtype(array.dtype).itemsize for s in array.strides])
        shape = tuple(int(s) for s in array.shape)
144

Martin Bauer's avatar
Martin Bauer committed
145
146
147
        numpy_dtype = np.dtype(array.dtype)
        if numpy_dtype.fields is not None:
            if index_dimensions != 0:
148
149
150
151
                raise ValueError("Structured arrays/fields are not allowed to have an index dimension")
            shape += (1,)
            strides += (1,)

Martin Bauer's avatar
Martin Bauer committed
152
        return Field(field_name, FieldType.GENERIC, array.dtype, spatial_layout, shape, strides)
153
154

    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
155
156
    def create_fixed_size(field_name: str, shape: Tuple[int, ...], index_dimensions: int = 0,
                          dtype=np.float64, layout: str = 'numpy', strides: Optional[Sequence[int]]=None) -> 'Field':
157
        """
158
        Creates a field with fixed sizes i.e. can be called only with arrays of the same size and layout
159

Martin Bauer's avatar
Martin Bauer committed
160
161
162
163
164
165
166
        Args:
            field_name: symbolic name for the field
            shape: overall shape of the array
            index_dimensions: how many of the trailing dimensions are interpreted as index (as opposed to spatial)
            dtype: numpy data type of the array the kernel is called with later
            layout: full layout of array, not only spatial dimensions
            strides: strides in bytes or None to automatically compute them from shape (assuming no padding)
167
        """
Martin Bauer's avatar
Martin Bauer committed
168
169
        spatial_dimensions = len(shape) - index_dimensions
        assert spatial_dimensions >= 1
170

171
        if isinstance(layout, str):
Martin Bauer's avatar
Martin Bauer committed
172
            layout = layout_string_to_tuple(layout, spatial_dimensions + index_dimensions)
173
174

        shape = tuple(int(s) for s in shape)
175
        if strides is None:
Martin Bauer's avatar
Martin Bauer committed
176
            strides = compute_strides(shape, layout)
177
178
179
        else:
            assert len(strides) == len(shape)
            strides = tuple([s // np.dtype(dtype).itemsize for s in strides])
180

Martin Bauer's avatar
Martin Bauer committed
181
182
183
        numpy_dtype = np.dtype(dtype)
        if numpy_dtype.fields is not None:
            if index_dimensions != 0:
184
185
186
187
                raise ValueError("Structured arrays/fields are not allowed to have an index dimension")
            shape += (1,)
            strides += (1,)

Martin Bauer's avatar
Martin Bauer committed
188
189
190
191
        spatial_layout = list(layout)
        for i in range(spatial_dimensions, len(layout)):
            spatial_layout.remove(i)
        return Field(field_name, FieldType.GENERIC, dtype, tuple(spatial_layout), shape, strides)
192

Martin Bauer's avatar
Martin Bauer committed
193
    def __init__(self, field_name, field_type, dtype, layout, shape, strides):
194
        """Do not use directly. Use static create* methods"""
Martin Bauer's avatar
Martin Bauer committed
195
196
        self._fieldName = field_name
        assert isinstance(field_type, FieldType)
Martin Bauer's avatar
Martin Bauer committed
197
        self.field_type = field_type
Martin Bauer's avatar
Martin Bauer committed
198
        self._dtype = create_type(dtype)
Martin Bauer's avatar
Martin Bauer committed
199
        self._layout = normalize_layout(layout)
200
201
        self.shape = shape
        self.strides = strides
Martin Bauer's avatar
Martin Bauer committed
202
        self.latex_name: Optional[str] = None
203

Martin Bauer's avatar
Martin Bauer committed
204
    def new_field_with_different_name(self, new_name):
Martin Bauer's avatar
Martin Bauer committed
205
        return Field(new_name, self.field_type, self._dtype, self._layout, self.shape, self.strides)
206

207
    @property
Martin Bauer's avatar
Martin Bauer committed
208
    def spatial_dimensions(self) -> int:
209
210
211
        return len(self._layout)

    @property
Martin Bauer's avatar
Martin Bauer committed
212
    def index_dimensions(self) -> int:
213
        return len(self.shape) - len(self._layout)
214
215
216
217
218
219

    @property
    def layout(self):
        return self._layout

    @property
Martin Bauer's avatar
Martin Bauer committed
220
    def name(self) -> str:
221
222
223
        return self._fieldName

    @property
Martin Bauer's avatar
Martin Bauer committed
224
225
    def spatial_shape(self) -> Tuple[int, ...]:
        return self.shape[:self.spatial_dimensions]
226

227
    @property
Martin Bauer's avatar
Martin Bauer committed
228
    def has_fixed_shape(self):
Martin Bauer's avatar
Martin Bauer committed
229
        return is_integer_sequence(self.shape)
230

231
    @property
Martin Bauer's avatar
Martin Bauer committed
232
233
    def index_shape(self):
        return self.shape[self.spatial_dimensions:]
234

235
    @property
Martin Bauer's avatar
Martin Bauer committed
236
237
    def has_fixed_index_shape(self):
        return is_integer_sequence(self.index_shape)
238

239
    @property
Martin Bauer's avatar
Martin Bauer committed
240
241
    def spatial_strides(self):
        return self.strides[:self.spatial_dimensions]
242
243

    @property
Martin Bauer's avatar
Martin Bauer committed
244
245
    def index_strides(self):
        return self.strides[self.spatial_dimensions:]
246
247
248
249
250
251
252
253

    @property
    def dtype(self):
        return self._dtype

    def __repr__(self):
        return self._fieldName

Martin Bauer's avatar
Martin Bauer committed
254
255
256
257
    def neighbor(self, coord_id, offset):
        offset_list = [0] * self.spatial_dimensions
        offset_list[coord_id] = offset
        return Field.Access(self, tuple(offset_list))
258

259
    def neighbors(self, stencil):
260
        return [self.__getitem__(s) for s in stencil]
261

262
    @property
Martin Bauer's avatar
Martin Bauer committed
263
264
265
    def center_vector(self):
        index_shape = self.index_shape
        if len(index_shape) == 0:
266
            return self.center
Martin Bauer's avatar
Martin Bauer committed
267
268
269
        elif len(index_shape) == 1:
            return sp.Matrix([self(i) for i in range(index_shape[0])])
        elif len(index_shape) == 2:
270
271
272
            def cb(*args):
                r = self.__call__(*args)
                return r
Martin Bauer's avatar
Martin Bauer committed
273
            return sp.Matrix(*index_shape, cb)
274

275
    @property
276
    def center(self):
Martin Bauer's avatar
Martin Bauer committed
277
        center = tuple([0] * self.spatial_dimensions)
278
279
        return Field.Access(self, center)

280
281
282
283
    def __getitem__(self, offset):
        if type(offset) is np.ndarray:
            offset = tuple(offset)
        if type(offset) is str:
Martin Bauer's avatar
Martin Bauer committed
284
            offset = tuple(direction_string_to_offset(offset, self.spatial_dimensions))
285
286
        if type(offset) is not tuple:
            offset = (offset,)
Martin Bauer's avatar
Martin Bauer committed
287
        if len(offset) != self.spatial_dimensions:
288
            raise ValueError("Wrong number of spatial indices: "
Martin Bauer's avatar
Martin Bauer committed
289
                             "Got %d, expected %d" % (len(offset), self.spatial_dimensions))
290
291
292
        return Field.Access(self, offset)

    def __call__(self, *args, **kwargs):
Martin Bauer's avatar
Martin Bauer committed
293
        center = tuple([0] * self.spatial_dimensions)
294
295
296
        return Field.Access(self, center)(*args, **kwargs)

    def __hash__(self):
Martin Bauer's avatar
Martin Bauer committed
297
        return hash((self._layout, self.shape, self.strides, self._dtype, self.field_type, self._fieldName))
298
299

    def __eq__(self, other):
Martin Bauer's avatar
Martin Bauer committed
300
301
        self_tuple = (self.shape, self.strides, self.name, self.dtype, self.field_type)
        other_tuple = (other.shape, other.strides, other.name, other.dtype, other.field_type)
Martin Bauer's avatar
Martin Bauer committed
302
        return self_tuple == other_tuple
303

304
305
306
    PREFIX = "f"
    STRIDE_PREFIX = PREFIX + "stride_"
    SHAPE_PREFIX = PREFIX + "shape_"
Martin Bauer's avatar
Martin Bauer committed
307
308
    STRIDE_DTYPE = create_composite_type_from_string("const int *")
    SHAPE_DTYPE = create_composite_type_from_string("const int *")
309
    DATA_PREFIX = PREFIX + "d_"
310

Martin Bauer's avatar
Martin Bauer committed
311
    # noinspection PyAttributeOutsideInit,PyUnresolvedReferences
312
313
314
315
316
317
    class Access(sp.Symbol):
        def __new__(cls, name, *args, **kwargs):
            obj = Field.Access.__xnew_cached_(cls, name, *args, **kwargs)
            return obj

        def __new_stage2__(self, field, offsets=(0, 0, 0), idx=None):
Martin Bauer's avatar
Martin Bauer committed
318
319
320
            field_name = field.name
            offsets_and_index = chain(offsets, idx) if idx is not None else offsets
            constant_offsets = not any([isinstance(o, sp.Basic) and not o.is_Integer for o in offsets_and_index])
321
322

            if not idx:
Martin Bauer's avatar
Martin Bauer committed
323
                idx = tuple([0] * field.index_dimensions)
324

Martin Bauer's avatar
Martin Bauer committed
325
326
327
            if constant_offsets:
                offset_name = offset_to_direction_string(offsets)
                if field.index_dimensions == 0:
328
                    superscript = None
Martin Bauer's avatar
Martin Bauer committed
329
                elif field.index_dimensions == 1:
330
                    superscript = str(idx[0])
331
                else:
Martin Bauer's avatar
Martin Bauer committed
332
333
334
335
                    idx_str = ",".join([str(e) for e in idx])
                    superscript = idx_str
                if field.has_fixed_index_shape and not isinstance(field.dtype, StructType):
                    for i, bound in zip(idx, field.index_shape):
336
337
                        if i >= bound:
                            raise ValueError("Field index out of bounds")
338
            else:
Martin Bauer's avatar
Martin Bauer committed
339
                offset_name = "%0.10X" % (abs(hash(tuple(offsets_and_index))))
340
                superscript = None
341

Martin Bauer's avatar
Martin Bauer committed
342
            symbol_name = "%s_%s" % (field_name, offset_name)
343
            if superscript is not None:
Martin Bauer's avatar
Martin Bauer committed
344
                symbol_name += "^" + superscript
345

Martin Bauer's avatar
Martin Bauer committed
346
            obj = super(Field.Access, self).__xnew__(self, symbol_name)
347
348
349
350
351
352
353
            obj._field = field
            obj._offsets = []
            for o in offsets:
                if isinstance(o, sp.Basic):
                    obj._offsets.append(o)
                else:
                    obj._offsets.append(int(o))
Martin Bauer's avatar
Martin Bauer committed
354
            obj._offsetName = offset_name
355
            obj._superscript = superscript
356
357
358
359
            obj._index = idx

            return obj

360
        def __getnewargs__(self):
361
            return self.field, self.offsets, self.index
362

Martin Bauer's avatar
Martin Bauer committed
363
        # noinspection SpellCheckingInspection
364
        __xnew__ = staticmethod(__new_stage2__)
Martin Bauer's avatar
Martin Bauer committed
365
        # noinspection SpellCheckingInspection
366
367
368
        __xnew_cached_ = staticmethod(cacheit(__new_stage2__))

        def __call__(self, *idx):
Martin Bauer's avatar
Martin Bauer committed
369
            if self._index != tuple([0]*self.field.index_dimensions):
370
371
372
                raise ValueError("Indexing an already indexed Field.Access")

            idx = tuple(idx)
373

Martin Bauer's avatar
Martin Bauer committed
374
            if self.field.index_dimensions == 0 and idx == (0,):
375
376
                idx = ()

Martin Bauer's avatar
Martin Bauer committed
377
            if len(idx) != self.field.index_dimensions:
378
                raise ValueError("Wrong number of indices: "
Martin Bauer's avatar
Martin Bauer committed
379
                                 "Got %d, expected %d" % (len(idx), self.field.index_dimensions))
380
381
            return Field.Access(self.field, self._offsets, idx)

Martin Bauer's avatar
Martin Bauer committed
382
383
384
        def __getitem__(self, *idx):
            return self.__call__(*idx)

Martin Bauer's avatar
Martin Bauer committed
385
386
387
388
389
        def __iter__(self):
            """This is necessary to work with parts of sympy that test if an object is iterable (e.g. simplify).
            The __getitem__ would make it iterable"""
            raise TypeError("Field access is not iterable")

390
391
392
393
394
395
396
397
        @property
        def field(self):
            return self._field

        @property
        def offsets(self):
            return self._offsets

398
399
400
401
        @offsets.setter
        def offsets(self, value):
            self._offsets = value

402
        @property
Martin Bauer's avatar
Martin Bauer committed
403
        def required_ghost_layers(self):
404
405
406
            return int(np.max(np.abs(self._offsets)))

        @property
Martin Bauer's avatar
Martin Bauer committed
407
        def nr_of_coordinates(self):
408
409
410
            return len(self._offsets)

        @property
Martin Bauer's avatar
Martin Bauer committed
411
        def offset_name(self) -> str:
412
413
414
415
416
417
            return self._offsetName

        @property
        def index(self):
            return self._index

Martin Bauer's avatar
Martin Bauer committed
418
        def get_neighbor(self, *offsets) -> 'Field.Access':
419
420
            return Field.Access(self.field, offsets, self.index)

Martin Bauer's avatar
Martin Bauer committed
421
422
423
424
        def neighbor(self, coord_id: int, offset: Sequence[int]) -> 'Field.Access':
            offset_list = list(self.offsets)
            offset_list[coord_id] += offset
            return Field.Access(self.field, tuple(offset_list), self.index)
425

Martin Bauer's avatar
Martin Bauer committed
426
        def get_shifted(self, *shift)-> 'Field.Access':
427
428
            return Field.Access(self.field, tuple(a + b for a, b in zip(shift, self.offsets)), self.index)

429
        def _hashable_content(self):
Martin Bauer's avatar
Martin Bauer committed
430
431
            super_class_contents = list(super(Field.Access, self)._hashable_content())
            t = tuple(super_class_contents + [hash(self._field), self._index] + self._offsets)
432
            return t
Martin Bauer's avatar
Martin Bauer committed
433

Martin Bauer's avatar
Martin Bauer committed
434
        def _latex(self, _):
435
            n = self._field.latex_name if self._field.latex_name else self._field.name
Martin Bauer's avatar
Martin Bauer committed
436
437
438
439
            if self._superscript:
                return "{{%s}_{%s}^{%s}}" % (n, self._offsetName, self._superscript)
            else:
                return "{{%s}_{%s}}" % (n, self._offsetName)
Martin Bauer's avatar
Martin Bauer committed
440
441


Martin Bauer's avatar
Martin Bauer committed
442
443
def get_layout_from_strides(strides: Sequence[int], index_dimension_ids: Optional[List[int]] = None):
    index_dimension_ids = [] if index_dimension_ids is None else index_dimension_ids
444
    coordinates = list(range(len(strides)))
Martin Bauer's avatar
Martin Bauer committed
445
    relevant_strides = [stride for i, stride in enumerate(strides) if i not in index_dimension_ids]
446
    result = [x for (y, x) in sorted(zip(relevant_strides, coordinates), key=lambda pair: pair[0], reverse=True)]
Martin Bauer's avatar
Martin Bauer committed
447
    return normalize_layout(result)
448
449


Martin Bauer's avatar
Martin Bauer committed
450
451
452
453
454
455
def get_layout_of_array(arr: np.ndarray, index_dimension_ids: Optional[List[int]] = None):
    """ Returns a list indicating the memory layout (linearization order) of the numpy array.

    Examples:
        >>> get_layout_of_array(np.zeros([3,3,3]))
        (0, 1, 2)
Martin Bauer's avatar
Martin Bauer committed
456
457
458
459
460

    In this example the loop over the zeroth coordinate should be the outermost loop,
    followed by the first and second. Elements arr[x,y,0] and arr[x,y,1] are adjacent in memory.
    Normally constructed numpy arrays have this order, however by stride tricks or other frameworks, arrays
    with different memory layout can be created.
Martin Bauer's avatar
Martin Bauer committed
461

Martin Bauer's avatar
Martin Bauer committed
462
    The index_dimension_ids parameter leaves specifies which coordinates should not be
Martin Bauer's avatar
Martin Bauer committed
463
    """
Martin Bauer's avatar
Martin Bauer committed
464
465
    index_dimension_ids = [] if index_dimension_ids is None else index_dimension_ids
    return get_layout_from_strides(arr.strides, index_dimension_ids)
466
467


Martin Bauer's avatar
Martin Bauer committed
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
def create_numpy_array_with_layout(shape, layout, alignment=False, byte_offset=0, **kwargs):
    """Creates numpy array with given memory layout.

    Args:
        shape: shape of the resulting array
        layout: layout as tuple, where the coordinates are ordered from slow to fast
        alignment: number of bytes to align the beginning and the innermost coordinate to, or False for no alignment
        byte_offset: only used when alignment is specified, align not beginning but address at this offset
                     mostly used to align first inner cell, not ghost cells

    Example:
        >>> res = create_numpy_array_with_layout(shape=(2, 3, 4, 5), layout=(3, 2, 0, 1))
        >>> res.shape
        (2, 3, 4, 5)
        >>> get_layout_of_array(res)
        (3, 2, 0, 1)
484
485
    """
    assert set(layout) == set(range(len(shape))), "Wrong layout descriptor"
Martin Bauer's avatar
Martin Bauer committed
486
    cur_layout = list(range(len(shape)))
487
488
    swaps = []
    for i in range(len(layout)):
Martin Bauer's avatar
Martin Bauer committed
489
490
491
492
493
        if cur_layout[i] != layout[i]:
            index_to_swap_with = cur_layout.index(layout[i])
            swaps.append((i, index_to_swap_with))
            cur_layout[i], cur_layout[index_to_swap_with] = cur_layout[index_to_swap_with], cur_layout[i]
    assert tuple(cur_layout) == tuple(layout)
494
495
496
497
498

    shape = list(shape)
    for a, b in swaps:
        shape[a], shape[b] = shape[b], shape[a]

499
500
501
502
503
    if not alignment:
        res = np.empty(shape, order='c', **kwargs)
    else:
        if alignment is True:
            alignment = 8 * 4
Martin Bauer's avatar
Martin Bauer committed
504
        res = aligned_empty(shape, alignment, byte_offset=byte_offset, **kwargs)
505

506
507
508
509
510
    for a, b in reversed(swaps):
        res = res.swapaxes(a, b)
    return res


Martin Bauer's avatar
Martin Bauer committed
511
512
def spatial_layout_string_to_tuple(layout_str: str, dim: int) -> Tuple[int, ...]:
    if layout_str in ('fzyx', 'zyxf'):
513
514
        assert dim <= 3
        return tuple(reversed(range(dim)))
515

Martin Bauer's avatar
Martin Bauer committed
516
    if layout_str in ('fzyx', 'f', 'reverse_numpy', 'SoA'):
517
        return tuple(reversed(range(dim)))
Martin Bauer's avatar
Martin Bauer committed
518
    elif layout_str in ('c', 'numpy', 'AoS'):
519
        return tuple(range(dim))
Martin Bauer's avatar
Martin Bauer committed
520
    raise ValueError("Unknown layout descriptor " + layout_str)
521
522


Martin Bauer's avatar
Martin Bauer committed
523
524
525
def layout_string_to_tuple(layout_str, dim):
    layout_str = layout_str.lower()
    if layout_str == 'fzyx' or layout_str == 'soa':
526
527
        assert dim <= 4
        return tuple(reversed(range(dim)))
Martin Bauer's avatar
Martin Bauer committed
528
    elif layout_str == 'zyxf' or layout_str == 'aos':
529
530
        assert dim <= 4
        return tuple(reversed(range(dim - 1))) + (dim-1,)
Martin Bauer's avatar
Martin Bauer committed
531
    elif layout_str == 'f' or layout_str == 'reverse_numpy':
532
        return tuple(reversed(range(dim)))
Martin Bauer's avatar
Martin Bauer committed
533
    elif layout_str == 'c' or layout_str == 'numpy':
534
        return tuple(range(dim))
Martin Bauer's avatar
Martin Bauer committed
535
    raise ValueError("Unknown layout descriptor " + layout_str)
536
537


Martin Bauer's avatar
Martin Bauer committed
538
def normalize_layout(layout):
539
    """Takes a layout tuple and subtracts the minimum from all entries"""
Martin Bauer's avatar
Martin Bauer committed
540
541
    min_entry = min(layout)
    return tuple(i - min_entry for i in layout)
542
543


Martin Bauer's avatar
Martin Bauer committed
544
def compute_strides(shape, layout):
545
546
    """
    Computes strides assuming no padding exists
Martin Bauer's avatar
Martin Bauer committed
547
548
549
550
551
552
553

    Args:
        shape: shape (size) of array
        layout: layout specification as tuple

    Returns:
        strides in elements, not in bytes
554
    """
Martin Bauer's avatar
Martin Bauer committed
555
556
557
558
    dim = len(shape)
    assert len(layout) == dim
    assert len(set(layout)) == dim
    strides = [0] * dim
559
    product = 1
560
    for j in reversed(layout):
561
562
563
        strides[j] = product
        product *= shape[j]
    return tuple(strides)
Martin Bauer's avatar
Martin Bauer committed
564
565


Martin Bauer's avatar
Martin Bauer committed
566
567
568
def offset_component_to_direction_string(coordinate_id: int, value: int) -> str:
    """Translates numerical offset to string notation.

Martin Bauer's avatar
Martin Bauer committed
569
570
571
572
573
    x offsets are labeled with east 'E' and 'W',
    y offsets with north 'N' and 'S' and
    z offsets with top 'T' and bottom 'B'
    If the absolute value of the offset is bigger than 1, this number is prefixed.

Martin Bauer's avatar
Martin Bauer committed
574
575
576
577
578
579
580
581
582
    Args:
        coordinate_id: integer 0, 1 or 2 standing for x,y and z
        value: integer offset

    Examples:
        >>> offset_component_to_direction_string(0, 1)
        'E'
        >>> offset_component_to_direction_string(1, 2)
        '2N'
Martin Bauer's avatar
Martin Bauer committed
583
    """
Martin Bauer's avatar
Martin Bauer committed
584
585
586
587
    name_components = (('W', 'E'),  # west, east
                       ('S', 'N'),  # south, north
                       ('B', 'T'),  # bottom, top
                       )
Martin Bauer's avatar
Martin Bauer committed
588
589
590
    if value == 0:
        result = ""
    elif value < 0:
Martin Bauer's avatar
Martin Bauer committed
591
        result = name_components[coordinate_id][0]
Martin Bauer's avatar
Martin Bauer committed
592
    else:
Martin Bauer's avatar
Martin Bauer committed
593
        result = name_components[coordinate_id][1]
Martin Bauer's avatar
Martin Bauer committed
594
595
596
597
598
    if abs(value) > 1:
        result = "%d%s" % (abs(value), result)
    return result


Martin Bauer's avatar
Martin Bauer committed
599
def offset_to_direction_string(offsets: Sequence[int]) -> str:
Martin Bauer's avatar
Martin Bauer committed
600
601
    """
    Translates numerical offset to string notation.
Martin Bauer's avatar
Martin Bauer committed
602
603
604
605
606
607
608
609
610
    For details see :func:`offset_component_to_direction_string`
    Args:
        offsets: 3-tuple with x,y,z offset

    Examples:
        >>> offset_to_direction_string([1, -1, 0])
        'SE'
        >>> offset_to_direction_string(([-3, 0, -2]))
        '2B3W'
Martin Bauer's avatar
Martin Bauer committed
611
612
    """
    names = ["", "", ""]
Martin Bauer's avatar
Martin Bauer committed
613
614
    for i in range(len(offsets)):
        names[i] = offset_component_to_direction_string(i, offsets[i])
Martin Bauer's avatar
Martin Bauer committed
615
616
617
618
619
620
    name = "".join(reversed(names))
    if name == "":
        name = "C"
    return name


Martin Bauer's avatar
Martin Bauer committed
621
def direction_string_to_offset(direction: str, dim: int = 3):
Martin Bauer's avatar
Martin Bauer committed
622
    """
Martin Bauer's avatar
Martin Bauer committed
623
    Reverse mapping of :func:`offset_to_direction_string`
Martin Bauer's avatar
Martin Bauer committed
624
625
626
627
628
629
630
631
632
633
634
635

    Args:
        direction: string representation of offset
        dim: dimension of offset, i.e the length of the returned list

    Examples:
        >>> direction_string_to_offset('NW', dim=3)
        array([-1,  1,  0])
        >>> direction_string_to_offset('NW', dim=2)
        array([-1,  1])
        >>> direction_string_to_offset(offset_to_direction_string((3,-2,1)))
        array([ 3, -2,  1])
Martin Bauer's avatar
Martin Bauer committed
636
    """
Martin Bauer's avatar
Martin Bauer committed
637
    offset_dict = {
Martin Bauer's avatar
Martin Bauer committed
638
639
640
641
642
643
644
645
646
647
648
649
650
        'C': np.array([0, 0, 0]),

        'W': np.array([-1, 0, 0]),
        'E': np.array([1, 0, 0]),

        'S': np.array([0, -1, 0]),
        'N': np.array([0, 1, 0]),

        'B': np.array([0, 0, -1]),
        'T': np.array([0, 0, 1]),
    }
    offset = np.array([0, 0, 0])

Martin Bauer's avatar
Martin Bauer committed
651
    while len(direction) > 0:
Martin Bauer's avatar
Martin Bauer committed
652
        factor = 1
Martin Bauer's avatar
Martin Bauer committed
653
654
655
656
657
658
659
660
661
        first_non_digit = 0
        while direction[first_non_digit].isdigit():
            first_non_digit += 1
        if first_non_digit > 0:
            factor = int(direction[:first_non_digit])
            direction = direction[first_non_digit:]
        cur_offset = offset_dict[direction[0]]
        offset += factor * cur_offset
        direction = direction[1:]
Martin Bauer's avatar
Martin Bauer committed
662
    return offset[:dim]