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

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

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

revision 775 by ksteube, Mon Jul 10 04:00:08 2006 UTC revision 1118 by gross, Tue Apr 24 08:55:04 2007 UTC
# Line 78  class DataAbstract { Line 78  class DataAbstract {
78    std::string    std::string
79    toString() const = 0;    toString() const = 0;
80    
81     /**
82         \brief
83         dumps the object into a netCDF file
84      */
85      ESCRIPT_DLL_API
86      virtual
87      void
88      dump(const std::string fileName) const;
89    
90    /**    /**
91       \brief       \brief
92       Return the number of data points per sample.       Return the number of data points per sample.
# Line 150  class DataAbstract { Line 159  class DataAbstract {
159    double*    double*
160    getSampleDataByTag(int tag);    getSampleDataByTag(int tag);
161    
   /**  
      \brief  
      Assign the given value to the data-points(s) referenced by the given  
      reference number.  
   
      If this Data object cannot be accessed by reference numbers an  
      exception will be thrown.  
   
      \param ref - Input - reference number.  
      \param value - Input - value to assign to data-points associated with  
                             the given reference number.  
   */  
   ESCRIPT_DLL_API  
   virtual  
   void  
   setRefValue(int ref,  
               const DataArray& value);  
   
   /**  
      \brief  
      Return the values associated with the data-point(s) referenced by the given  
      reference number.  
   
      If this Data object cannot be accessed by reference numbers an  
      exception will be thrown.  
   
      \param ref - Input - reference number.  
      \param value - Output - object to receive data-points associated with  
                              the given reference number.  
   */  
   ESCRIPT_DLL_API  
   virtual  
   void  
   getRefValue(int ref,  
               DataArray& value);  
162    
163    /**    /**
164       \brief       \brief
# Line 261  class DataAbstract { Line 235  class DataAbstract {
235    setSlice(const DataAbstract* value,    setSlice(const DataAbstract* value,
236             const DataArrayView::RegionType& region) = 0;             const DataArrayView::RegionType& region) = 0;
237    
   /**  
      \brief  
      Reshape the data points if they are currently rank 0.  
      Will throw an exception if the data points are not rank 0.  
      The original data point value is used for all values of the new  
      data point.  
   */  
   ESCRIPT_DLL_API  
   virtual  
   void  
   reshapeDataPoint(const ShapeType& shape) = 0;  
238    
239    /**    /**
240       \brief       \brief
# Line 333  class DataAbstract { Line 296  class DataAbstract {
296    
297    /**    /**
298       \brief       \brief
299         Copy a double value to the data point dataPointNo of sample sampleNo in this object.
300    
301         Description:
302         Copy a double value to the data point dataPointNo of sample sampleNo in this object.
303    
304         \param sampleNo Input - sample number
305         \param dataPointNo Input - data point of the sample
306         \param value Input - new values for the data point
307      */
308      ESCRIPT_DLL_API
309      virtual void
310      copyToDataPoint(const int sampleNo, const int dataPointNo, const double value);
311    
312      /**
313         \brief
314         Copy the numarray object to the data point dataPointNo of sample sampleNo in this object.
315    
316         Description:
317         Copy the numarray object to the data point dataPointNo of sample sampleNo in this object.
318    
319         \param sampleNo Input - sample number
320         \param dataPointNo Input - data point of the sample
321         \param value Input - new values for the data point
322      */
323      ESCRIPT_DLL_API
324      virtual void
325      copyToDataPoint(const int sampleNo, const int dataPointNo, const boost::python::numeric::array& value);
326    
327    
328      /**
329         \brief
330       Return the tag number associated with the given data-point number.       Return the tag number associated with the given data-point number.
331    
332       If the object cannot be referenced by tag numbers, an exception       If the object cannot be referenced by tag numbers, an exception
# Line 350  class DataAbstract { Line 344  class DataAbstract {
344       \param ev - Output - a symmetric matrix       \param ev - Output - a symmetric matrix
345    
346    */    */
347      ESCRIPT_DLL_API
348    virtual void    virtual void
349    symmetric(DataAbstract* ev);    symmetric(DataAbstract* ev);
350    
# Line 360  class DataAbstract { Line 355  class DataAbstract {
355       \param ev - Output - a nonsymmetric matrix       \param ev - Output - a nonsymmetric matrix
356    
357    */    */
358      ESCRIPT_DLL_API
359    virtual void    virtual void
360    nonsymmetric(DataAbstract* ev);    nonsymmetric(DataAbstract* ev);
361    
# Line 370  class DataAbstract { Line 366  class DataAbstract {
366       \param ev - Output - the trace of a matrix       \param ev - Output - the trace of a matrix
367    
368    */    */
369      ESCRIPT_DLL_API
370    virtual void    virtual void
371    matrixtrace(DataAbstract* ev, int axis_offset);    trace(DataAbstract* ev, int axis_offset);
372    
373    /**    /**
374       \brief       \brief
# Line 380  class DataAbstract { Line 377  class DataAbstract {
377       \param ev - Output - the transpose of a matrix       \param ev - Output - the transpose of a matrix
378    
379    */    */
380      ESCRIPT_DLL_API
381    virtual void    virtual void
382    transpose(DataAbstract* ev, int axis_offset);    transpose(DataAbstract* ev, int axis_offset);
383    
384    /**    /**
385       \brief       \brief
386         swaps components axis0 and axis1
387    
388         \param ev - Output - swapped components
389    
390      */
391      ESCRIPT_DLL_API
392      virtual void
393      swapaxes(DataAbstract* ev, int axis0, int axis1);
394      /**
395         \brief
396       solves the eigenvalue problem this*V=ev*V for the eigenvalues ev       solves the eigenvalue problem this*V=ev*V for the eigenvalues ev
397    
398       \param ev - Output - eigenvalues in increasing order at each data point       \param ev - Output - eigenvalues in increasing order at each data point
# Line 396  class DataAbstract { Line 404  class DataAbstract {
404    
405    /**    /**
406       \brief       \brief
407         sets values to zero
408    
409      */
410      ESCRIPT_DLL_API
411      virtual void
412      setToZero();
413    
414      /**
415         \brief
416       solves the eigenvalue problem this*V=ev*V for the eigenvalues ev and eigenvectors V       solves the eigenvalue problem this*V=ev*V for the eigenvalues ev and eigenvectors V
417    
418       \param ev - Output - eigenvalues in increasing order at each data point       \param ev - Output - eigenvalues in increasing order at each data point

Legend:
Removed from v.775  
changed lines
  Added in v.1118

  ViewVC Help
Powered by ViewVC 1.1.26