WSL/SLF GitLab Repository

Array.h 13.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/***********************************************************************************/
/*  Copyright 2009 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    MeteoIO 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef ARRAY_H
#define ARRAY_H

#include <vector>
#include <limits>
#include <iostream>

25
26
27
#include <meteoio/IOUtils.h>
#include <meteoio/IOExceptions.h>

28
29
30
31
32
33
34
#define NOSAFECHECKS
namespace mio {

/**
 * @class Array
 * @brief The template class Array is a 1D array (vector) able to hold any type of object as datatype
 *
35
 * @ingroup data_str
36
37
38
39
40
41
42
43
 * @author Thomas Egger
 * @date   2009-05-02
 */

template<class T> class Array {
	public:
		Array(const unsigned int& asize=0);

44
45
46
47
48
49
50
		/**
		* A constructor that creates an array filled with constant values
		* @param asize size of the new array
		* @param init initial value to fill the array with
		*/
		Array(const unsigned int& asize, const T& init);

51
52
		unsigned int size();
		void resize(const unsigned int& asize);
53
		void resize(const unsigned int& asize, const T& init);
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
		void clear();
		void insertAt(const int& index, T e);
		void removeAt(const unsigned int& index);
		/**
		* @brief returns the minimum value contained in the grid
		* @param flag_nodata specify how to process nodata values (see NODATA_HANLDING)
		* @return minimum value
		*/
		T getMin(const IOUtils::nodata_handling flag_nodata=IOUtils::PARSE_NODATA) const;
		/**
		* @brief returns the maximum value contained in the grid
		* @param flag_nodata specify how to process nodata values (see NODATA_HANLDING)
		* @return maximum value
		*/
		T getMax(const IOUtils::nodata_handling flag_nodata=IOUtils::PARSE_NODATA) const;
		/**
		* @brief returns the mean value contained in the grid
		* @param flag_nodata specify how to process nodata values (see NODATA_HANLDING)
		* @return mean value
		*/
		T getMean(const IOUtils::nodata_handling flag_nodata=IOUtils::PARSE_NODATA) const;
75
76
77
78
79
80
81
82
83
84
85
86
87
88
		/**
		* @brief returns the sum of values contained in the grid
		* @param flag_nodata specify how to process nodata values (see NODATA_HANLDING)
		* @return sum
		*/
		T getSum(const IOUtils::nodata_handling flag_nodata=IOUtils::PARSE_NODATA) const;
		/**
		* @brief returns the grid of the absolute value of values contained in the grid
		* @param flag_nodata specify how to process nodata values (see NODATA_HANLDING)
		* @return grid of abs(grid)
		*/
		const Array<T> getAbs(const IOUtils::nodata_handling flag_nodata=IOUtils::PARSE_NODATA) const;
		void abs(const IOUtils::nodata_handling flag_nodata=IOUtils::PARSE_NODATA);

89
90
91
92
93
94
95
96

		template<class P> friend std::ostream& operator<<(std::ostream& os, const Array<P>& array);
		T& operator [](const unsigned int& index);
		const T operator [](const unsigned int& index) const;
		T& operator ()(const unsigned int& index);
		const T operator ()(const unsigned int& index) const;

		Array<T>& operator =(const Array<T>&);
97
		Array<T>& operator =(const T& value);
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
		
		Array<T>& operator+=(const T& rhs);
		const Array<T> operator+(const T& rhs);
		Array<T>& operator+=(const Array<T>& rhs);
		const Array<T> operator+(const Array<T>& rhs);

		Array<T>& operator-=(const T& rhs);
		const Array<T> operator-(const T& rhs);
		Array<T>& operator-=(const Array<T>& rhs);
		const Array<T> operator-(const Array<T>& rhs);

		Array<T>& operator*=(const T& rhs);
		const Array<T> operator*(const T& rhs);
		Array<T>& operator*=(const Array<T>& rhs);
		const Array<T> operator*(const Array<T>& rhs);

		Array<T>& operator/=(const T& rhs);
		const Array<T> operator/(const T& rhs);
		Array<T>& operator/=(const Array<T>& rhs);
		const Array<T> operator/(const Array<T>& rhs);

	protected:
		std::vector<T> vecData; ///<the actual data structure, that holds the objects of type T
		unsigned int nx; ///<this is introduced to omit the costly vecData.size()
};

template<class T> Array<T>::Array(const unsigned int& asize) {
	resize(asize);
126
127
128
129
}

template<class T> Array<T>::Array(const unsigned int& asize, const T& init) {
	resize(asize, init);
130
131
132
133
134
135
136
}

template<class T> unsigned int Array<T>::size() {
	return nx;
}

template<class T> void Array<T>::resize(const unsigned int& asize) {
137
138
	vecData.resize(asize);
	nx = asize;
139
140
}

141
142
143
144
145
146
template<class T> void Array<T>::resize(const unsigned int& asize, const T& init) {
	resize(asize);
	std::fill(vecData.begin(), vecData.end(), init);
}


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
template<class T> T& Array<T>::operator()(const unsigned int& index) {
#ifndef NOSAFECHECKS
	if (index >= nx) {
		throw IndexOutOfBoundsException("", AT);
	}
#endif
	return vecData[index];
}

template<class T> const T Array<T>::operator()(const unsigned int& index) const {
#ifndef NOSAFECHECKS
	if (index >= nx) {
		throw IndexOutOfBoundsException("", AT);
	}
#endif
	return vecData[index];
}

template<class T> T& Array<T>::operator [](const unsigned int& index) {
#ifndef NOSAFECHECKS
	if (index >= nx) {
		throw IndexOutOfBoundsException("", AT);
	}
#endif
	
	return vecData[index];
}

template<class T> const T Array<T>::operator [](const unsigned int& index) const {
#ifndef NOSAFECHECKS
	if (index >= nx) {
		throw IndexOutOfBoundsException("", AT);
	}
#endif

	return vecData[index];
}

template<class T> void Array<T>::clear() {
	vecData.clear();
	nx = 0;
}

template<class T> std::ostream& operator<<(std::ostream& os, const Array<T>& array) {
	os << "<array1d>\n";
	for(unsigned int ii=0; ii<array.nx; ii++) {
		os << array(ii) << " ";
	}
	os << "\n</array1d>\n";
	return os;
}

template<class T> void Array<T>::insertAt(const int& index, T e) {
	if (index < 0) {
		vecData.push_back(e);
                nx++;
	} else if ((index >= 0) && (index < (int)vecData.size())) {
		vecData.insert(vecData.begin() + index, e);
		nx++;
	} else {
		throw IndexOutOfBoundsException("", AT);
	}
}

template<class T> void Array<T>::removeAt(const unsigned int& index) {
	if (index < vecData.size()) {
		vecData.erase(vecData.begin()+index);
		nx--;
	}
}

template<class T> T Array<T>::getMin(const IOUtils::nodata_handling flag_nodata) const {

	T min = std::numeric_limits<T>::max();

	if(flag_nodata==IOUtils::RAW_NODATA) {
		for (unsigned int ii=0; ii<nx; ii++) {
			const T val = vecData[ii];
			if(val<min) min=val;
		}
		return min;
	} else if(flag_nodata==IOUtils::PARSE_NODATA) {
		for (unsigned int ii=0; ii<nx; ii++) {
			const T val = vecData[ii];
			if(val!=IOUtils::nodata && val<min) min=val;
		}
		if(min!=std::numeric_limits<T>::max()) return min;
		else return (T)IOUtils::nodata;
	} else {
		throw InvalidArgumentException("Unknown nodata_handling flag",AT);
	}
}

template<class T> T Array<T>::getMax(const IOUtils::nodata_handling flag_nodata) const {

	T max = -std::numeric_limits<T>::max();

	if(flag_nodata==IOUtils::RAW_NODATA) {
		for (unsigned int ii=0; ii<nx; ii++) {
			const T val = vecData[ii];
			if(val>max) max=val;
		}
		return max;
	} else if(flag_nodata==IOUtils::PARSE_NODATA) {
		for (unsigned int ii=0; ii<nx; ii++) {
			const T val = vecData[ii];
			if(val!=IOUtils::nodata && val>max) max=val;
		}
		if(max!=-std::numeric_limits<T>::max()) return max;
		else return (T)IOUtils::nodata;
	} else {
		throw InvalidArgumentException("Unknown nodata_handling flag",AT);
	}
}

template<class T> T Array<T>::getMean(const IOUtils::nodata_handling flag_nodata) const {

	T mean = 0;

	if(flag_nodata==IOUtils::RAW_NODATA) {
		for (unsigned int ii=0; ii<nx; ii++) {
			const T val = vecData[ii];
			mean += val;
		}
		const unsigned int count = nx;
		if(count>0) return mean/(T)(count);
		else return (T)0;
	} else if(flag_nodata==IOUtils::PARSE_NODATA) {
		unsigned int count = 0;
		for (unsigned int ii=0; ii<nx; ii++) {
			const T val = vecData[ii];
			if(val!=IOUtils::nodata) {
				mean += val;
				count++;
			}
		}
		if(count>0) return mean/(T)(count);
		else return (T)IOUtils::nodata;
	} else {
		throw InvalidArgumentException("Unknown nodata_handling flag",AT);
	}
}

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
template<class T> T Array<T>::getSum(const IOUtils::nodata_handling flag_nodata) const {

	T sum = 0;

	if(flag_nodata==IOUtils::RAW_NODATA) {
		for (unsigned int ii=0; ii<nx; ii++) {
			sum += vecData[ii];
		}
		return sum;
	} else if(flag_nodata==IOUtils::PARSE_NODATA) {
		bool empty=true;
		for (unsigned int ii=0; ii<nx; ii++) {
			const T val = vecData[ii];
			if(val!=IOUtils::nodata) {
				sum += val;
				empty=false;
			}
		}
		if(!empty) return sum;
		else return (T)IOUtils::nodata;
	} else {
		throw InvalidArgumentException("Unknown nodata_handling flag",AT);
	}
}

template<class T> void Array<T>::abs(const IOUtils::nodata_handling flag_nodata) {
	if(std::numeric_limits<T>::is_signed) {
		if(flag_nodata==IOUtils::RAW_NODATA) {
			for (unsigned int ii=0; ii<nx; ii++) {
				T& val = operator()(ii);
				if(val<0) val=-val;
			}
		} else if(flag_nodata==IOUtils::PARSE_NODATA) {
			for (unsigned int ii=0; ii<nx; ii++) {
				T& val = operator()(ii);
				if(val<0 && val!=IOUtils::nodata) val=-val;
			}
		} else {
			throw InvalidArgumentException("Unknown nodata_handling flag",AT);
		}
	}
}


template<class T> const Array<T> Array<T>::getAbs(const IOUtils::nodata_handling flag_nodata) const {
	Array<T> result = *this; //make a copy
	result.abs(flag_nodata); //already implemented

	return result;
}

341
342
343
344
345
346
347
348
349
//arithmetic operators
template<class T> Array<T>& Array<T>::operator=(const Array<T>& source) {
	if(this != &source) {
		vecData = source.vecData;
		nx = source.nx;
	}
	return *this;
}

350
351
352
353
354
355
template<class T> Array<T>& Array<T>::operator=(const T& value) {
	//reset every single member of the Array3D<T>
	std::fill(vecData.begin(), vecData.end(), value);
	return *this;
}

356
357
358
359
360
361
362
363
template<class T> Array<T>& Array<T>::operator+=(const Array<T>& rhs)
{
	//They have to have equal size
	if (rhs.nx != nx)
		throw IOException("Trying to add two Array objects with different dimensions", AT);

	//Add to every single member of the Array<T>
	for (unsigned int ii=0; ii<nx; ii++) {
364
365
		operator()(ii) += rhs(ii);
	}
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381

	return *this;
}

template<class T> const Array<T> Array<T>::operator+(const Array<T>& rhs)
{
	Array<T> result = *this; //make a copy
	result += rhs; //already implemented

	return result;
}

template<class T> Array<T>& Array<T>::operator+=(const T& rhs)
{
	//Add to every single member of the Array<T>
	for (unsigned int ii=0; ii<nx; ii++) {
382
		operator()(ii) += rhs;
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
	}

	return *this;
}

template<class T> const Array<T> Array<T>::operator+(const T& rhs)
{
	Array<T> result = *this;
	result += rhs; //already implemented

	return result;
}

template<class T> Array<T>& Array<T>::operator-=(const Array<T>& rhs)
{
	//They have to have equal size
	if (rhs.nx != nx)
		throw IOException("Trying to substract two Array objects with different dimensions", AT);

	//Substract to every single member of the Array<T>
	for (unsigned int ii=0; ii<nx; ii++) {
404
		operator()(ii) -= rhs(ii);
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
	}

	return *this;
}

template<class T> const Array<T> Array<T>::operator-(const Array<T>& rhs)
{
	Array<T> result = *this; //make a copy
	result -= rhs; //already implemented

	return result;
}

template<class T> Array<T>& Array<T>::operator-=(const T& rhs)
{
	//Substract to every single member of the Array<T>
	for (unsigned int ii=0; ii<nx; ii++) {
422
		operator()(ii) -= rhs;
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
	}

	return *this;
}

template<class T> const Array<T> Array<T>::operator-(const T& rhs)
{
	Array<T> result = *this;
	result -= rhs; //already implemented

	return result;
}

template<class T> Array<T>& Array<T>::operator*=(const Array<T>& rhs)
{
	//They have to have equal size
	if (rhs.nx != nx)
		throw IOException("Trying to multiply two Array objects with different dimensions", AT);

	//Add to every single member of the Array<T>
	for (unsigned int ii=0; ii<nx; ii++) {
444
		operator()(ii) *= rhs(ii);
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
	}

	return *this;
}

template<class T> const Array<T> Array<T>::operator*(const Array<T>& rhs)
{
	Array<T> result = *this; //make a copy
	result *= rhs; //already implemented

	return result;
}

template<class T> Array<T>& Array<T>::operator*=(const T& rhs)
{
	//Add to every single member of the Array<T>
	for (unsigned int ii=0; ii<nx; ii++) {
462
		operator()(ii) *= rhs;
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
	}

	return *this;
}

template<class T> const Array<T> Array<T>::operator*(const T& rhs)
{
	Array<T> result = *this;
	result *= rhs; //already implemented

	return result;
}

template<class T> Array<T>& Array<T>::operator/=(const Array<T>& rhs)
{
	//They have to have equal size
	if (rhs.nx != nx)
		throw IOException("Trying to divide two Array objects with different dimensions", AT);

	//Divide every single member of the Array<T>
	for (unsigned int ii=0; ii<nx; ii++) {
484
		operator()(ii) /= rhs(ii);
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
	}

	return *this;
}

template<class T> const Array<T> Array<T>::operator/(const Array<T>& rhs)
{
	Array<T> result = *this; //make a copy
	result /= rhs; //already implemented

	return result;
}

template<class T> Array<T>& Array<T>::operator/=(const T& rhs)
{
	//Divide every single member of the Array<T>
	for (unsigned int ii=0; ii<nx; ii++) {
502
		operator()(ii) /= rhs;
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
	}

	return *this;
}

template<class T> const Array<T> Array<T>::operator/(const T& rhs)
{
	Array<T> result = *this;
	result /= rhs; //already implemented

	return result;
}

} //end namespace mio

#endif