/[escript]/trunk/escript/src/DataAbstract.h
ViewVC logotype

Contents of /trunk/escript/src/DataAbstract.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 775 - (show annotations)
Mon Jul 10 04:00:08 2006 UTC (13 years, 4 months ago) by ksteube
File MIME type: text/plain
File size: 11923 byte(s)
Modified the following python methods in escript/py_src/util.py to
call faster C++ methods:
	escript_trace
	escript_transpose
	escript_symmetric
	escript_nonsymmetric

1 // $Id$
2 /*
3 ************************************************************
4 * Copyright 2006 by ACcESS MNRF *
5 * *
6 * http://www.access.edu.au *
7 * Primary Business: Queensland, Australia *
8 * Licensed under the Open Software License version 3.0 *
9 * http://www.opensource.org/licenses/osl-3.0.php *
10 * *
11 ************************************************************
12
13 */
14
15 #if !defined escript_DataAbstract_20040315_H
16 #define escript_DataAbstract_20040315_H
17 #include "system_dep.h"
18
19 #include "DataArrayView.h"
20 #include "DataArray.h"
21 #include "FunctionSpace.h"
22
23 #include <boost/scoped_ptr.hpp>
24 #include <boost/python/numeric.hpp>
25
26 #include <string>
27 #include <fstream>
28
29 namespace escript {
30
31 /**
32 \brief
33 DataAbstract provides an abstract interface for the class of containers
34 which hold ESyS data.
35
36 Description:
37 DataAbstract provides an abstract interface for the class of containers
38 which hold ESyS data. The container may be thought of as a 2 dimensional
39 array of data points where one dimension corresponds to the number of samples
40 and the other to the number of data points per sample as defined by the function
41 space associated with each Data object. The data points themselves are arrays of
42 doubles of rank 0-4.
43 */
44
45 class DataAbstract {
46
47 public:
48
49 typedef DataArrayView::ValueType ValueType;
50 typedef DataArrayView::ShapeType ShapeType;
51
52 /**
53 \brief
54 Constructor for DataAbstract.
55
56 Description:
57 Constructor for DataAbstract.
58
59 \param what - Input - A description of what this data represents.
60 */
61 ESCRIPT_DLL_API
62 DataAbstract(const FunctionSpace& what);
63
64 /**
65 \brief
66 Destructor for DataAbstract.
67 */
68 ESCRIPT_DLL_API
69 virtual
70 ~DataAbstract();
71
72 /**
73 \brief
74 Write the data as a string.
75 */
76 ESCRIPT_DLL_API
77 virtual
78 std::string
79 toString() const = 0;
80
81 /**
82 \brief
83 Return the number of data points per sample.
84 */
85 ESCRIPT_DLL_API
86 int
87 getNumDPPSample() const;
88
89 /**
90 \brief
91 Return the number of samples.
92 */
93 ESCRIPT_DLL_API
94 int
95 getNumSamples() const;
96
97 /**
98 \brief
99 Return the DataArrayView of the point data. This essentially contains
100 the shape information for each data point although it also may be used
101 to manipulate the point data.
102 */
103 ESCRIPT_DLL_API
104 DataArrayView&
105 getPointDataView();
106
107 ESCRIPT_DLL_API
108 const DataArrayView&
109 getPointDataView() const;
110
111 /**
112 \brief
113 Return the offset for the given sample. This returns the offset for the given
114 point into the container holding the point data. Only really necessary to
115 avoid creating many DataArrayView objects.
116
117 \param sampleNo - Input - sample number.
118 \param dataPointNo - Input - data point number.
119 */
120 ESCRIPT_DLL_API
121 virtual
122 ValueType::size_type
123 getPointOffset(int sampleNo,
124 int dataPointNo) const = 0;
125
126 /**
127 \brief
128 Return the sample data for the given sample number.
129 */
130 ESCRIPT_DLL_API
131 double*
132 getSampleData(ValueType::size_type sampleNo);
133
134 /**
135 \brief
136 Return the number of doubles stored for this Data object.
137 */
138 ESCRIPT_DLL_API
139 virtual
140 ValueType::size_type
141 getLength() const = 0;
142
143 /**
144 \brief
145 Return the sample data for the given tag key.
146 NB: If the data isn't tagged an exception will be thrown.
147 */
148 ESCRIPT_DLL_API
149 virtual
150 double*
151 getSampleDataByTag(int tag);
152
153 /**
154 \brief
155 Assign the given value to the data-points(s) referenced by the given
156 reference number.
157
158 If this Data object cannot be accessed by reference numbers an
159 exception will be thrown.
160
161 \param ref - Input - reference number.
162 \param value - Input - value to assign to data-points associated with
163 the given reference number.
164 */
165 ESCRIPT_DLL_API
166 virtual
167 void
168 setRefValue(int ref,
169 const DataArray& value);
170
171 /**
172 \brief
173 Return the values associated with the data-point(s) referenced by the given
174 reference number.
175
176 If this Data object cannot be accessed by reference numbers an
177 exception will be thrown.
178
179 \param ref - Input - reference number.
180 \param value - Output - object to receive data-points associated with
181 the given reference number.
182 */
183 ESCRIPT_DLL_API
184 virtual
185 void
186 getRefValue(int ref,
187 DataArray& value);
188
189 /**
190 \brief
191 Check this and the given RHS operands are compatible. Throws
192 an exception if they aren't.
193
194 \param right - Input - The right hand side.
195 */
196 ESCRIPT_DLL_API
197 void
198 operandCheck(const DataAbstract& right) const;
199
200 /**
201 \brief
202 Return true if a valid sample point number.
203 */
204 ESCRIPT_DLL_API
205 bool
206 validSamplePointNo(int samplePointNo) const;
207
208 /**
209 \brief
210 Return true if a valid sample number.
211 */
212 ESCRIPT_DLL_API
213 bool
214 validSampleNo(int sampleNo) const;
215
216 /**
217 \brief
218 Return a view into the data for the data point specified.
219 NOTE: Construction of the DataArrayView is a relatively expensive
220 operation.
221
222 \param sampleNo - Input - the sample number.
223 \param dataPointNo - Input - the data point number.
224 */
225 ESCRIPT_DLL_API
226 virtual
227 DataArrayView
228 getDataPoint(int sampleNo,
229 int dataPointNo) = 0;
230
231 /**
232 \brief
233 Return the function space associated with this Data object.
234 */
235 ESCRIPT_DLL_API
236 const
237 FunctionSpace&
238 getFunctionSpace() const;
239
240 /**
241 \brief
242 Return the given slice from this object.
243
244 NB: The caller is responsible for managing the object created.
245 */
246 ESCRIPT_DLL_API
247 virtual
248 DataAbstract*
249 getSlice(const DataArrayView::RegionType& region) const = 0;
250
251 /**
252 \brief
253 Copy the specified region from the given object.
254
255 \param value - Input - Data to copy from
256 \param region - Input - Region to copy.
257 */
258 ESCRIPT_DLL_API
259 virtual
260 void
261 setSlice(const DataAbstract* value,
262 const DataArrayView::RegionType& region) = 0;
263
264 /**
265 \brief
266 Reshape the data points if they are currently rank 0.
267 Will throw an exception if the data points are not rank 0.
268 The original data point value is used for all values of the new
269 data point.
270 */
271 ESCRIPT_DLL_API
272 virtual
273 void
274 reshapeDataPoint(const ShapeType& shape) = 0;
275
276 /**
277 \brief
278 setTaggedValue
279
280 Description:
281 Assign the given value to the given tag.
282
283 NB: If the data isn't tagged an exception will be thrown.
284
285 \param tagKey - Input - Integer key.
286 \param value - Input - Single DataArrayView value to be assigned to the tag.
287 */
288 ESCRIPT_DLL_API
289 virtual
290 void
291 setTaggedValue(int tagKey,
292 const DataArrayView& value);
293
294 /**
295 \brief
296 Archive the underlying data values to the file referenced
297 by ofstream. A count of the number of values expected to be written
298 is provided as a cross-check.
299
300 The return value indicates success (0) or otherwise (1).
301 */
302 ESCRIPT_DLL_API
303 virtual
304 int
305 archiveData(std::ofstream& archiveFile,
306 const ValueType::size_type noValues) const;
307
308 /**
309 \brief
310 Extract the number of values specified by noValues from the file
311 referenced by ifstream to the underlying data structure.
312
313 The return value indicates success (0) or otherwise (1).
314 */
315 ESCRIPT_DLL_API
316 virtual
317 int
318 extractData(std::ifstream& archiveFile,
319 const ValueType::size_type noValues);
320
321 /**
322 \brief
323 Copy the numarray object to the data points in this object.
324
325 Description:
326 Copy the numarray object to the data points in this object.
327
328 \param value Input - new values for the data points
329 */
330 ESCRIPT_DLL_API
331 virtual void
332 copyAll(const boost::python::numeric::array& value);
333
334 /**
335 \brief
336 Return the tag number associated with the given data-point number.
337
338 If the object cannot be referenced by tag numbers, an exception
339 will be thrown.
340 */
341 ESCRIPT_DLL_API
342 virtual
343 int
344 getTagNumber(int dpno);
345
346 /**
347 \brief
348 Computes a symmetric matrix (A + AT) / 2
349
350 \param ev - Output - a symmetric matrix
351
352 */
353 virtual void
354 symmetric(DataAbstract* ev);
355
356 /**
357 \brief
358 Computes a nonsymmetric matrix (A - AT) / 2
359
360 \param ev - Output - a nonsymmetric matrix
361
362 */
363 virtual void
364 nonsymmetric(DataAbstract* ev);
365
366 /**
367 \brief
368 Computes the trace of a matrix
369
370 \param ev - Output - the trace of a matrix
371
372 */
373 virtual void
374 matrixtrace(DataAbstract* ev, int axis_offset);
375
376 /**
377 \brief
378 Transpose each data point of this Data object around the given axis.
379
380 \param ev - Output - the transpose of a matrix
381
382 */
383 virtual void
384 transpose(DataAbstract* ev, int axis_offset);
385
386 /**
387 \brief
388 solves the eigenvalue problem this*V=ev*V for the eigenvalues ev
389
390 \param ev - Output - eigenvalues in increasing order at each data point
391
392 */
393 ESCRIPT_DLL_API
394 virtual void
395 eigenvalues(DataAbstract* ev);
396
397 /**
398 \brief
399 solves the eigenvalue problem this*V=ev*V for the eigenvalues ev and eigenvectors V
400
401 \param ev - Output - eigenvalues in increasing order at each data point
402 \param V - Output - corresponding eigenvectors. They are normalized such that their length is one
403 and the first nonzero component is positive.
404 \param tol - Input - eigenvalue with relative distance tol are treated as equal.
405
406 */
407
408 ESCRIPT_DLL_API
409 virtual void
410 eigenvalues_and_eigenvectors(DataAbstract* ev,DataAbstract* V,const double tol=1.e-13);
411
412 protected:
413
414 /**
415 \brief
416 Set the pointDataView DataArrayView associated with this object.
417
418 \param input - Input - The point data view. DataAbstract takes ownership
419 of the DataArrayView provided. It will delete it when it is destructed.
420 */
421 ESCRIPT_DLL_API
422 void
423 setPointDataView(const DataArrayView& input);
424
425 ESCRIPT_DLL_API
426 void
427 resetPointDataView();
428
429 private:
430
431 //
432 // The number of samples in this Data object.
433 // This is derived directly from the FunctionSpace.
434 int m_noSamples;
435
436 //
437 // The number of data points per sample in this Data object.
438 // This is derived directly from the FunctionSpace.
439 int m_noDataPointsPerSample;
440
441 //
442 // The DataArrayView of the data array associated with this object.
443 // The data array is defined only in child classes of this class, it
444 // is not defined in this abstract parent class.
445 boost::scoped_ptr<DataArrayView> m_pointDataView;
446
447 //
448 // A FunctionSpace which provides a description of the data associated
449 // with this Data object.
450 FunctionSpace m_functionSpace;
451
452 };
453
454 inline
455 bool
456 DataAbstract::validSamplePointNo(int samplePointNo) const
457 {
458 return ((0 <= samplePointNo) && (samplePointNo < m_noDataPointsPerSample));
459 }
460
461 inline
462 bool
463 DataAbstract::validSampleNo(int sampleNo) const
464 {
465 return ((0 <= sampleNo) && (sampleNo < m_noSamples));
466 }
467
468 inline
469 DataAbstract::ValueType::value_type*
470 DataAbstract::getSampleData(ValueType::size_type sampleNo)
471 {
472 return &(m_pointDataView->getData(getPointOffset(sampleNo,0)));
473 }
474
475 inline
476 int
477 DataAbstract::getNumDPPSample() const
478 {
479 return m_noDataPointsPerSample;
480 }
481
482 inline
483 int
484 DataAbstract::getNumSamples() const
485 {
486 return m_noSamples;
487 }
488
489 inline
490 const
491 FunctionSpace&
492 DataAbstract::getFunctionSpace() const
493 {
494 return m_functionSpace;
495 }
496
497 inline
498 const
499 DataArrayView&
500 DataAbstract::getPointDataView() const
501 {
502 return *(m_pointDataView.get());
503 }
504
505 inline
506 DataArrayView&
507 DataAbstract::getPointDataView()
508 {
509 return *(m_pointDataView.get());
510 }
511 } // end of namespace
512
513 #endif

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26