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

Timestamp:

Apr 12, 2000, 7:42:33 PM (25 years ago)

Author:

ansari

Message:

documentation cmv 12/4/00

File:

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

trunk/SophyaLib/TArray/utilarr.cc

@@ -8 +8 @@
 // Classe utilitaires
 
+//////////////////////////////////////////////////////////
+//! Constructor
+/*!
+  \param typ : generator type
+  \param m : mean parameter of the generator (if needed)
+  \param s : sigma parameter of the generator (if needed)
+ */
 RandomSequence::RandomSequence(int typ, double m, double s)
 {
@@ -15 +22 @@
 }
 
+//! Return random sequence values.
 double RandomSequence::Rand()
 {
@@ -23 +31 @@
 
 
+//////////////////////////////////////////////////////////
+//! Constructor
+/*!
+  \param start : start value
+  \param step : step value
+  \param f : pointer to the sequence function
+
+  See \ref SequenceOperat "operator()"
+ */
 Sequence::Sequence(double start, double step, Arr_DoubleFunctionOfX f)
   : rseq_(RandomSequence::Gaussian)
@@ -32 +49 @@
 }
 
+//! Constructor
+/*!
+  \param rseq : RandomSequence
+
+  See \ref SequenceOperat "operator()"
+ */
 Sequence::Sequence(RandomSequence rseq)
 {
@@ -41 +64 @@
 }
 
+//! Get the \b k th value
+/*!
+  \param k : index of the value
+  \anchor SequenceOperat
+
+  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
+ */
 double Sequence::operator () (uint_4 k)
 {
@@ -51 +87 @@
 }
 
+//////////////////////////////////////////////////////////
+//! Constructor
+/*!
+  Define a range of indexes
+  \param start : start index
+  \param end : start end
+  \param size : size
+  \param step : step
+
+  \warning If \b end \> \b start, \b size is computed automatically
+  \warning If not \b size is fixed and \b end recomputed
+ */
 Range::Range(uint_4 start, uint_4 end, uint_4 size, uint_4 step)
 {
@@ -77 +125 @@
 
 
+//////////////////////////////////////////////////////////
+//! Constructor of a (n,n) diagonal matrix with value diag on the diagonal
 IdentityMatrix::IdentityMatrix(double diag, uint_4 n)
 {