XdmfArray.hpp 12.4 KB
Newer Older
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
1
2
3
#ifndef XDMFARRAY_HPP_
#define XDMFARRAY_HPP_

4
5
6
// Forward Declarations
class XdmfHDF5Controller;

Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
7
8
// Includes
#include "XdmfItem.hpp"
9
#include <boost/shared_array.hpp>
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
10
11
#include <boost/variant.hpp>

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
/**
 * @brief Provides a single interface for storing a wide variety of data types.
 *
 * XdmfArray stores data values that are read in or will be written to heavy data on disk. The
 * data type stored is determined by the type initially inserted into the XdmfArray.  XdmfArray
 * allows for insertion and retrieval of data in two fundamental ways:
 *
 * By Copy:
 *
 *  copyValues
 * 	getCopyValues
 *
 * 	XdmfArray stores its own copy of the data.  Modifications to the data stored in the XdmfArray will
 * 	not change values stored in the original array.
 *
 * By Shared Reference:
 *
 * 	setValues
 * 	getValues
 *
 * 	XdmfArray shares a reference to the data.  No copy is made. XdmfArray holds a shared pointer to the original
 * 	data.  Modifications to the data stored in the XdmfArray also causes modification to values stored in the original
 * 	array.
 *
 * Xdmf supports the following datatypes:
 * 	Char
 * 	Short
 * 	Int
 * 	Long
 * 	Float
 * 	Double
 * 	Unsigned Char
 * 	Unsigned Short
 * 	Unsigned Int
 */
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
47
class XdmfArray : public XdmfItem {
48

Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
49
50
51
public:

	XdmfNewMacro(XdmfArray);
52
	LOKI_DEFINE_VISITABLE(XdmfArray, XdmfItem)
53
	friend class XdmfHDF5Writer;
54
	static std::string ItemTag;
55

56
	/**
57
	 * Copy values from an XdmfArray into this array.
58
	 *
59
60
	 * @param startIndex the index in this array to begin insertion.
	 * @param values a shared pointer to an XdmfArray to copy into this array.
61
	 * @param valuesStartIndex the index in the XdmfArray to begin copying.
62
63
64
	 * @param numValues the number of values to copy into this array.
	 * @param arrayStride number of values to stride in this array between each copy.
	 * @param valuesStride number of values to stride in the XdmfArray between each copy.
65
	 */
66
	void copyValues(const unsigned int startIndex, const boost::shared_ptr<const XdmfArray> values, const unsigned int valuesStartIndex= 0, const unsigned int numValues = 1, const unsigned int arrayStride = 1, const unsigned int valuesStride = 1);
67
68
69
70

	/**
	 * Copy values from an array into this array.
	 *
71
72
	 * @param startIndex the index in this XdmfArray to begin insertion.
	 * @param valuesPointer a pointer to the values to copy into this XdmfArray.
73
	 * @param numValues the number of values to copy into this array.
74
	 * @param arrayStride number of values to stride in this XdmfArray between each copy.
75
76
	 * @param valuesStride number of values to stride in the pointer between each copy.
	 */
77
	template<typename T>
78
	void copyValues(const unsigned int startIndex, const T * const valuesPointer, const unsigned int numValues = 1, const unsigned int arrayStride = 1, const unsigned int valuesStride = 1);
79
80

	/**
81
	 * Remove all values from this array
82
	 */
83
	void clear();
84

85
86
	/**
	 * Get the capacity of this array (the number of values this array can store without reallocation).
87
88
	 *
	 * @return the capacity of this array.
89
90
91
	 */
	unsigned int getCapacity() const;

92
93
	std::map<std::string, std::string> getItemProperties() const;

94
95
	std::string getItemTag() const;

96
97
98
99
100
101
102
103
104
105
106
107
	/**
	 * Get the hdf5 controller attached to this XdmfArray.
	 *
	 * @return the hdf5 controller attached to this XdmfArray.
	 */
	boost::shared_ptr<XdmfHDF5Controller> getHDF5Controller();

	/**
	 * Get the hdf5 controller attached to this XdmfArray (const version).
	 *
	 * @return the hdf5 controller attached to this XdmfArray.
	 */
108
	boost::shared_ptr<const XdmfHDF5Controller> getHDF5Controller() const;
109

Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
110
111
112
	/**
	 * Get the precision, in bytes, of the data type of this array.
	 *
113
	 * @return the precision, in bytes, of the data type of this array.
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
114
	 */
115
	unsigned int getPrecision() const;
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
116
117
118
119

	/**
	 * Get the number of values stored in this array.
	 *
120
	 * @return the number of values stored in this array.
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
121
	 */
122
	unsigned int getSize() const;
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
123

124
	/**
125
126
127
128
129
	 * Get the data type of this array.
	 *
	 * @return a string containing the Xdmf data type for the array, this is one of
	 *      Char, Short, Int, Float, UChar, UShort, UInt.
	 */
130
	std::string getType() const;
131

Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
132
	/**
133
	 * Get a smart pointer to the values stored in this array.
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
134
	 *
135
	 * @return a smart pointer to the internal vector of values stored in this array.
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
136
	 */
137
	template <typename T>
138
	boost::shared_ptr<std::vector<T> > getValues();
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
139

140
141
142
143
144
145
146
147
148
149
150
151
	/**
	 * Get a copy of the values stored in this array
	 *
	 * @param startIndex the index in this XdmfArray to begin copying from.
	 * @param valuesPointer a pointer to an array to copy into.
	 * @param numValues the number of values to copy.
	 * @param arrayStride number of values to stride in this XdmfArray between each copy.
	 * @param valuesStride number of values to stride in the pointer between each copy.
	 */
	template <typename T>
	void getValuesCopy(const unsigned int startIndex, T * valuesPointer, const unsigned int numValues = 1, const unsigned int arrayStride = 1, const unsigned int valuesStride = 1) const;

Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
152
	/**
153
	 * Get a smart pointer to the values stored in this array (const version).
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
154
	 *
155
	 * @return a smart pointer to the internal vector of values stored in this array.
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
156
	 */
157
158
	//template <typename T>
	//const boost::shared_ptr<const std::vector<T> > getValues() const;
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
159
160

	/**
161
	 * Get a pointer to the values stored in this array (const version).
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
162
163
164
	 *
	 * @return a void pointer to the first value stored in this array.
	 */
165
	const void * const getValuesPointer() const;
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
166

167
168
169
170
171
	/**
	 * Get the values stored in this array as a string.
	 *
	 * @return a string containing the contents of the array.
	 */
172
	std::string getValuesString() const;
173

174
175
	/**
	 * Initializes the array to contain an empty container of a particular type.
176
177
	 *
	 * @return a smart pointer to the internal vector of values initialized in this array.
178
179
	 */
	template <typename T>
180
	boost::shared_ptr<std::vector<T> > initialize();
181

182
183
184
185
186
	/**
	 * Returns whether the array is initialized (contains values in memory).
	 */
	bool isInitialized();

187
188
189
190
191
192
	/**
	 * Copy a value to the back of this array
	 */
	template <typename T>
	void pushBack(T & value);

193
194
195
196
197
	/**
	 * Read data from disk into memory.
	 */
	void read();

198
	/**
199
	 * Release all data from currently held in memory.
200
	 */
201
	void release();
202

203
204
205
206
207
208
209
	/**
	 * Set the capacity of the XdmfArray to at least size.
	 *
	 * @param size the capacity to set this XdmfArray to.
	 */
	void reserve(const unsigned int size);

210
	/**
211
	 * Resizes the XdmfArray to contain numValues.  If numValues is larger than the current size, append values to the end equal
212
213
214
	 * to val.  If numValues is less than the current size, values at indices larger than numValues are removed.
	 *
	 * @param numValues the number of values to resize this array to.
215
	 * @param value the number to initialize newly created values to, if needed.
216
217
	 */
	template<typename T>
218
	void resize(const unsigned int numValues, const T & value = 0);
219

220
221
222
223
224
225
226
	/**
	 * Attach an hdf5 controller to this XdmfArray.
	 *
	 * @param hdf5Controller the hdf5 controller to attach to this XdmfArray.
	 */
	void setHDF5Controller(boost::shared_ptr<XdmfHDF5Controller> hdf5Controller);

227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
	/**
	 * Sets the values of this array to the values stored in the arrayPointer array.  No copy is made.  Modifications to the array are
	 * not permitted through the XdmfArray API.  Any calls through the XdmfArray API to modify the array (i.e. any non-const function)
	 * will result in the array being copied into internal storage.  The internal copy is then modified.
	 * This prevents situations where a realloc of the pointer could cause other references to become invalid.
	 * The caller of this method can continue to modify the values stored in arrayPointer on its own.
	 * This function is meant for applications that have their own array data structures that merely use Xdmf to output the data,
	 * an operation that should not require a copy.  Other applications that use Xdmf for in memory data storage should avoid
	 * this function.
	 *
	 * @param arrayPointer a pointer to an array to store in this XdmfArray.
	 * @param numValues the number of values in the array.
	 * @param transferOwnership whether to transfer responsibility for deletion of the array to XdmfArray.
	 */
	template<typename T>
242
	void setValues(const T * const arrayPointer, const unsigned int numValues, const bool transferOwnership = 0);
243

244
245
246
247
248
	/**
	 * Sets the values of this array to the values stored in the vector.  No copy is made.  The caller of this method retains
	 * ownership of the data and must ensure that the array is still valid for the entire time Xdmf needs it.
	 *
	 * @param array a vector to store in this array.
249
	 * @param transferOwnership whether to transfer responsibility for deletion of the array to XdmfArray.
250
251
	 */
	template<typename T>
252
	void setValues(std::vector<T> & array, const bool transferOwnership = 0);
253

Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
254
	/**
255
256
	 * Sets the values of this array to the values stored in the vector.  No copy is made.  This array shares ownership with
	 * other references to the smart pointer.
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
257
	 *
258
	 * @param array a smart pointer to a vector to store in this array.
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
259
	 */
260
261
	template<typename T>
	void setValues(boost::shared_ptr<std::vector<T> > array);
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
262

263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
	/**
	 * Exchange the contents of the vector with the contents of this XdmfArray.  No copy is made.  The internal arrays are swapped.
	 *
	 * @param array a vector to exchange values with.
	 * @return bool whether the swap was successful.
	 */
	template<typename T>
	bool swap(std::vector<T> & array);

	/**
	 * Exchange the contents of the vector with the contents of this XdmfArray.  No copy is made.  The internal arrays are swapped.
	 *
	 * @param array a smart pointer to a vector to exchange values with.
	 */
	template<typename T>
	bool swap(boost::shared_ptr<std::vector<T> > array);

	/**
	 * Exchange the contents of an XdmfArray with the contents of this XdmfArray.  No copy is made.  The internal arrays are swapped.
	 *
	 * @param array a smart pointer to a vector to exchange values with.
	 * @return bool whether the swap was successful.
	 */
286
	void swap(boost::shared_ptr<XdmfArray> array);
287

Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
288
289
290
291
protected:

	XdmfArray();
	virtual ~XdmfArray();
292
	virtual void populateItem(const std::map<std::string, std::string> & itemProperties, std::vector<boost::shared_ptr<XdmfItem> > & childItems);
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
293
294
295

private:

296
297
298
	XdmfArray(const XdmfArray & array);  // Not implemented.
	void operator=(const XdmfArray & array);  // Not implemented.

299
300
301
302
	// Variant Visitor Operations
	class Clear;
	class CopyArrayValues;

303
	template <typename T>
304
305
	class CopyValues;

306
	class GetCapacity;
307
308
309
310
	class GetHDF5Type;
	class GetPrecision;
	class GetSize;
	class GetType;
311

312
	template <typename T>
313
314
	class GetValuesCopy;

315
316
	class GetValuesPointer;
	class GetValuesString;
317
	class InternalizeArrayPointer;
318
	class NewArray;
319
320
321
322

	template <typename T>
	class PushBack;

323
	class Reserve;
324

325
	template <typename T>
326
327
	class Resize;

328
329
	struct NullDeleter;

330
331
	void initialize(const std::string & type, const unsigned int precision);

332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
	/**
	 * After setValues(const T * const array) is called, XdmfArray stores a pointer that is not allowed to be modified through
	 * the XdmfArray API.  If the user desires to modify the contents of the pointer, they must do so without calling any
	 * non-const functions of XdmfArray.  If they do call non-const functions of XdmfArray, we try to accommodate by copying
	 * the array pointer into internal data structures.
	 */
	void internalizeArrayPointer();

	/**
	 * Release references to internal data.
	 */
	void releaseArray();

	/**
	 * Release references to held array pointer internal data;
	 */
	void releaseArrayPointer();

350
351
352
353
354
355
356
357
358
359
360
	typedef boost::variant<
		boost::shared_ptr<std::vector<char> >,
		boost::shared_ptr<std::vector<short> >,
		boost::shared_ptr<std::vector<int> >,
		boost::shared_ptr<std::vector<long> >,
		boost::shared_ptr<std::vector<float> >,
		boost::shared_ptr<std::vector<double> >,
		boost::shared_ptr<std::vector<unsigned char> >,
		boost::shared_ptr<std::vector<unsigned short> >,
		boost::shared_ptr<std::vector<unsigned int> > > ArrayVariant;

361
362
363
364
365
366
367
368
369
370
	typedef boost::variant<
		boost::shared_array<const char>,
		boost::shared_array<const short>,
		boost::shared_array<const int>,
		boost::shared_array<const long>,
		boost::shared_array<const float>,
		boost::shared_array<const double>,
		boost::shared_array<const unsigned char>,
		boost::shared_array<const unsigned short>,
		boost::shared_array<const unsigned int> > ArrayPointerVariant;
371

372
	ArrayVariant mArray;
373
	ArrayPointerVariant mArrayPointer;
374
	unsigned int mArrayPointerNumValues;
375
376
	bool mHaveArray;
	bool mHaveArrayPointer;
377
	boost::shared_ptr<XdmfHDF5Controller> mHDF5Controller;
378
	unsigned int mTmpReserveSize;
Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
379
380
};

381
382
#include "XdmfArray.tpp"

Ken Leiter (Civ ARL/CISD) kleiter's avatar
ENH:  
Ken Leiter (Civ ARL/CISD) kleiter committed
383
#endif /* XDMFARRAY_HPP_ */