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

Timestamp:

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

Author:

ansari

Message:

documentation cmv 13/4/00

File:

• trunk/SophyaLib/NTools/generalfit.h (modified) (10 diffs)

trunk/SophyaLib/NTools/generalfit.h

@@ -13 +13 @@
 //================================================================
 
+
+/*!
+  Classe de fonctions parametrees a plusieurs variables:
+  \f$ F[x1,x2,x3,...:a1,a2,a3,...] \f$
+*/
 class GeneralFunction {
 public:
@@ -18 +23 @@
   virtual ~GeneralFunction();
 
+  //! Valeur de la fonction a definir par l'utilisateur (fct virtuelle pure)
   virtual double Value(double const xp[], double const* parm)=0;
   virtual double Val_Der(double const xp[], double const* parm
@@ -25 +31 @@
   void SetDeltaParm(double const* dparam);
 
+  //! Retourne le nombre de variables Xi
   inline int     NVar() const {return mNVar;}
+  //! Retourne le nombre de parametres Ai
   inline int     NPar() const {return mNPar;}
 
 protected:
-  const int mNVar;  // nombre de variables f(x,y,z,...)
-  const int mNPar;  // nombre de parametres
+  const int mNVar;  //!< nombre de variables f(x,y,z,...)
+  const int mNPar;  //!< nombre de parametres
 
   double *deltaParm;
@@ -40 +48 @@
 //================================================================
 
+/*!
+  Classe de fonctions parametrees a plusieurs variables
+  derivant de ``GeneralFunction''. Permet de definir
+  une fonction a fiter sans passer par une classe derivee
+  en utilisant l'ecriture courante du C. La fonction
+  retournant les derivees par rapport aux parametres du fit
+  peut etre egalement fournie (optionnel).
+*/
 class GeneralFunc : public GeneralFunction {
 public:
@@ -62 +78 @@
 class GeneralFitData;
 
+/*!
+  Classe de Xi2 a plusieurs parametres :
+  \f$ Xi2[a1,a2,a3,...] \f$
+*/
 class GeneralXi2 {
 public:
@@ -67 +87 @@
   virtual ~GeneralXi2();
 
+  /*!
+  Valeur du Xi2 a definir par l'utilisateur (fct virtuelle pure)
+  a partir des donnees de `data'. l'utilisateur doit egalement
+  retourner le nombre de points de mesure utilises dans le calcul
+  du Xi2 (`ndataused').
+  */
   virtual double Value(GeneralFitData& data, double* parm, int& ndataused)=0;
   virtual double Derivee(GeneralFitData& data, int i, double* parm);
@@ -74 +100 @@
   void SetDeltaParm(double const* dparam);
 
+  //! Retourne le nombre de parametres Ai.
   inline int     NPar() const {return mNPar;}
 
 protected:
-  const int mNPar;  // nombre de parametres
+  const int mNPar;  //!< nombre de parametres
 
   double *deltaParm;
@@ -86 +113 @@
 //================================================================
 
+//! Classe de fit d'une GeneralFunction sur une GeneralFitData
 class GeneralFit {
 public:
@@ -129 +157 @@
   double          GetMax(int n);
   double          GetMin(int n);
+  //! Retourne le Chi2
   inline double   GetChi2()    const {return Chi2;};
+  //! Retourne le Chi2 reduit
   inline double   GetChi2Red() const {
                         if(mNddl<=0) return (double) mNddl;
                         return Chi2/(double) mNddl;
                                      };
+  //! Retourne la precision de convergence pour le parametre i.
   inline double   GetEps(int i) const {return Eps(i);};
+  //! Retourne le nombre de degres de liberte
   inline int      GetNddl()    const {return mNddl;};
+  //! Retourne le nombre d'iterations
   inline int      GetNStep()   const {return nStep;};
+  //! Retourne le nombre de variables
   inline int      GetNVar()    const {return mNVar;};
+  //! Retourne le nombre de parametres
   inline int      GetNPar()    const {return mNPar;};
+  //! Retourne le nombre de parametres libres
   inline int      GetNFree()   const {return mNParFree;};
+  //! Retourne le nombre de parametres bornes
   inline int      GetNBound()  const {return mNParBound;};
+  //! Retourne le nstop de convergence
   inline int      GetNStop()   const {return nStop;};
+  //! Retourne le nstop de convergence lente.
   inline int      GetNStopLent()   const {return nStopLent;};
+  //! Retourne le pointeur sur la GeneralFunction utilisee.
   inline GeneralFunction*  GetFunction() const {return mFunction;};
+  //! Retourne le pointeur sur la GeneralFitData utilisee.
   inline GeneralFitData*   GetGData() const {return mData;};
 
@@ -158 +199 @@
 
 protected:
-  int             mNtry;       // numero d'appel de la routine de fit.
-  int             mNVar;       // nombre de variables f(x,y,z,...)
-  int             mNPar;       // nombre de parametres
-  int             mNParFree;   // nombre de parametres libres
-  int             mNParBound;  // nombre de parametres bornes
+  int             mNtry;       //!< numero d'appel de la routine de fit.
+  int             mNVar;       //!< nombre de variables f(x,y,z,...)
+  int             mNPar;       //!< nombre de parametres
+  int             mNParFree;   //!< nombre de parametres libres
+  int             mNParBound;  //!< nombre de parametres bornes
   GeneralFunction*  mFunction;
   GeneralXi2*       mFuncXi2;