Changeset 1404 in Sophya for trunk/SophyaLib/TArray/utilarr.cc

Timestamp:

Feb 15, 2001, 6:57:43 PM (25 years ago)

Author:

ansari

Message:

correction documentation - Reza 15/2/2001

File:

• trunk/SophyaLib/TArray/utilarr.cc (modified) (4 diffs)

trunk/SophyaLib/TArray/utilarr.cc

@@ -16 +16 @@
   \class SOPHYA::RandomSequence
   \ingroup TArray
-  Class to generate a random sequence of values
+  Base class to generate a sequence of random values
 */
 
@@ -67 +67 @@
   \param start : start value
   \param step : step value
-  \param f : pointer to the sequence function
+  \param f : pointer to the sequence function (default = NULL, f(x)=x )
 
   See \ref RegularSequenceOperat "operator()"
@@ -86 +86 @@
   \param k : index of the value
   \anchor RegularSequenceOperat
-
-  If the constructor was done with RandomSequence, return a RandomSequence
-  and \b k doesn't matter.
-
-  If the constructor has a NULL Arr_DoubleFunctionOfX, return start+k*step
-
-  If the constructor has a not NULL Arr_DoubleFunctionOfX, return f(start+k*step)
-  \return the \b k th value
+  
+  \return f(start+k*step)
+
  */
 
@@ -104 +99 @@
 }
 
+/*!
+  \class SOPHYA::EnumeratedSequence
+  \ingroup TArray
+  Explicitly defined sequence of values. The comma operator has
+  been redefined to let an easy definition of sequences.
+  
+  \code
+  // Initializing a sequence 
+  EnumeratedSequence es;
+  es = 11, 22, 33, 44, 55, 66;
+  
+  for(int k=0; k<8; k++) 
+    cout << " k= " << k << " es(k)= " << es(k) << endl; 
+  \endcode
+*/
+
+EnumeratedSequence::EnumeratedSequence()
+{
+}
+
 EnumeratedSequence::~EnumeratedSequence()
 {
 }
 
+//! Return the k th value in the sequence (default = 0)
 MuTyV & EnumeratedSequence::Value (sa_size_t k) const 
 {