/[escript]/trunk/esys2/escript/src/Data/DataExpanded.h
ViewVC logotype

Diff of /trunk/esys2/escript/src/Data/DataExpanded.h

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

revision 112 by jgs, Mon Feb 14 04:14:42 2005 UTC revision 113 by jgs, Mon Feb 28 07:06:33 2005 UTC
# Line 180  class DataExpanded : public DataAbstract Line 180  class DataExpanded : public DataAbstract
180    
181    /**    /**
182       \brief       \brief
183       Assign the given value to the data-point associated with the given       Assign the given value to all data-points associated with the given
184       reference number.       reference number.
185    
186       A reference number corresponds to a sample, and thus to all data-points       A reference number corresponds to a sample, and thus to all data-points
187       in that sample. If there is more than one data-point per sample number       in that sample.
188       in this Data object, an exception will be thrown. If the given reference  
189       number does not correspond to any sample in this Data object, an exception       If the given reference number does not correspond to any sample in this
190       will be thrown.       Data object, an exception will be thrown.
191    
192       If the given value is a different shape to this Data object, an exception       If the given value is a different shape to this Data object, an exception
193       will be thrown.       will be thrown.
194    
195       \param ref - Input - reference number which determines data-point to assign to.       \param ref - Input - reference number which determines sample numebr to
196                              assign given values to.
197       \param value - Input - Value to assign to data-point associated with       \param value - Input - Value to assign to data-point associated with
198                              the given reference number.                              the given reference number.
199    */    */
# Line 203  class DataExpanded : public DataAbstract Line 204  class DataExpanded : public DataAbstract
204    
205    /**    /**
206       \brief       \brief
207       Return the value of the data-point associated with the given       Return the value of the first data-point in the sample associated with
208       reference number.       the given reference number.
209    
210       A reference number corresponds to a sample, and thus to all data-points       A reference number corresponds to a sample, and thus to all data-points
211       in that sample. If there is more than one data-point per sample number       in that sample. If there is more than one data-point per sample number
212       in this Data object, an exception will be thrown. If the given reference       in this Data object, the value of the first data-point will be returned.
213       number does not correspond to any sample in this Data object, an exception  
214       will be thrown.       If the given reference number does not correspond to any sample in this
215         Data object, an exception will be thrown.
216    
217       If the given value is a different shape to this Data object, an exception       If the given value is a different shape to this Data object, an exception
218       will be thrown.       will be thrown.
219    
220       \param ref - Input - reference number which determines data-point to read from.       \param ref - Input - reference number which determines sample number to
221                              read from.
222       \param value - Output - Object to receive data-points associated with       \param value - Output - Object to receive data-points associated with
223                              the given reference number.                              the given reference number.
224    */    */

Legend:
Removed from v.112  
changed lines
  Added in v.113

  ViewVC Help
Powered by ViewVC 1.1.26