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

Diff of /trunk/escript/src/DataTagged.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 580 by gross, Wed Mar 8 05:45:51 2006 UTC revision 2548 by jfenwick, Mon Jul 20 06:20:06 2009 UTC
# Line 1  Line 1 
 // $Id$  
1    
2  /*  /*******************************************************
3   ******************************************************************************  *
4   *                                                                            *  * Copyright (c) 2003-2009 by University of Queensland
5   *       COPYRIGHT  ACcESS 2004 -  All Rights Reserved                        *  * Earth Systems Science Computational Center (ESSCC)
6   *                                                                            *  * http://www.uq.edu.au/esscc
7   * This software is the property of ACcESS. No part of this code              *  *
8   * may be copied in any form or by any means without the expressed written    *  * Primary Business: Queensland, Australia
9   * consent of ACcESS.  Copying, use or modification of this software          *  * Licensed under the Open Software License version 3.0
10   * by any unauthorised person is illegal unless that person has a software    *  * http://www.opensource.org/licenses/osl-3.0.php
11   * license agreement with ACcESS.                                             *  *
12   *                                                                            *  *******************************************************/
13   ******************************************************************************  
 */  
14    
15  #if !defined escript_DataTagged_20040615_H  #if !defined escript_DataTagged_20040615_H
16  #define escript_DataTagged_20040615_H  #define escript_DataTagged_20040615_H
17    #include "system_dep.h"
18    
19  #include "DataAbstract.h"  #include "DataReady.h"
20  #include "DataArrayView.h"  #include "DataTypes.h"
21    
22  #include <vector>  #include <vector>
23  #include <map>  #include <map>
# Line 38  class DataConstant; Line 37  class DataConstant;
37     dataPointNo values.     dataPointNo values.
38  */  */
39    
40  class DataTagged : public DataAbstract {  class DataTagged : public DataReady {
41    typedef DataReady parent;
42   public:   public:
43    
44    //    //
45    // Types for the lists of tags and values.    // Types for the lists of tags and values.
46    typedef std::vector<int>           TagListType;    typedef std::vector<int>           TagListType;
47    typedef std::vector<DataArrayView> ValueListType;  //  typedef std::vector<DataArrayView> ValueListType;
48    typedef DataArrayView::ValueType   ValueType;    typedef DataTypes::ValueType   ValueType;
49      typedef std::vector<ValueType::ElementType> ValueBatchType;
50    
51    //    //
52    // Map from a tag to an offset into the data array.    // Map from a tag to an offset into the data array.
# Line 62  class DataTagged : public DataAbstract { Line 62  class DataTagged : public DataAbstract {
62       tag values are stored.       tag values are stored.
63      T      T
64    */    */
65      ESCRIPT_DLL_API
66    DataTagged();    DataTagged();
67    
68    /**    /**
69       \brief       \brief
70       Constructor for DataTagged.       Alternative Constructor for DataTagged.
71    
72       Description:       Description:
73       Constructor for DataTagged.       Alternative Constructor for DataTagged.
74       \param tagKeys - Input - A vector of integer tags.       \param what - Input - A description of what this data object represents.
75       \param values - Input - A vector of DataArrayViews. If this is empty       \param shape - Input - The shape of each data-point.
76                       all tag values will be assigned a scalar data-point of value       \param tags - Input - An array of tags, one for each sample number (starts at tag[1]).
77                       0. If it contains one value all tag values will be assigned       \param data - The data values for each tag.
78               this value. Otherwise consecutive tags will be assigned      NB: no unit testing yet
                      consecutive values.  If there is a mismatch between  the  
              number of keys and the number of values an exception  
              will be generated.  
      \param defaultValue - Input - Value returned if a requested tag doesn't exist.  
      \param what - Input - A description of what this data represents.  
     T  
79    */    */
80    DataTagged(const TagListType& tagKeys,    ESCRIPT_DLL_API
81               const ValueListType& values,    DataTagged(const FunctionSpace& what,
82           const DataArrayView& defaultValue,               const DataTypes::ShapeType &shape,
83           const FunctionSpace& what);               const int tags[],
84                 const ValueType& data);
85    
86    /**   /**
87       \brief       \brief
88       Alternative Constructor for DataTagged.       Alternative Constructor for DataTagged.
89    
# Line 95  class DataTagged : public DataAbstract { Line 91  class DataTagged : public DataAbstract {
91       Alternative Constructor for DataTagged.       Alternative Constructor for DataTagged.
92       \param what - Input - A description of what this data object represents.       \param what - Input - A description of what this data object represents.
93       \param shape - Input - The shape of each data-point.       \param shape - Input - The shape of each data-point.
94       \param tags - Input - An array of tags, one for each sample number.       \param tags - Input - An vector of tags, one for each sample number.
95       \param data - The data values for each tag.       \param data - The data values for each tag.
96      NB: no unit testing yet  TODO Make sure to document the relationship between tags and data, ie: data also contains the default value
97    */   */
98      ESCRIPT_DLL_API
99    DataTagged(const FunctionSpace& what,    DataTagged(const FunctionSpace& what,
100               const DataArrayView::ShapeType &shape,               const DataTypes::ShapeType &shape,
101               const int tags[],               const TagListType& tags,
102               const ValueType& data);               const ValueType& data);
103    
104    /**    /**
# Line 110  class DataTagged : public DataAbstract { Line 107  class DataTagged : public DataAbstract {
107       Performs a deep copy from the given DataTagged object.       Performs a deep copy from the given DataTagged object.
108      T      T
109    */    */
110      ESCRIPT_DLL_API
111    DataTagged(const DataTagged& other);    DataTagged(const DataTagged& other);
112    
113    /**    /**
# Line 119  class DataTagged : public DataAbstract { Line 117  class DataTagged : public DataAbstract {
117       The default value will be the value of the DataConstant object.       The default value will be the value of the DataConstant object.
118      T      T
119    */    */
120      ESCRIPT_DLL_API
121    DataTagged(const DataConstant& other);    DataTagged(const DataConstant& other);
122    
123    /**    /**
124       \brief       \brief
125         Copies the tags from a DataTagged into a new Data Tagged and assigns them the default value. ** Not unit tested **
126    
127         This is different from a deep copy because we are not copying shape or other information, just tags.
128         \param what - Input - FunctionSpace for the new DataTagged
129         \param shape - Input - Shape for points in the new DataTagged
130         \param defaultvalue - Input - Default value for new DataTagged
131         \param tagsource - Input - A DataTagged object which supplies the tags.
132      */
133      ESCRIPT_DLL_API
134      DataTagged(const FunctionSpace& what,
135                 const DataTypes::ShapeType& shape,
136             const DataTypes::ValueType& defaultvalue,
137                 const DataTagged* tagsource=0);
138    
139      /**
140         \brief
141         Destructor
142      */
143      ESCRIPT_DLL_API
144      inline virtual
145      ~DataTagged() {};
146    
147      ESCRIPT_DLL_API
148      bool
149      isTagged() const
150      {
151        return true;
152      };
153    
154    
155      /**
156         \brief Return a deep copy of the current object.
157      */
158      ESCRIPT_DLL_API
159      virtual
160      DataAbstract*
161      deepCopy();
162    
163    
164      /**
165         \brief
166       getSampleDataByTag       getSampleDataByTag
167    
168       Description:       Description:
# Line 133  class DataTagged : public DataAbstract { Line 173  class DataTagged : public DataAbstract {
173       ** NB: need to do array bounds checking when accessing returned value!       ** NB: need to do array bounds checking when accessing returned value!
174      T      T
175    */    */
176      ESCRIPT_DLL_API
177    virtual    virtual
178    double*    double*
179    getSampleDataByTag(int tag);    getSampleDataByTag(int tag);
# Line 144  class DataTagged : public DataAbstract { Line 185  class DataTagged : public DataAbstract {
185       associated with each tag.       associated with each tag.
186      T      T
187    */    */
188      ESCRIPT_DLL_API
189    virtual    virtual
190    std::string    std::string
191    toString() const;    toString() const;
192     /**
193         \brief
194         dumps the object into a netCDF file
195      */
196      ESCRIPT_DLL_API
197      virtual
198      void
199      dump(const std::string fileName) const;
200    
201     /**
202         \brief
203        sets all values to zero
204      */
205      ESCRIPT_DLL_API
206      virtual
207      void
208      setToZero();
209    
210    /**    /**
211       \brief       \brief
# Line 154  class DataTagged : public DataAbstract { Line 213  class DataTagged : public DataAbstract {
213       according to the associated function space.       according to the associated function space.
214      T      T
215    */    */
216      ESCRIPT_DLL_API
217    virtual    virtual
218    int    int
219    getTagNumber(int dpno);    getTagNumber(int dpno);
# Line 170  class DataTagged : public DataAbstract { Line 230  class DataTagged : public DataAbstract {
230       \param dataPointNo - Input - data-point number.       \param dataPointNo - Input - data-point number.
231      T      T
232    */    */
233      ESCRIPT_DLL_API
234    virtual    virtual
235    ValueType::size_type    ValueType::size_type
236    getPointOffset(int sampleNo,    getPointOffset(int sampleNo,
237                   int dataPointNo) const;                   int dataPointNo) const;
238    
239    /**    ESCRIPT_DLL_API
240      virtual
241      ValueType::size_type
242      getPointOffset(int sampleNo,
243                     int dataPointNo);
244    
245     /**
246       \brief       \brief
247       addTaggedValues       addTaggedValues
248    
249       Description:       Description:
250       Add the given tags and values to this DataTagged object.       Add the given tags and values to this DataTagged object.
251       \param tagKeys - Input - A vector of integer tags.       \param tagKeys - Input - A vector of integer tags.
252       \param values - Input - A vector of DataArrayViews. If this is empty       \param values - Input - A vector of doubles. If this is empty, the default value for
253                       all tag values will be assigned a scalar data-point of value                       this DataTagged will be used for all tags.
254                       0. If it contains one value all tag values will be assigned                       If it contains one value all tag values will be assigned
255               this value. Otherwise consecutive tags will be assigned               this value. Otherwise consecutive tags will be assigned
256                       consecutive values.  If there is a mismatch between  the                       consecutive values.  If there is a mismatch between  the
257               number of keys and the number of values an exception               number of keys and the number of values an exception
258               will be generated.               will be generated.
259         \param vShape - shape of the datapoints in "values"
260      T      T
261     */
262      ESCRIPT_DLL_API
263      void
264      addTaggedValues(const TagListType& tagKeys,
265                                const ValueBatchType& values,
266                                const ShapeType& vShape);
267    
268    
269      /**
270       Description:
271       Add the given tags and values to this DataTagged object.
272       \param tagKeys - Input - A vector of integer tags.
273       \param values - Input - A DataVector containing the datapoints.
274                 If this is empty, the default value for
275                         this DataTagged will be used for all tags.
276                         If it contains one value all tag values will be assigned
277                 this value. Otherwise consecutive tags will be assigned
278                         consecutive values.  If there is a mismatch between  the
279                 number of keys and the number of values an exception
280                 will be generated.
281        \param vShape - shape of the datapoints in "values"
282    
283       TODO Makesure this is properly unit tested
284    */    */
285      ESCRIPT_DLL_API
286    void    void
287    addTaggedValues(const TagListType& tagKeys,    addTaggedValues(const TagListType& tagKeys,
288                    const ValueListType& values);                                const ValueType& values,
289                                const ShapeType& vShape);
290    
291    
292    
293    
294    /**    /**
295       \brief       \brief
# Line 203  class DataTagged : public DataAbstract { Line 299  class DataTagged : public DataAbstract {
299       Add a single tag and value to this DataTagged object. If this tag already has       Add a single tag and value to this DataTagged object. If this tag already has
300       a value associated with it, setTaggedValue will be used to update this value.       a value associated with it, setTaggedValue will be used to update this value.
301       \param tagKey - Input - Integer tag.       \param tagKey - Input - Integer tag.
302       \param value - Input - Single DataArrayView value to be assigned to the tag.       \param pointshape - Shape of the value parameter
303      T       \param value - Input - Single DataArrayView value to be assigned to the tag.
304         \param dataOffset - Input - Offset of the beginning of the point in the value parameter
305    */    */
306      ESCRIPT_DLL_API
307    void    void
308    addTaggedValue(int tagKey,    addTaggedValue(int tagKey,
309                   const DataArrayView& value);           const DataTypes::ShapeType& pointshape,
310                     const ValueType& value,
311             int dataOffset=0);
312    
313    /**    /**
314       \brief       \brief
315       setTaggedValues       addTag - does not modify the default value for this object. ** Not unit tested **
316    
317       Description:       Description:
318       Set the given tags to the given values in this DataTagged object.       Add a single tag. The default value for this DataTagged will be associated with the tag.
319       \param tagKeys - Input - A vector of integer tag.       If this tag already has a value associated with it, then no change will be made.
320       \param values - Input - A vector of DataArrayViews. If this is empty       \param tagKey - Input - Integer tag.
321                       all tag values will be assigned a scalar data-point of value      TODO: Make sure this is unit tested
                      0. If it contains one value all tag values will be assigned  
              this value. Otherwise consecutive tags will be assigned  
                      consecutive values.  If there is a mismatch between  the  
              number of keys and the number of values an exception  
              will be generated.  
     T  
322    */    */
323      ESCRIPT_DLL_API
324    void    void
325    setTaggedValues(const TagListType& tagKeys,    addTag(int tagKey);
                   const ValueListType& values);  
326    
327    /**    /**
328       \brief       \brief
# Line 237  class DataTagged : public DataAbstract { Line 331  class DataTagged : public DataAbstract {
331       Description:       Description:
332       Assign the given value to the given tag.       Assign the given value to the given tag.
333       \param tagKey - Input - Integer tag.       \param tagKey - Input - Integer tag.
334       \param value - Input - Single DataArrayView value to be assigned to the tag.       \param pointshape - the shape of the value parameter
335         \param value - Input - Vector storing the datapoint to be assigned to the tag.
336         \param dataOffset - beginning of the datapoint within "value".
337      T      T
338    */    */
339    virtual    ESCRIPT_DLL_API
340    void    void
341    setTaggedValue(int tagKey,    setTaggedValue(int tagKey,
342                   const DataArrayView& value);           const DataTypes::ShapeType& pointshape,
343                     const ValueType& value,
344             int dataOffset=0);
345    
346    /**    /**
347       \brief       \brief
348       getDataPointByTag       getDataByTag
349    
350       Description:       Return a pointer to the beginning of the datapoint with the specified tag.
351       Return data-point associated with the given tag as a DataArrayView.       TODO Eventually these should be inlined.
352       \param tag - Input - Integer key.       \param tag - Input - Integer key.
353      T       \param i - position in the underlying datastructure
354    */    */
355    DataArrayView  
356    getDataPointByTag(int tag) const;    ESCRIPT_DLL_API
357      DataTypes::ValueType::reference
358      getDataByTagRW(int tag, DataTypes::ValueType::size_type i);
359    
360      ESCRIPT_DLL_API
361      DataTypes::ValueType::const_reference
362      getDataByTagRO(int tag, DataTypes::ValueType::size_type i) const;
363    
364    
365    
366    /**    /**
367       \brief        \brief
368       getDataPoint        getOffsetForTag
369    
370       Description:        \param tag
371       Return the data-point specified by the given sample and data-point        \return the offset of the beginning of the datapoint corresponding to tag.
372       numbers as a DataArrayView.  
373       \param sampleNo - Input.        Note: If the tag is not valid, the offset of the default value is returned instead.
      \param dataPointNo - Input.  
     T  
374    */    */
375    virtual    ESCRIPT_DLL_API
376    DataArrayView    DataTypes::ValueType::size_type
377    getDataPoint(int sampleNo,    getOffsetForTag(int tag) const;
378                 int dataPointNo);  
379    
380      /**
381         \brief
382         Return a reference to the underlying DataVector.
383      */
384    
385      ESCRIPT_DLL_API
386      DataTypes::ValueType&
387      getVectorRW();
388    
389      ESCRIPT_DLL_API
390      const DataTypes::ValueType&
391      getVectorRO() const;
392    
393    
394    
395    /**    /**
396       \brief       \brief
# Line 281  class DataTagged : public DataAbstract { Line 400  class DataTagged : public DataAbstract {
400       Return a reference to the tag offset lookup table.       Return a reference to the tag offset lookup table.
401      T      T
402    */    */
403      ESCRIPT_DLL_API
404    const DataMapType&    const DataMapType&
405    getTagLookup() const;    getTagLookup() const;
406    
# Line 295  class DataTagged : public DataAbstract { Line 415  class DataTagged : public DataAbstract {
415       keys in the associated function space.       keys in the associated function space.
416      T      T
417    */    */
418      ESCRIPT_DLL_API
419    bool    bool
420    isCurrentTag(int tag) const;    isCurrentTag(int tag) const;
421    
# Line 305  class DataTagged : public DataAbstract { Line 426  class DataTagged : public DataAbstract {
426       Description:       Description:
427       Return the default value. This value is associated with any tag which       Return the default value. This value is associated with any tag which
428       is not explicitly recorded in this DataTagged object's tag map.       is not explicitly recorded in this DataTagged object's tag map.
429      T       \param i - position in the underlying datastructure
430    */    */
431    DataArrayView&    ESCRIPT_DLL_API
432    getDefaultValue();    DataTypes::ValueType::reference
433      getDefaultValueRW(DataTypes::ValueType::size_type i);
434    
435      ESCRIPT_DLL_API
436      DataTypes::ValueType::const_reference
437      getDefaultValueRO(DataTypes::ValueType::size_type i) const;
438    
439    
440    
441    
   const DataArrayView&  
   getDefaultValue() const;  
442    
443    /**    /**
444       \brief       \brief
# Line 321  class DataTagged : public DataAbstract { Line 448  class DataTagged : public DataAbstract {
448       Return the total number of doubles stored for this DataTagged object.       Return the total number of doubles stored for this DataTagged object.
449      T      T
450    */    */
451      ESCRIPT_DLL_API
452    virtual    virtual
453    ValueType::size_type    ValueType::size_type
454    getLength() const;    getLength() const;
# Line 335  class DataTagged : public DataAbstract { Line 463  class DataTagged : public DataAbstract {
463       The caller is reponsible for managing the returned object.       The caller is reponsible for managing the returned object.
464      T      T
465    */    */
466      ESCRIPT_DLL_API
467    virtual    virtual
468    DataAbstract*    DataAbstract*
469    getSlice(const DataArrayView::RegionType& region) const;    getSlice(const DataTypes::RegionType& region) const;
470    
471    /**    /**
472       \brief       \brief
# Line 350  class DataTagged : public DataAbstract { Line 479  class DataTagged : public DataAbstract {
479       \param region - Input - Region to slice.       \param region - Input - Region to slice.
480      T      T
481    */    */
482      ESCRIPT_DLL_API
483    DataTagged(const DataTagged& other,    DataTagged(const DataTagged& other,
484           const DataArrayView::RegionType& region);           const DataTypes::RegionType& region);
485    
486    /**    /**
487       \brief       \brief
# Line 363  class DataTagged : public DataAbstract { Line 493  class DataTagged : public DataAbstract {
493       \param region - Input - Region to copy into (NB: must have same shape as other!).       \param region - Input - Region to copy into (NB: must have same shape as other!).
494      T      T
495    */    */
496      ESCRIPT_DLL_API
497    virtual    virtual
498    void    void
499    setSlice(const DataAbstract* other,    setSlice(const DataAbstract* other,
500             const DataArrayView::RegionType& region);             const DataTypes::RegionType& region);
501    
502    
503    /**    /**
504       \brief       \brief
505       reshapeDataPoint       Computes a symmetric matrix (A + AT) / 2
506    
507         \param ev - Output - symmetric matrix
508    
      Description:  
      Reshape each data-point in this object to the given shape, only  
      if current data-points are scalars. An exception is thrown if  
      the current data-points have rank other than 0.  
      The original values of the data-points are used for all values  
      of the new data-points.  
     T  
509    */    */
510    void    ESCRIPT_DLL_API
511    reshapeDataPoint(const DataArrayView::ShapeType& shape);    virtual void
512      symmetric(DataAbstract* ev);
513    
514    /**    /**
515       \brief       \brief
516       Archive the underlying data values to the file referenced       Computes a nonsymmetric matrix (A - AT) / 2
517       by ofstream. A count of the number of values expected to be written  
518       is provided as a cross-check.       \param ev - Output - nonsymmetric matrix
519    
      The return value indicates success (0) or otherwise (1).  
520    */    */
521    int    ESCRIPT_DLL_API
522    archiveData(std::ofstream& archiveFile,    virtual void
523                const DataArrayView::ValueType::size_type noValues) const;    nonsymmetric(DataAbstract* ev);
524    
525    /**    /**
526       \brief       \brief
527       Extract the number of values specified by noValues from the file       Computes the trace of a matrix
      referenced by ifstream to the underlying data structure.  
528    
529       The return value indicates success (0) or otherwise (1).       \param ev - Output - the trace of a matrix
530         \param axis_offset
531    */    */
532    int    ESCRIPT_DLL_API
533    extractData(std::ifstream& archiveFile,    virtual void
534                const DataArrayView::ValueType::size_type noValues);    trace(DataAbstract* ev, int axis_offset);
535    
536      /**
537         \brief
538         swaps components axis0 and axis1
539    
540         \param ev - Output - swapped components
541         \param axis0
542         \param axis1
543      */
544      ESCRIPT_DLL_API
545      virtual void
546      swapaxes(DataAbstract* ev, int axis0, int axis1);
547    
548      /**
549         \brief
550         Transpose each data point of this Data object around the given axis.
551    
552         \param ev - Output - the transpose of a matrix
553         \param axis_offset
554      */
555      ESCRIPT_DLL_API
556      virtual void
557      transpose(DataAbstract* ev, int axis_offset);
558    
559    /**    /**
560       \brief       \brief
# Line 413  class DataTagged : public DataAbstract { Line 563  class DataTagged : public DataAbstract {
563       \param ev - Output - eigenvalues in increasing order at each data point       \param ev - Output - eigenvalues in increasing order at each data point
564    
565    */    */
566      ESCRIPT_DLL_API
567    virtual void    virtual void
568    eigenvalues(DataAbstract* ev);    eigenvalues(DataAbstract* ev);
569    
# Line 427  class DataTagged : public DataAbstract { Line 578  class DataTagged : public DataAbstract {
578    
579    */    */
580    
581      ESCRIPT_DLL_API
582    virtual void    virtual void
583    eigenvalues_and_eigenvectors(DataAbstract* ev,DataAbstract* V,const double tol=1.e-13);    eigenvalues_and_eigenvectors(DataAbstract* ev,DataAbstract* V,const double tol=1.e-13);
584    
585    
586      /**
587         \brief  Returns the offset in the structure which stores the default value
588      */
589      ESCRIPT_DLL_API
590      DataTypes::ValueType::size_type
591      getDefaultOffset() const;
592    
593   protected:   protected:
594    
595   private:   private:
# Line 457  DataTagged::isCurrentTag(int tag) const Line 616  DataTagged::isCurrentTag(int tag) const
616    return (pos!=m_offsetLookup.end());    return (pos!=m_offsetLookup.end());
617  }  }
618    
619  inline  inline
620  DataArrayView&  DataTypes::ValueType::size_type
621  DataTagged::getDefaultValue()  DataTagged::getDefaultOffset() const
622  {  {
623    // The default value is always the first value.    return m_defaultValueOffset;  
624    return getPointDataView();  }
625    
626    inline
627    DataTypes::ValueType::reference
628    DataTagged::getDefaultValueRW(DataTypes::ValueType::size_type i)
629    {  
630        return getVectorRW()[i];        // getVectorRW has exclusive write checks
631  }  }
632    
633  inline  inline
634  const DataArrayView&  DataTypes::ValueType::const_reference
635  DataTagged::getDefaultValue() const  DataTagged::getDefaultValueRO(DataTypes::ValueType::size_type i) const
636  {  {
637    // The default value is always the first value.      return getVectorRO()[i];
   return getPointDataView();  
638  }  }
639    
640  inline  inline
# Line 481  DataTagged::getTagLookup() const Line 645  DataTagged::getTagLookup() const
645  }  }
646    
647  inline  inline
648  DataArrayView::ValueType::size_type  DataTypes::ValueType::size_type
649  DataTagged::getLength() const  DataTagged::getLength() const
650  {  {
651    return m_data.size();    return m_data.size();

Legend:
Removed from v.580  
changed lines
  Added in v.2548

  ViewVC Help
Powered by ViewVC 1.1.26