Changeset 2808 in Sophya for trunk/SophyaLib/NTools/simplex.h

Timestamp:

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

Author:

ansari

Message:

MAJ documentation - Reza 14/6/2005

File:

• trunk/SophyaLib/NTools/simplex.h (modified) (5 diffs)

trunk/SophyaLib/NTools/simplex.h

@@ -28 +28 @@
 namespace SOPHYA {
 
-//! Interface definition for multivaruable function (used by SimplexMinmizer)
+//! Interface definition for multivariable function (used by SimplexMinmizer)
 class MinZFunction {
 public:
@@ -42 +42 @@
 };
 
-//!  Classe implementing MinZFunction for a GeneralXi2 associated with a GeneralFitData
+//!  Wrapper class implementing MinZFunction for a GeneralXi2 associated with a GeneralFitData
 class MinZFuncXi2 : public MinZFunction {
 public: 
@@ -61 +61 @@
   virtual        ~MinZSimplex();
 
+  //! Return the parameter space dimension 
   inline int     NDim() { return mZF->NVar(); }
   // Simplex initial 
+  //! Defines the initial point (center of simplex figure)
   inline void    SetInitialPoint(Vector& point) { mPoint0 = point; }
+  //! Defines the step along each dimension to construct the simplex from initial point
   inline void    SetInitialStep(Vector& step) { mStep0 = step; }
 
+  //! Set the info/debug print level  
   inline void    SetPrtLevel(int lev=0) { mPrt = lev; }
+  //! Return the current print level
   inline int     PrtLevel() { return mPrt; }
 
+  //! Set the maximum number of iteration
   inline void    SetMaxIter(int max = 100000) { mMaxIter = max; }
+  //! Return the current  max iter 
   inline int     MaxIter() { return mMaxIter; }
+  //! Return the number of iterations performed
   inline int     NbIter() { return mIter; }
+  //! Return the stop reason
   inline int     StopReason() { return mStop; }
+  //! Return the stop reason and a description string (\b s)
          int     StopReason(string& s);
 
@@ -86 +96 @@
   //  [Delta f/f]simplex              < mTol1   mRep1 fois de suite    OU 
   //  [Delta f_max/f_max]iter         < mTol2   mRep2 fois de suite 
-  // 
+
+  //! Define the tolerances for the various convergence tests
   inline void    SetStopTolerance(double tol0=1.e-39, double tol1 = 1.e-3, int rep1=5, 
                                   double tol2=1.e-4, int rep2=5)   
@@ -97 +108 @@
   // Beta2  = Facteur d'homothetie pour la contraction vers le sommet bas f_min (ContractLow)
   // Gamma2 = Facteur d'homothetie pour la l'extension pour le sommet haut ExpandHigh
+
+  //! Define the similarity (homothetic) factors for the different simplex transformations
   inline void    SetControls(double alpha=1., double beta=0.5, double beta2=0.5, 
                              double gamma=2.0, double gamma2=2.0)
                  { mAlpha = alpha; mBeta = beta; mBeta2 = beta2;  mGamma = gamma; mGamma2 = gamma2;}  
 
+  //! Return the the homothetic factor for Reflection
   inline double  Alpha() { return mAlpha; }
+  //! Return the the homothetic factor for ContractHigh (contraction away from high point)
   inline double  Beta() { return mBeta; }
+  //! Return the the homothetic factor for ContractLow (contraction toward the low point)
   inline double  Beta2() { return mBeta2; }
+  //! Return the the homothetic factor for ReflecExpand (reflection+expansion)
   inline double  Gamma() { return mGamma; }
+  //! Return the the homothetic factor for ExpandHigh (expansion along high point)
   inline double  Gamma2() { return mGamma2; }