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


Ignore:
Timestamp:
Apr 13, 2000, 6:04:50 PM (25 years ago)
Author:
ansari
Message:

documentation cmv 13/4/00

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SophyaLib/NTools/generalfit.h

    r552 r914  
    1313//================================================================
    1414
     15
     16/*!
     17  Classe de fonctions parametrees a plusieurs variables:
     18  \f$ F[x1,x2,x3,...:a1,a2,a3,...] \f$
     19*/
    1520class GeneralFunction {
    1621public:
     
    1823  virtual ~GeneralFunction();
    1924
     25  //! Valeur de la fonction a definir par l'utilisateur (fct virtuelle pure)
    2026  virtual double Value(double const xp[], double const* parm)=0;
    2127  virtual double Val_Der(double const xp[], double const* parm
     
    2531  void SetDeltaParm(double const* dparam);
    2632
     33  //! Retourne le nombre de variables Xi
    2734  inline int     NVar() const {return mNVar;}
     35  //! Retourne le nombre de parametres Ai
    2836  inline int     NPar() const {return mNPar;}
    2937
    3038protected:
    31   const int mNVar;  // nombre de variables f(x,y,z,...)
    32   const int mNPar;  // nombre de parametres
     39  const int mNVar;  //!< nombre de variables f(x,y,z,...)
     40  const int mNPar;  //!< nombre de parametres
    3341
    3442  double *deltaParm;
     
    4048//================================================================
    4149
     50/*!
     51  Classe de fonctions parametrees a plusieurs variables
     52  derivant de ``GeneralFunction''. Permet de definir
     53  une fonction a fiter sans passer par une classe derivee
     54  en utilisant l'ecriture courante du C. La fonction
     55  retournant les derivees par rapport aux parametres du fit
     56  peut etre egalement fournie (optionnel).
     57*/
    4258class GeneralFunc : public GeneralFunction {
    4359public:
     
    6278class GeneralFitData;
    6379
     80/*!
     81  Classe de Xi2 a plusieurs parametres :
     82  \f$ Xi2[a1,a2,a3,...] \f$
     83*/
    6484class GeneralXi2 {
    6585public:
     
    6787  virtual ~GeneralXi2();
    6888
     89  /*!
     90  Valeur du Xi2 a definir par l'utilisateur (fct virtuelle pure)
     91  a partir des donnees de `data'. l'utilisateur doit egalement
     92  retourner le nombre de points de mesure utilises dans le calcul
     93  du Xi2 (`ndataused').
     94  */
    6995  virtual double Value(GeneralFitData& data, double* parm, int& ndataused)=0;
    7096  virtual double Derivee(GeneralFitData& data, int i, double* parm);
     
    74100  void SetDeltaParm(double const* dparam);
    75101
     102  //! Retourne le nombre de parametres Ai.
    76103  inline int     NPar() const {return mNPar;}
    77104
    78105protected:
    79   const int mNPar;  // nombre de parametres
     106  const int mNPar;  //!< nombre de parametres
    80107
    81108  double *deltaParm;
     
    86113//================================================================
    87114
     115//! Classe de fit d'une GeneralFunction sur une GeneralFitData
    88116class GeneralFit {
    89117public:
     
    129157  double          GetMax(int n);
    130158  double          GetMin(int n);
     159  //! Retourne le Chi2
    131160  inline double   GetChi2()    const {return Chi2;};
     161  //! Retourne le Chi2 reduit
    132162  inline double   GetChi2Red() const {
    133163                        if(mNddl<=0) return (double) mNddl;
    134164                        return Chi2/(double) mNddl;
    135165                                     };
     166  //! Retourne la precision de convergence pour le parametre i.
    136167  inline double   GetEps(int i) const {return Eps(i);};
     168  //! Retourne le nombre de degres de liberte
    137169  inline int      GetNddl()    const {return mNddl;};
     170  //! Retourne le nombre d'iterations
    138171  inline int      GetNStep()   const {return nStep;};
     172  //! Retourne le nombre de variables
    139173  inline int      GetNVar()    const {return mNVar;};
     174  //! Retourne le nombre de parametres
    140175  inline int      GetNPar()    const {return mNPar;};
     176  //! Retourne le nombre de parametres libres
    141177  inline int      GetNFree()   const {return mNParFree;};
     178  //! Retourne le nombre de parametres bornes
    142179  inline int      GetNBound()  const {return mNParBound;};
     180  //! Retourne le nstop de convergence
    143181  inline int      GetNStop()   const {return nStop;};
     182  //! Retourne le nstop de convergence lente.
    144183  inline int      GetNStopLent()   const {return nStopLent;};
     184  //! Retourne le pointeur sur la GeneralFunction utilisee.
    145185  inline GeneralFunction*  GetFunction() const {return mFunction;};
     186  //! Retourne le pointeur sur la GeneralFitData utilisee.
    146187  inline GeneralFitData*   GetGData() const {return mData;};
    147188
     
    158199
    159200protected:
    160   int             mNtry;       // numero d'appel de la routine de fit.
    161   int             mNVar;       // nombre de variables f(x,y,z,...)
    162   int             mNPar;       // nombre de parametres
    163   int             mNParFree;   // nombre de parametres libres
    164   int             mNParBound;  // nombre de parametres bornes
     201  int             mNtry;       //!< numero d'appel de la routine de fit.
     202  int             mNVar;       //!< nombre de variables f(x,y,z,...)
     203  int             mNPar;       //!< nombre de parametres
     204  int             mNParFree;   //!< nombre de parametres libres
     205  int             mNParBound;  //!< nombre de parametres bornes
    165206  GeneralFunction*  mFunction;
    166207  GeneralXi2*       mFuncXi2;
Note: See TracChangeset for help on using the changeset viewer.