Changeset 2808 in Sophya for trunk/SophyaLib/HiStats/basedtable.cc

Timestamp:

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

Author:

ansari

Message:

MAJ documentation - Reza 14/6/2005

File:

• trunk/SophyaLib/HiStats/basedtable.cc (modified) (3 diffs)

trunk/SophyaLib/HiStats/basedtable.cc

@@ -131 +131 @@
 }
 
-
+//! Adds a line (or row to the table) with r_8* inout data
+/*! 
+  The data to be added is provided as an array (vector) of double (r_8).
+  The necessary data conversion is performed, depending on each 
+  column's data typeconverted to the data type. 
+  Return the new number of table rows (lines / entries)
+  \param data : Data for each cell of the row to be appended 
+  (data[k] k=0..NbColumns()) 
+*/
 sa_size_t BaseDataTable::AddLine(const r_8* data)
 {
@@ -155 +163 @@
 }
 
+//! Adds a line (or row to the table) with input data as an array of MuTyV
+/*! 
+  The data to be added is provided as an array (vector) of MuTyV.
+  The MuTyV class conversion operators are used to match against each 
+  cell data type.
+  Return the new number of table rows (lines / entries)
+  \param data : Data (MuTyV*) for each cell of the row to be appended 
+  (data[k] k=0..NbColumns()) 
+*/
 sa_size_t BaseDataTable::AddLine(const MuTyV* data)
 {
@@ -247 +264 @@
 }
 
-
-//! Prints table definition and number of entries 
+/*! In addition to printing the number of entries and column names, 
+  this method prints also minimum/maximum value for each column. 
+  This information might be computed when the Show() method is called.
+  This may take some time for tables with large number of entries (>~ 10^6)
+*/
 void   BaseDataTable::Show(ostream& os) const 
 {