Changeset 1405 in Sophya for trunk/SophyaLib/HiStats/ntuple.cc

Timestamp:

Feb 15, 2001, 6:58:16 PM (25 years ago)

Author:

ansari

Message:

Ajout documentation - Reza 15/2/2001

File:

• trunk/SophyaLib/HiStats/ntuple.cc (modified) (11 diffs)

trunk/SophyaLib/HiStats/ntuple.cc

@@ -16 +16 @@
    Simple NTuple class (a Table or 2-D data set) with floating value
    columns. 
+   \sa SOPHYA::ObjFileIO<NTuple>
+
+   \code
+   #include "ntuple.h"
+   // ...
+   char * names[3] = {"XPos", "YPos", "Val"};
+   // NTuple (Table) creation with 3 columns
+   NTuple  nt(3, names);
+   // Filling the NTuple
+   r_4 x[3];
+   for(int i=0; i<63; i++) {
+     x[0] = (i%9)-4.;  x[1] = (i/9)-3.;  x[2] = x[0]*x[0]+x[1]*x[1];
+     nt.Fill(x);
+   }
+   // Printing table info
+   cout << nt ;
+   // Saving object into a PPF file
+   POutPersist po("nt.ppf");
+   po << nt ;
+   \endcode
 */
 
@@ -32 +52 @@
 
 /* --Methode-- */
+//! Default constructor
 //++
 NTuple::NTuple()
@@ -46 +67 @@
 
 
+//! Constructor with specification of number of columns and column name
+/*!
+  \param nvar : Number of columns in the table 
+  \param noms : Array of column names (length(name) < 8 characters) 
+  \param blk : Optional argument specifying number of table lines
+  in a given data block
+ */
 //++
 NTuple::NTuple(int nvar, char** noms, int blk)
@@ -77 +105 @@
 }
 
+//! Copy constructor - Copies the table definition and associated data 
 //                                       cmv 8/10/99
 //++
@@ -108 +137 @@
 
 /* --Methode-- */
+//! Constructor with table initialized from a PPF file
 //++
 NTuple::NTuple(char *flnm)
@@ -131 +161 @@
 
 /* --Methode-- */
+//! Clear the data table definition and deletes the associated data
 void NTuple::Clean()
 {
@@ -149 +180 @@
 
 /* --Methode--        cmv 08/10/99 */
+//! = operator, copies the data table definition and its contents
 //++
 NTuple& NTuple::operator = (const NTuple& NT)
@@ -181 +213 @@
 
 /* --Methode-- */
+//! Adds an entry (a line) to the table
+/*!
+  \param x : content of the line to be appended to the table
+ */
 //++
 void  NTuple::Fill(r_4* x)
@@ -317 +353 @@
 
 /* --Methode-- */
+//! Prints table definition and number of entries 
 //++
 void  NTuple::Show(ostream& os)  const
@@ -339 +376 @@
 
 /* --Methode-- */
+//! Fills the table, reading lines from an ascii file
+/*!
+  \param fn : file name
+  \param defval : default value for empty cells in the ascii file 
+ */
 //++
 int  NTuple::FillFromASCIIFile(string const& fn, float defval)
@@ -544 +586 @@
 }
 
+/*!
+   \class SOPHYA::ObjFileIO<NTuple>
+   \ingroup HiStats
+   Persistence (serialisation) handler for class NTuple
+*/
 
 /* --Methode-- */