mav.h 10.5 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/*
 *  This file is part of the MR utility library.
 *
 *  This code 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  This code 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 code; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
19
/* Copyright (C) 2019-2020 Max-Planck-Society
Martin Reinecke's avatar
Martin Reinecke committed
20
21
   Author: Martin Reinecke */

Martin Reinecke's avatar
Martin Reinecke committed
22
23
24
25
26
#ifndef MRUTIL_MAV_H
#define MRUTIL_MAV_H

#include <cstdlib>
#include <array>
Martin Reinecke's avatar
Martin Reinecke committed
27
#include <vector>
28
#include <memory>
29
#include "mr_util/infra/error_handling.h"
Martin Reinecke's avatar
Martin Reinecke committed
30
31
32

namespace mr {

Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
33
namespace detail_mav {
Martin Reinecke's avatar
Martin Reinecke committed
34
35
36

using namespace std;

Martin Reinecke's avatar
Martin Reinecke committed
37
38
39
40
41
42
43
44
using shape_t = vector<size_t>;
using stride_t = vector<ptrdiff_t>;

class fmav_info
  {
  protected:
    shape_t shp;
    stride_t str;
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
45
    size_t sz;
Martin Reinecke's avatar
Martin Reinecke committed
46
47
48
49
50
51
52
53
54
55
56

    static size_t prod(const shape_t &shape)
      {
      size_t res=1;
      for (auto sz: shape)
        res*=sz;
      return res;
      }

  public:
    fmav_info(const shape_t &shape_, const stride_t &stride_)
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
57
58
59
60
61
      : shp(shape_), str(stride_), sz(prod(shp))
      {
      MR_assert(shp.size()>0, "at least 1D required");
      MR_assert(shp.size()==str.size(), "dimensions mismatch");
      }
Martin Reinecke's avatar
Martin Reinecke committed
62
    fmav_info(const shape_t &shape_)
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
63
      : shp(shape_), str(shape_.size()), sz(prod(shp))
Martin Reinecke's avatar
Martin Reinecke committed
64
65
      {
      auto ndim = shp.size();
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
66
      MR_assert(ndim>0, "at least 1D required");
Martin Reinecke's avatar
Martin Reinecke committed
67
68
69
70
71
      str[ndim-1]=1;
      for (size_t i=2; i<=ndim; ++i)
        str[ndim-i] = str[ndim-i+1]*ptrdiff_t(shp[ndim-i+1]);
      }
    size_t ndim() const { return shp.size(); }
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
72
    size_t size() const { return sz; }
Martin Reinecke's avatar
Martin Reinecke committed
73
74
75
76
77
78
79
80
81
82
83
84
85
    const shape_t &shape() const { return shp; }
    size_t shape(size_t i) const { return shp[i]; }
    const stride_t &stride() const { return str; }
    const ptrdiff_t &stride(size_t i) const { return str[i]; }
    bool last_contiguous() const
      { return (str.back()==1); }
    bool contiguous() const
      {
      auto ndim = shp.size();
      ptrdiff_t stride=1;
      for (size_t i=0; i<ndim; ++i)
        {
        if (str[ndim-1-i]!=stride) return false;
Martin Reinecke's avatar
Martin Reinecke committed
86
        stride *= ptrdiff_t(shp[ndim-1-i]);
Martin Reinecke's avatar
Martin Reinecke committed
87
88
89
90
91
92
93
        }
      return true;
      }
    bool conformable(const fmav_info &other) const
      { return shp==other.shp; }
  };

Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
94
template<typename T> class membuf
Martin Reinecke's avatar
Martin Reinecke committed
95
96
  {
  protected:
97
98
    using Tsp = shared_ptr<vector<T>>;
    Tsp ptr;
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
99
100
    const T *d;
    bool rw;
Martin Reinecke's avatar
Martin Reinecke committed
101

Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
102
103
104
    membuf(T *d_, const Tsp &p, bool rw_)
      : ptr(p), d(d_), rw(rw_) {}

Martin Reinecke's avatar
Martin Reinecke committed
105
  public:
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
106
107
108
109
110
111
    membuf(T *d_, bool rw_=false)
      : d(d_), rw(rw_) {}
    membuf(const T *d_)
      : d(d_), rw(false) {}
    membuf(size_t sz)
      : ptr(make_unique<vector<T>>(sz)), d(ptr->data()), rw(true) {}
Martin Reinecke's avatar
Martin Reinecke committed
112
113
    membuf(const membuf &other)
      : ptr(other.ptr), d(other.d), rw(false) {}
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
114
    membuf(membuf &other) = default;
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
115
116
    membuf(membuf &&other) = default;

Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
117
    template<typename I> T &vraw(I i)
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
118
      {
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
119
      MR_assert(rw, "array is not writable");
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
120
121
      return const_cast<T *>(d)[i];
      }
Martin Reinecke's avatar
Martin Reinecke committed
122
123
124
125
    template<typename I> const T &operator[](I i) const
      { return d[i]; }
    const T *data() const
      { return d; }
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
126
    T *vdata()
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
127
      {
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
128
      MR_assert(rw, "array is not writable");
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
129
130
      return const_cast<T *>(d);
      }
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
131
    bool writable() { return rw; }
Martin Reinecke's avatar
Martin Reinecke committed
132
  };
133

Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
134
135
// "mav" stands for "multidimensional array view"
template<typename T> class fmav: public fmav_info, public membuf<T>
Martin Reinecke's avatar
Martin Reinecke committed
136
137
  {
  public:
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
138
139
140
141
142
143
144
145
    fmav(const T *d_, const shape_t &shp_, const stride_t &str_)
      : fmav_info(shp_, str_), membuf<T>(d_) {}
    fmav(const T *d_, const shape_t &shp_)
      : fmav_info(shp_), membuf<T>(d_) {}
    fmav(T *d_, const shape_t &shp_, const stride_t &str_, bool rw_)
      : fmav_info(shp_, str_), membuf<T>(d_,rw_) {}
    fmav(T *d_, const shape_t &shp_, bool rw_)
      : fmav_info(shp_), membuf<T>(d_,rw_) {}
146
    fmav(const shape_t &shp_)
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
147
148
149
150
151
      : fmav_info(shp_), membuf<T>(size()) {}
    fmav(T* d_, const fmav_info &info, bool rw_=false)
      : fmav_info(info), membuf<T>(d_, rw_) {}
    fmav(const T* d_, const fmav_info &info)
      : fmav_info(info), membuf<T>(d_) {}
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
152
    fmav(const fmav &other) = default;
Martin Reinecke's avatar
Martin Reinecke committed
153
    fmav(fmav &other) = default;
154
    fmav(fmav &&other) = default;
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
155
156
    fmav(membuf<T> &buf, const shape_t &shp_, const stride_t &str_)
      : fmav_info(shp_, str_), membuf<T>(buf) {}
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
157
158
    fmav(const membuf<T> &buf, const shape_t &shp_, const stride_t &str_)
      : fmav_info(shp_, str_), membuf<T>(buf) {}
Martin Reinecke's avatar
Martin Reinecke committed
159
160
  };

Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
161
template<size_t ndim> class mav_info
Martin Reinecke's avatar
Martin Reinecke committed
162
  {
Martin Reinecke's avatar
Martin Reinecke committed
163
  protected:
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
164
165
    using shape_t = array<size_t, ndim>;
    using stride_t = array<ptrdiff_t, ndim>;
Martin Reinecke's avatar
Martin Reinecke committed
166

Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
167
168
169
170
171
    shape_t shp;
    stride_t str;
    size_t sz;

    static size_t prod(const shape_t &shape)
172
      {
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
173
174
175
176
      size_t res=1;
      for (auto sz: shape)
        res*=sz;
      return res;
177
      }
Martin Reinecke's avatar
Martin Reinecke committed
178
179
180
181
    template<typename... Ns> ptrdiff_t getIdx(size_t dim, size_t n, Ns... ns) const
      { return str[dim]*n + getIdx(dim+1, ns...); }
    ptrdiff_t getIdx(size_t dim, size_t n) const
      { return str[dim]*n; }
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
182
183
184
185
186
187
188

  public:
    mav_info(const shape_t &shape_, const stride_t &stride_)
      : shp(shape_), str(stride_), sz(prod(shp))
      { MR_assert(shp.size()==str.size(), "dimensions mismatch"); }
    mav_info(const shape_t &shape_)
      : shp(shape_), sz(prod(shp))
Martin Reinecke's avatar
Martin Reinecke committed
189
      {
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
190
      MR_assert(ndim>0, "at least 1D required");
Martin Reinecke's avatar
Martin Reinecke committed
191
      str[ndim-1]=1;
Martin Reinecke's avatar
Martin Reinecke committed
192
      for (size_t i=2; i<=ndim; ++i)
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
193
        str[ndim-i] = str[ndim-i+1]*ptrdiff_t(shp[ndim-i+1]);
194
      }
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
195
196
    size_t size() const { return sz; }
    const shape_t &shape() const { return shp; }
Martin Reinecke's avatar
Martin Reinecke committed
197
    size_t shape(size_t i) const { return shp[i]; }
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
198
199
    const stride_t &stride() const { return str; }
    const ptrdiff_t &stride(size_t i) const { return str[i]; }
Martin Reinecke's avatar
Martin Reinecke committed
200
    bool last_contiguous() const
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
201
      { return (str.back()==1); }
Martin Reinecke's avatar
Martin Reinecke committed
202
203
204
205
206
207
    bool contiguous() const
      {
      ptrdiff_t stride=1;
      for (size_t i=0; i<ndim; ++i)
        {
        if (str[ndim-1-i]!=stride) return false;
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
208
        stride *= ptrdiff_t(shp[ndim-1-i]);
Martin Reinecke's avatar
Martin Reinecke committed
209
210
211
        }
      return true;
      }
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
212
    bool conformable(const mav_info &other) const
Martin Reinecke's avatar
Martin Reinecke committed
213
      { return shp==other.shp; }
Martin Reinecke's avatar
Martin Reinecke committed
214
    template<typename... Ns> ptrdiff_t idx(Ns... ns) const
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
215
      {
Martin Reinecke's avatar
Martin Reinecke committed
216
217
      static_assert(ndim==sizeof...(ns), "incorrect number of indices");
      return getIdx(0, ns...);
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
218
      }
Martin Reinecke's avatar
Martin Reinecke committed
219
  };
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
220
221

template<typename T, size_t ndim> class mav: public mav_info<ndim>, public membuf<T>
Martin Reinecke's avatar
Martin Reinecke committed
222
  {
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
223
224
  static_assert((ndim>0) && (ndim<4), "only supports 1D, 2D, and 3D arrays");

Martin Reinecke's avatar
Martin Reinecke committed
225
  protected:
226
227
    using typename mav_info<ndim>::shape_t;
    using typename mav_info<ndim>::stride_t;
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
228
229
230
231
232
    using membuf<T>::d;
    using membuf<T>::ptr;
    using mav_info<ndim>::shp;
    using mav_info<ndim>::str;
    using membuf<T>::rw;
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
233
    using membuf<T>::vraw;
234
235
236
237
238
239
240
241
242
243
244
245
    template<size_t idim, typename Func> void applyHelper(ptrdiff_t idx, Func func)
      {
      if constexpr (idim+1<ndim)
        for (size_t i=0; i<shp[idim]; ++i)
          applyHelper<idim+1, Func>(idx+i*str[idim], func);
      else
        {
        T *d2 = vdata();
        for (size_t i=0; i<shp[idim]; ++i)
          func(d2[idx+i*str[idim]]);
        }
      }
Martin Reinecke's avatar
Martin Reinecke committed
246
247

  public:
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
248
249
250
    using membuf<T>::operator[];
    using membuf<T>::vdata;
    using membuf<T>::data;
Martin Reinecke's avatar
Martin Reinecke committed
251
    using mav_info<ndim>::contiguous;
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
252
253
254
    using mav_info<ndim>::size;
    using mav_info<ndim>::idx;

Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
255
256
257
258
259
260
261
262
    mav(const T *d_, const shape_t &shp_, const stride_t &str_)
      : mav_info<ndim>(shp_, str_), membuf<T>(d_) {}
    mav(T *d_, const shape_t &shp_, const stride_t &str_, bool rw_=false)
      : mav_info<ndim>(shp_, str_), membuf<T>(d_, rw_) {}
    mav(const T *d_, const shape_t &shp_)
      : mav_info<ndim>(shp_), membuf<T>(d_) {}
    mav(T *d_, const shape_t &shp_, bool rw_=false)
      : mav_info<ndim>(shp_), membuf<T>(d_, rw_) {}
263
    mav(const array<size_t,ndim> &shp_)
Martin Reinecke's avatar
stage 1    
Martin Reinecke committed
264
      : mav_info<ndim>(shp_), membuf<T>(size()) {}
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
265
    mav(const mav &other) = default;
Martin Reinecke's avatar
Martin Reinecke committed
266
    mav(mav &other) = default;
267
    mav(mav &&other) = default;
Martin Reinecke's avatar
Martin Reinecke committed
268
269
    operator fmav<T>() const
      {
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
270
      return fmav<T>(*this, {shp.begin(), shp.end()}, {str.begin(), str.end()});
Martin Reinecke's avatar
Martin Reinecke committed
271
      }
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
272
    operator fmav<T>()
Martin Reinecke's avatar
Martin Reinecke committed
273
      {
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
274
      return fmav<T>(*this, {shp.begin(), shp.end()}, {str.begin(), str.end()});
Martin Reinecke's avatar
Martin Reinecke committed
275
      }
Martin Reinecke's avatar
Martin Reinecke committed
276
277
278
279
    template<typename... Ns> const T &operator()(Ns... ns) const
      { return operator[](idx(ns...)); }
    template<typename... Ns> T &v(Ns... ns)
      { return vraw(idx(ns...)); }
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
280
    template<typename Func> void apply(Func func)
281
      {
Martin Reinecke's avatar
Martin Reinecke committed
282
283
      if (contiguous())
        {
284
        T *d2 = vdata();
Martin Reinecke's avatar
Martin Reinecke committed
285
        for (auto v=d2; v!=d2+size(); ++v)
Martin Reinecke's avatar
Martin Reinecke committed
286
287
288
          func(*v);
        return;
        }
289
      applyHelper<0,Func>(0,func);
Martin Reinecke's avatar
Martin Reinecke committed
290
      }
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
291
292
    void fill(const T &val)
      { apply([val](T &v){v=val;}); }
Martin Reinecke's avatar
Martin Reinecke committed
293
294
  };

Martin Reinecke's avatar
Martin Reinecke committed
295
296
297
298
299
300
301
302
303
304
template<typename T, size_t ndim> class MavIter
  {
  protected:
    fmav<T> mav;
    array<size_t, ndim> shp;
    array<ptrdiff_t, ndim> str;
    shape_t pos;
    ptrdiff_t idx_;
    bool done_;

Martin Reinecke's avatar
Martin Reinecke committed
305
306
307
308
309
    template<typename... Ns> ptrdiff_t getIdx(size_t dim, size_t n, Ns... ns) const
      { return str[dim]*n + getIdx(dim+1, ns...); }
    ptrdiff_t getIdx(size_t dim, size_t n) const
      { return str[dim]*n; }

Martin Reinecke's avatar
Martin Reinecke committed
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
  public:
    MavIter(const fmav<T> &mav_)
      : mav(mav_), pos(mav.ndim()-ndim,0), idx_(0), done_(false)
      {
      for (size_t i=0; i<ndim; ++i)
        {
        shp[i] = mav.shape(mav.ndim()-ndim+i);
        str[i] = mav.stride(mav.ndim()-ndim+i);
        }
      }
    MavIter(fmav<T> &mav_)
      : mav(mav_), pos(mav.ndim()-ndim,0), idx_(0), done_(false)
      {
      for (size_t i=0; i<ndim; ++i)
        {
        shp[i] = mav.shape(mav.ndim()-ndim+i);
        str[i] = mav.stride(mav.ndim()-ndim+i);
        }
      }
    bool done() const
      { return done_; }
    void inc()
      {
      for (ptrdiff_t i=mav.ndim()-ndim-1; i>=0; --i)
        {
        idx_+=mav.stride(i);
        if (++pos[i]<mav.shape(i)) return;
        pos[i]=0;
        idx_-=mav.shape(i)*mav.stride(i);
        }
      done_=true;
      }
    size_t shape(size_t i) const { return shp[i]; }
Martin Reinecke's avatar
Martin Reinecke committed
343
344
345
346
347
348
    template<typename... Ns> ptrdiff_t idx(Ns... ns) const
      { return idx_ + getIdx(0, ns...); }
    template<typename... Ns> const T &operator()(Ns... ns) const
      { return mav[idx(ns...)]; }
    template<typename... Ns> T &v(Ns... ns)
      { return mav.vraw(idx(ns...)); }
Martin Reinecke's avatar
Martin Reinecke committed
349
350
  };

Martin Reinecke's avatar
Martin Reinecke committed
351
352
}

Martin Reinecke's avatar
Martin Reinecke committed
353
354
using detail_mav::shape_t;
using detail_mav::stride_t;
Martin Reinecke's avatar
stage 2    
Martin Reinecke committed
355
using detail_mav::fmav_info;
Martin Reinecke's avatar
Martin Reinecke committed
356
using detail_mav::fmav;
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
357
using detail_mav::mav;
Martin Reinecke's avatar
Martin Reinecke committed
358
using detail_mav::MavIter;
Martin Reinecke's avatar
Martin Reinecke committed
359

Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
360
}
Martin Reinecke's avatar
Martin Reinecke committed
361
362

#endif