Changeset 1405 in Sophya for trunk/SophyaLib/HiStats/xntuple.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/xntuple.cc (modified) (11 diffs)

trunk/SophyaLib/HiStats/xntuple.cc

@@ -20 +20 @@
    columns with int, float or string type content. In addition, this class
    can handle large data sets, using swap space on disk.
+   \sa SOPHYA::ObjFileIO<XNTuple>
+
+   \code
+   #include "xntuple.h"
+   // ...
+   char * names[4] = {"X", "X2", "XInt","XStr"};
+   // XNTuple (Table) creation with 4 columns, of integer, 
+   // double(2) and string type
+   XNTuple  xnt(2,0,1,1, names);
+   // Filling the NTuple
+   r_8 xd[2];
+   int_4 xi[2];
+   char xss[2][32];
+   char * xs[2] = {xss[0], xss[1]} ;
+   for(int i=0; i<50; i++) {
+     xi[0] = i;  xd[0] = i+0.5;  xd[1] = xd[0]*xd[0];
+     sprintf(xs[0],"X=%g", xd[0]);
+     xnt.Fill(xd, NULL, xi, xs);
+   }
+   // Printing table info
+   cout << xnt ;
+   // Saving object into a PPF file
+   POutPersist po("xnt.ppf");
+   po << xnt ;
+   \endcode
+   
 */
 
@@ -218 +244 @@
 //--
 
+//! Constructor with specification colum types and names
+/*!
+  \param ndvar : Number of columns with type double (r_8)
+  \param nfvar : Number of columns with type float (r_4)
+  \param nivar : Number of columns with type integer (int_4)
+  \param nsvar : Number of columns with type string
+  \param vnames : Column names (in the order r_8 r_4 int_4 string)
+  (colum names are limited to 31 characters)
+  \param blk : data block size (in number of table lines)
+  \param maxblk : Maximum number of data block in memory
+  \param strsz : string length (for string type columns)
+ */
 XNTuple::XNTuple(int ndvar, int nfvar, int nivar, int nsvar, 
                    char** vnames, 
@@ -249 +287 @@
 
 
+//! Constructor with table initialized from a PPF file
 XNTuple::XNTuple(string const& flnm) 
     : mNEnt(0), mNBlk(0), mNSwBlk(0), 
@@ -268 +307 @@
 
 
+//! Copy constructor - Copies the table definition and associated data 
 XNTuple::XNTuple(XNTuple const& nt) 
     : mNEnt(0), mNBlk(0), mNSwBlk(0), 
@@ -294 +334 @@
 
 
+//! Clear the data table definition and deletes the associated data
 void XNTuple::clean()
 {
@@ -341 +382 @@
 //      Opérateur égal (=) , copie "nt" dans le premier NTuple
 //--
+//! Appends an entry (line) to the table
+/*!
+  \param d_data : double (r_8) line elements
+  \param f_data : float (r_4) line elements
+  \param i_data : integer (int_4) line elements
+  \param s_data : string line elements
+ */
 void XNTuple::Fill(r_8* d_data, r_4* f_data, int_4* i_data, char** s_data) 
 {
@@ -552 +600 @@
 //--
 
+//! Returns the associated DVList object
 DVList&  XNTuple::Info()
 {
@@ -597 +646 @@
 
 
+//! Prints table definition and number of entries 
 void   XNTuple::Show(ostream& os) const 
 {
@@ -636 +686 @@
 }
 
+//! NOT YET IMPLEMENTED ! - Fills table from an ascii file
 int    XNTuple::FillFromASCIIFile(string const& fn, r_8 ddval,  r_4 dfval,
                                         int dival, const char * dsval)
@@ -646 +697 @@
 
 
+//! Defines swap file path for XNTuple objects (Default=/tmp)
 void  XNTuple::SetSwapPath(char* p) 
 {
@@ -843 +895 @@
 }
 
+/*!
+   \class SOPHYA::ObjFileIO<XNTuple>
+   \ingroup HiStats
+   Persistence (serialisation) handler for class XNTuple
+*/
 
 void   ObjFileIO<XNTuple>::WriteSelf(POutPersist& ppout) const