Changeset 2808 in Sophya for trunk/SophyaLib/HiStats/ntuple.h

Timestamp:

Jun 14, 2005, 1:25:05 PM (20 years ago)

Author:

ansari

Message:

MAJ documentation - Reza 14/6/2005

File:

• trunk/SophyaLib/HiStats/ntuple.h (modified) (4 diffs)

trunk/SophyaLib/HiStats/ntuple.h

@@ -22 +22 @@
 class FITS_NTuple;
 
+//! Class for creation and management of double or float data sets in a table
 class NTuple : public AnyDataObj , public NTupleInterface {
 
@@ -28 +29 @@
                     NTuple(int nvar, char** noms, int blk=512, bool fgdouble=true);
                     NTuple(const NTuple& NT);
-  //A virer                 NTuple(char* flnm);
   virtual           ~NTuple();
 
@@ -35 +35 @@
   void              Fill(r_4* x);
   void              Fill(r_8* x);
-
-  inline int_4      NEntry() const  { return(mNEnt); }  
+  //! Return the number of lines (rows) in the table)
+  inline int_4      NEntry() const  { return(mNEnt); }
+  //! Return the number of columns in the tables (number of cells in a row)  
   inline int_4      NVar() const { return(mNVar); }  
+  //! Return the bloc size 
   inline int_4      BLock() const { return(mBlk); }  
 // $CHECK$ Reza 21/10/99 Pourquoi faire BLock() ?
 
+  //! Return the content of the cell for line (row) \b n , column \b k
   float             GetVal(int n, int k)   const;
+  //! Return the content of the cell for line (row) \b and column name \b nom
   inline float      GetVal(int n, const char* nom) const 
                             { return(GetVal(n, IndexNom(nom)) ); }
   int               IndexNom(const char* nom)  const ;
   char*             NomIndex(int k) const;
-
+  //! Return the content of line \b n as a vector of r_4 (float)
   r_4*              GetVec(int n, r_4* ret=NULL)  const ;
+  //! Return the content of line \b n as a vector of r_8 (double)
   r_8*              GetVecD(int n, r_8* ret=NULL)  const ;
 
@@ -55 +60 @@
   inline void       Show() const { Show(cout); }
 
+  //! Return the associated DVList object 
   DVList&           Info();