Changeset 914 in Sophya for trunk/SophyaLib/HiStats/histos.h

Timestamp:

Apr 13, 2000, 6:04:50 PM (25 years ago)

Author:

ansari

Message:

documentation cmv 13/4/00

File:

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

trunk/SophyaLib/HiStats/histos.h

@@ -1 +1 @@
 // This may look like C code, but it is really -*- C++ -*-
 //
-// $Id: histos.h,v 1.1.1.1 2000-03-02 16:51:32 ansari Exp $
+// $Id: histos.h,v 1.2 2000-04-13 16:04:11 ansari Exp $
 //
 
@@ -19 +19 @@
 class GeneralFit;
 
+
+/*!
+  Classe d'histogrammes 1D
+*/
 class Histo : public AnyDataObj {
   friend class ObjFileIO<Histo>;
@@ -77 +81 @@
 
   // INLINES
+  //! Retourne l'abscisse minimum
   inline float          XMin() const             {return min;}
+  //! Retourne l'abscisse maximum
   inline float          XMax() const             {return max;}
+  //! Retourne le nombre de bins
   inline int_4          NBins() const            {return bins;}
+  //! Retourne la largeur du bin
   inline float          BinWidth() const         {return binWidth;}
+  //! Retourne le pointeur sur le tableaux des contenus
   inline float*         Bins() const             {return data;}
+  //! Retourne le contenu du bin i
   inline float          operator()(int i) const  {return data[i];}
+  //! Remplit le contenu du bin i
   inline float&         operator()(int i)        {return data[i];}
+  //! retourne "true" si il y a des erreurs stoquees
   inline bool           HasErrors() { if(err2) return true; else return false;}
+  //! Retourne l'erreur du bin i
   inline float          Error(int i) const
                           {if(err2) {if(err2[i]>0.) return sqrt(err2[i]); else return 0.;}
                            else return 0.;}
+  //! Retourne l'erreur au carre du bin i
   inline double         Error2(int i) const
                           {if(err2) return err2[i]; else return 0.;}
+  //! Remplit l'erreur au carre du bin i
   inline double&        Error2(int i) {return err2[i];}
+  //! Retourne la somme ponderee
   inline float          NData() const            {return (float) nHist;}
+  //! Retourne le nombre d'entrees
   inline float          NEntries() const         {return nEntries;}
+  //! Retourne le nombre d'overflow
   inline float          NOver() const            {return over;}
+  //! Retourne le nombre d'underflow
   inline float          NUnder() const           {return under;}
 
+  //! Retourne l'abscisse du bord inferieur du bin i
   inline float          BinLowEdge(int i)  const {return min + i*binWidth;}
+  //! Retourne l'abscisse du centre du bin i
   inline float          BinCenter(int i)   const {return min + (i+0.5)*binWidth;}
+  //! Retourne l'abscisse du bord superieur du bin i
   inline float          BinHighEdge(int i) const {return min + (i+1)*binWidth;} 
+  //! Retourne le numero du bin contenant l'abscisse x
   inline int_4          FindBin(float x) const   
                             {return (int_4) floorf((x - min) / binWidth);}
@@ -146 +169 @@
   void Delete();
 
-  float*         data;           
-  double*        err2;           
-  float          under;
-  float          over;
-  double         nHist;
-  int_4          nEntries;
-  int_4          bins;
-  float          min;
-  float          max;
-  float          binWidth;
+  float*         data;     //!< donnees
+  double*        err2;     //!< erreurs carrees
+  float          under;    //!< underflow
+  float          over;     //!< overflow
+  double         nHist;    //!< somme ponderee des entrees
+  int_4          nEntries; //!< nombre d'entrees
+  int_4          bins;     //!< nombre de bins
+  float          min;      //!< abscisse minimum
+  float          max;      //!< abscisse maximum
+  float          binWidth; //!< largeur du bin
 };