Changeset 914 in Sophya for trunk/SophyaLib/NTools/generaldata.h

Timestamp:

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

Author:

ansari

Message:

documentation cmv 13/4/00

File:

• trunk/SophyaLib/NTools/generaldata.h (modified) (3 diffs)

trunk/SophyaLib/NTools/generaldata.h

@@ -19 +19 @@
 //================================================================
 
+/*!
+  Classe de stoquage de donnees a plusieurs variables avec erreur
+  sur l'ordonnee et sur les abscisses (options) :
+
+  \f$ {x0(i),Ex0(i), x1(i),Ex1(i), x2(i),Ex2(i) ... ; Y(i),EY(i)} \f$
+  \verbatim
+   Pour memoire, structure du rangement (n=mNVar):
+   - Valeur des abscisses mXP (idem pour mErrXP):
+     x0,x1,x2,...,xn   x0,x1,x2,...,xn  ....  x0,x1,x2,....,xn
+     |  1er point  |   |  2sd point  |  ....  | point mNData |
+     Donc abscisse J=[0,mNVar[ du point numero I=[0,mNData[: mXP[I*mNVar+J]
+   - Valeur de l'ordonnee mF (idem pour mErr et mOK):
+            f                f                      f
+     |  1er point  |  |  2sd point  |  .... | point mNData |
+     Donc point numero I [0,mNData[ : mF[i]
+  \endverbatim
+*/
+
 class GeneralFitData : public AnyDataObj , public NTupleInterface {
   friend class GeneralFit;
   friend class ObjFileIO<GeneralFitData>;
 public:
-  enum {Def_ErrF = 1, Def_ErrX = 0};
+  //! Valeurs par defaut pour l'utilisation des erreurs
+  enum {
+    Def_ErrF = 1, //!< erreurs sur F par defaut
+    Def_ErrX = 0  //!< pas d'erreurs sur les variables X,Y,... par defaut
+    };
 
   GeneralFitData(unsigned int nVar, unsigned int nDataAlloc, uint_2 errx=0);
@@ -67 +89 @@
   inline void Show() const {Show(cout);}
 
+  //! Retourne la place restante dans la structure (nombre de donnees que l'on peut encore stoquer).
   inline int GetSpaceFree() const { return mNDataAlloc - mNData; }
+  //! Retourne le nombre de variables Xi
   inline int NVar()       const {return mNVar;}
+  //! Retourne le nombre de donnees
   inline int NData()      const {return mNData;}
+  //! Retourne le nombre de bonnes donnees (utilisees pour le fit)
   inline int NDataGood()  const {return mNDataGood;}
+  //! Retourne la place maximale allouee pour les donnees
   inline int NDataAlloc() const {return mNDataAlloc;}
 
+  //! Retourne 1 si point valide, sinon 0
   inline unsigned short int IsValid(int i) const
                 {if(i>=0 && i<mNData) return mOK[i]; else return 0;}
+  //! Retourne ``true'' si il y a des erreurs sur les variables d'abscisse, ``false'' sinon.
   inline bool HasXErrors() {if(mErrXP) return true; else return false;}
 
+  //! Retourne l'abscisse pour 1 dimension (y=f(x)) donnee I
   inline double X1(int i) const
                 {if(i>=0 && i<mNData) return mXP[i]; else return 0.;}
+  //! Retourne la 1er abscisse (X) pour (v=f(x,y,z,...)) donnee I
   inline double X(int i) const
                 {if(i>=0 && i<mNData) return mXP[i*mNVar]; else return 0.;}
+  //! Retourne la 2sd abscisse (Y) pour (v=f(x,y,z,...)) donnee I
   inline double Y(int i) const
                 {if(i>=0 && i<mNData && 1<mNVar) return mXP[i*mNVar+1]; else return 0.;}
+  //! etourne la 3ieme abscisse (Z) pour (v=f(x,y,z,...)) donnee I
   inline double Z(int i) const
                 {if(i>=0 && i<mNData && 2<mNVar) return mXP[i*mNVar+2]; else return 0.;}
+  //! Retourne la Jieme abscisse (Xj) pour (v=f(x0,x1,x2,...)) donnee I
   inline double Absc(int j,int i) const
                 {if(i>=0 && i<mNData && j<mNVar)return mXP[i*mNVar+j]; else return 0.;}
+  //! Retourne la valeur de la Ieme donnee
   inline double Val(int i) const
                 {if(i>=0 && i<mNData) return mF[i]; else return 0.;}
 
+  //! Retourne l'erreur (dx) sur l'abscisse pour 1 dimension (y=f(x)) donnee I
   inline double EX1(int i) const
                 {if(mErrXP && i>=0 && i<mNData) return mErrXP[i]; else return 0.;}
+  //! Retourne l'erreur (dx) sur la 1er abscisse (X) pour (v=f(x,y,z,...)) donnee I
   inline double EX(int i) const
                 {if(mErrXP && i>=0 && i<mNData) return mErrXP[i*mNVar]; else return 0.;}
+  //! Retourne l'erreur (dy) sur la 2sd abscisse (Y) pour (v=f(x,y,z,...)) donnee I
   inline double EY(int i) const
                 {if(mErrXP && i>=0 && i<mNData && 1<mNVar) return mErrXP[i*mNVar+1];
                  else return 0.;}
+  //! Retourne l'erreur (dz) sur la 3ieme abscisse (Z) pour (v=f(x,y,z,...)) donnee I
   inline double EZ(int i) const
                 {if(mErrXP && i>=0 && i<mNData && 2<mNVar) return mErrXP[i*mNVar+2];
                  else return 0.;}
+  //! Retourne l'erreur (dxj) sur la Jieme abscisse (Xj) pour (v=f(x0,x1,x2,...)) donnee I
   inline double EAbsc(int j,int i) const
                 {if(mErrXP && i>=0 && i<mNData && j<mNVar) return mErrXP[i*mNVar+j];
                  else return 0.;}
+  //! Retourne l'erreur de la Ieme donnee
   inline double EVal(int i) const
                 {if(i>=0 && i<mNData) return mErr[i]; else return 0.;}
@@ -139 +180 @@
   int_4   mNDataGood;
   uint_2  mOk_EXP;
-  r_8* mXP;             // x0 y0 z0, x1 y1 z1, ..., xn yn zn 
-  r_8* mErrXP;          // Ex0 Ey0 Ez0, Ex1 Ey1 Ez1, ..., Exn Eyn Ezn 
-  r_8* mF;              // F0, F1, ...., Fn
-  r_8* mErr;            // EF0, EF1, ...., EFn
-  uint_2* mOK; // 1 si pt valid, 0 sinon
+  r_8* mXP;             //!< x0 y0 z0, x1 y1 z1, ..., xn yn zn 
+  r_8* mErrXP;          //!< Ex0 Ey0 Ez0, Ex1 Ey1 Ez1, ..., Exn Eyn Ezn 
+  r_8* mF;              //!< F0, F1, ...., Fn
+  r_8* mErr;            //!< EF0, EF1, ...., EFn
+  uint_2* mOK;          //!< 1 si pt valid, 0 sinon
   r_8* BuffVar;
   r_4* BuffVarR4;