This repository has been archived by the owner on Oct 25, 2019. It is now read-only.
/
var_regular_array.h
378 lines (291 loc) · 15.1 KB
/
var_regular_array.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
/* =================================================================================================
(c - MIT) T.W.J. de Geus (Tom) | tom@geus.me | www.geus.me | github.com/tdegeus/cppmat
================================================================================================= */
#ifndef CPPMAT_VAR_REGULAR_ARRAY_H
#define CPPMAT_VAR_REGULAR_ARRAY_H
// -------------------------------------------------------------------------------------------------
#include "cppmat.h"
// -------------------------------------------------------------------------------------------------
namespace cppmat {
// =================================================================================================
// cppmat::array
// =================================================================================================
template<class X>
class array
{
protected:
static const size_t MAX_DIM=6; // maximum number of dimensions
size_t mSize=0; // total size == data.size() == prod(shape)
size_t mRank=0; // rank (number of axes)
size_t mShape[MAX_DIM]; // number of entries along each axis
size_t mStrides[MAX_DIM]; // stride length for each index
std::vector<X> mData; // data container
bool mPeriodic=false; // if true: disable bounds-check where possible
public:
// constructor: default
array() = default;
// constructor: allocate, don't initialize
array(const std::vector<size_t> &shape);
// constructor: copy from own class (with different type)
template<typename U, typename=typename std::enable_if<std::is_convertible<U,X>::value>::type>
array(const cppmat::array<U> &A);
// constructor: copy from fixed size
template<size_t rank, size_t i, size_t j, size_t k, size_t l, size_t m, size_t n>
array(const cppmat::tiny::array<X,rank,i,j,k,l,m,n> &A);
// constructor: copy from view
template<size_t rank, size_t i, size_t j, size_t k, size_t l, size_t m, size_t n>
array(const cppmat::view::array<X,rank,i,j,k,l,m,n> &A);
// named constructor: initialize
static array<X> Random (const std::vector<size_t> &shape, X lower=(X)0, X upper=(X)1);
static array<X> Arange (const std::vector<size_t> &shape);
static array<X> Zero (const std::vector<size_t> &shape);
static array<X> Ones (const std::vector<size_t> &shape);
static array<X> Constant(const std::vector<size_t> &shape, X D);
static array<X> Copy (const std::vector<size_t> &shape, const std::vector<X> &D);
// named constructor: copy
template<typename It> static array<X> Copy(const std::vector<size_t> &shape, It first);
template<typename It> static array<X> Copy(const std::vector<size_t> &shape, It first, It last);
// return plain storage as vector
template<typename U, typename=typename std::enable_if<std::is_convertible<U,X>::value>::type>
operator std::vector<U> () const;
// resize
void resize (const std::vector<size_t> &shape);
void resize (const std::vector<size_t> &shape, const X &D);
void reshape(const std::vector<size_t> &shape);
void chrank (size_t rank);
// modify bounds-checks
void setPeriodic(bool periodic);
// get dimensions
size_t size() const;
size_t rank() const;
size_t shape(int i) const;
size_t shape(size_t i) const;
std::vector<size_t> shape() const;
std::vector<size_t> strides(bool bytes=false) const;
// index operators: access plain storage
X& operator[](size_t i);
const X& operator[](size_t i) const;
// index operators: access using array-indices
X& operator()(int a);
const X& operator()(int a) const;
X& operator()(int a, int b);
const X& operator()(int a, int b) const;
X& operator()(int a, int b, int c);
const X& operator()(int a, int b, int c) const;
X& operator()(int a, int b, int c, int d);
const X& operator()(int a, int b, int c, int d) const;
X& operator()(int a, int b, int c, int d, int e);
const X& operator()(int a, int b, int c, int d, int e) const;
X& operator()(int a, int b, int c, int d, int e, int f);
const X& operator()(int a, int b, int c, int d, int e, int f) const;
// index operators: access using array-indices
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
X& operator()(T a);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
const X& operator()(T a) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
X& operator()(T a, T b);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
const X& operator()(T a, T b) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
X& operator()(T a, T b, T c);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
const X& operator()(T a, T b, T c) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
X& operator()(T a, T b, T c, T d);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
const X& operator()(T a, T b, T c, T d) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
X& operator()(T a, T b, T c, T d, T e);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
const X& operator()(T a, T b, T c, T d, T e) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
X& operator()(T a, T b, T c, T d, T e, T f);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
const X& operator()(T a, T b, T c, T d, T e, T f) const;
// index operators: access using iterator
// N.B. the iterator points to list of array-indices (a,b,c,...)
template<class Iterator> X& at(Iterator first, Iterator last);
template<class Iterator> const X& at(Iterator first, Iterator last) const;
// index operators: array-indices -> plain storage (a,b,c,... -> i)
size_t compress(int a) const;
size_t compress(int a, int b) const;
size_t compress(int a, int b, int c) const;
size_t compress(int a, int b, int c, int d) const;
size_t compress(int a, int b, int c, int d, int e) const;
size_t compress(int a, int b, int c, int d, int e, int f) const;
// index operators: array-indices -> plain storage (a,b,c,... -> i)
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
size_t compress(T a) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
size_t compress(T a, T b) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
size_t compress(T a, T b, T c) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
size_t compress(T a, T b, T c, T d) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
size_t compress(T a, T b, T c, T d, T e) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
size_t compress(T a, T b, T c, T d, T e, T f) const;
// index operators: plain storage -> array-indices (i -> a,b,c,...)
std::vector<size_t> decompress(size_t i) const;
// pointer to data
X* data();
const X* data() const;
// iterator to first and last entry
auto begin();
auto begin() const;
auto end();
auto end() const;
// iterator to specific entry: access plain storage
auto index(size_t i);
auto index(size_t i) const;
// iterator to specific entry: access using array-indices
auto item(int a);
auto item(int a) const;
auto item(int a, int b);
auto item(int a, int b) const;
auto item(int a, int b, int c);
auto item(int a, int b, int c) const;
auto item(int a, int b, int c, int d);
auto item(int a, int b, int c, int d) const;
auto item(int a, int b, int c, int d, int e);
auto item(int a, int b, int c, int d, int e) const;
auto item(int a, int b, int c, int d, int e, int f);
auto item(int a, int b, int c, int d, int e, int f) const;
// iterator to specific entry: access using array-indices
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b, T c);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b, T c) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b, T c, T d);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b, T c, T d) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b, T c, T d, T e);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b, T c, T d, T e) const;
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b, T c, T d, T e, T f);
template<typename T, typename=typename std::enable_if<std::is_unsigned<T>::value,void>::type>
auto item(T a, T b, T c, T d, T e, T f) const;
// slice
// - allowing negative index
template<typename T, typename=typename std::enable_if<std::is_integral<T>::value,void>::type>
array<X> slice(
const std::vector<T> &a=std::vector<T>(), const std::vector<T> &b=std::vector<T>(),
const std::vector<T> &c=std::vector<T>(), const std::vector<T> &d=std::vector<T>(),
const std::vector<T> &e=std::vector<T>(), const std::vector<T> &f=std::vector<T>()
) const;
// - only positive indices
array<X> slice(
const std::vector<int> &a=std::vector<int>(), const std::vector<int> &b=std::vector<int>(),
const std::vector<int> &c=std::vector<int>(), const std::vector<int> &d=std::vector<int>(),
const std::vector<int> &e=std::vector<int>(), const std::vector<int> &f=std::vector<int>()
) const;
// return padded array
array<X> pad(const std::vector<size_t> &pad_width, X D=static_cast<X>(0));
// initialization
void setRandom(X lower=(X)0, X upper=(X)1);
void setArange();
void setZero();
void setOnes();
void setConstant(X D);
template<typename Iterator> void setCopy(Iterator first);
template<typename Iterator> void setCopy(Iterator first, Iterator last);
// copy to target
template<typename Iterator> void copyTo(Iterator first) const;
template<typename Iterator> void copyTo(Iterator first, Iterator last) const;
// sign change
array<X> operator- () const;
array<X> operator+ () const;
// arithmetic operators
array<X>& operator*= (const array<X> &B);
array<X>& operator/= (const array<X> &B);
array<X>& operator+= (const array<X> &B);
array<X>& operator-= (const array<X> &B);
array<X>& operator*= (const X &B);
array<X>& operator/= (const X &B);
array<X>& operator+= (const X &B);
array<X>& operator-= (const X &B);
// absolute value
array<X> abs() const;
// norm (sum of absolute values)
X norm() const;
// return the indices that would sort an array
array<size_t> argsort(bool ascending=true) const;
// location of the minimum/maximum: plain storage (use decompress to convert to indices)
size_t argmin() const;
size_t argmax() const;
// minimum
X min() const;
array<X> min(int axis) const;
array<X> min(size_t axis) const;
array<X> min(const std::vector<int> &axes) const;
// maximum
X max() const;
array<X> max(int axis) const;
array<X> max(size_t axis) const;
array<X> max(const std::vector<int> &axes) const;
// sum
X sum() const;
array<X> sum(int axis) const;
array<X> sum(size_t axis) const;
array<X> sum(const std::vector<int> &axes) const;
// mean
double mean() const;
array<X> mean(int axis) const;
array<X> mean(size_t axis) const;
array<X> mean(const std::vector<int> &axes) const;
// weighted average
double average(const array<X> &weights, bool norm=true) const;
array<X> average(const array<X> &weights, int axis, bool norm=true) const;
array<X> average(const array<X> &weights, size_t axis, bool norm=true) const;
array<X> average(const array<X> &weights, const std::vector<int> &axes, bool norm=true) const;
// return array of booleans, based on condition
array<int> equal (const X &D) const;
array<int> not_equal (const X &D) const;
array<int> greater (const X &D) const;
array<int> greater_equal(const X &D) const;
array<int> less (const X &D) const;
array<int> less_equal (const X &D) const;
array<int> equal (const array<X> &D) const;
array<int> not_equal (const array<X> &D) const;
array<int> greater (const array<X> &D) const;
array<int> greater_equal(const array<X> &D) const;
array<int> less (const array<X> &D) const;
array<int> less_equal (const array<X> &D) const;
// find the plain storage indices of all non-zero entries
std::vector<size_t> where() const;
};
// equality operators
template<class X> bool operator!= (const array<X> &A, const array<X> &B);
template<class X> bool operator== (const array<X> &A, const array<X> &B);
// external arithmetic operators
template<class X> array<X> operator* (const array<X> &A, const array<X> &B);
template<class X> array<X> operator/ (const array<X> &A, const array<X> &B);
template<class X> array<X> operator+ (const array<X> &A, const array<X> &B);
template<class X> array<X> operator- (const array<X> &A, const array<X> &B);
template<class X> array<X> operator* (const array<X> &A, const X &B);
template<class X> array<X> operator/ (const array<X> &A, const X &B);
template<class X> array<X> operator+ (const array<X> &A, const X &B);
template<class X> array<X> operator- (const array<X> &A, const X &B);
template<class X> array<X> operator* (const X &A, const array<X> &B);
template<class X> array<X> operator/ (const X &A, const array<X> &B);
template<class X> array<X> operator+ (const X &A, const array<X> &B);
template<class X> array<X> operator- (const X &A, const array<X> &B);
// print operator
template<class X> std::ostream& operator<<(std::ostream& out, const array<X>& src);
// =================================================================================================
} // namespace ...
// -------------------------------------------------------------------------------------------------
#endif