Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMillepede.h
index 1b5b61d..b5fbe86 100644 (file)
@@ -36,7 +36,9 @@ public:
   virtual Int_t SetGlobalConstraint(double dercs[], double rhs);
   virtual Int_t SetLocalEquation(double dergb[], double derlc[], double rmeas, double sigma);
   virtual Int_t LocalFit(int n, double localParams[], Bool_t bSingleFit);
+                /// Get number of local equations
   virtual Int_t GetNLocalEquations() const {return fNLocalEquations;};
+                /// Set number of local equations
   virtual void  SetNLocalEquations(int value) {fNLocalEquations = value;};
   virtual Int_t PrintGlobalParameters() const;
   virtual Int_t SetIterations (double cutfac);
@@ -46,15 +48,15 @@ private:
 
 // Max. dimensions
 
-  static const int fgkMaxGlobalPar  = 1000; // Max. number of global parameters
-  static const int fgkMaxLocalPar   = 20;  // Max. number of local parameters
-  static const int fgkMaxGloCsts    = 10;  // Max. number of constraint equations
-  static const int fgkMaxGloPC     = 1010; // fgkMaxGlobalPar+fgkMaxGloCsts
+  static const int fgkMaxGlobalPar  = 1000; ///< Max. number of global parameters
+  static const int fgkMaxLocalPar   = 20;   ///< Max. number of local parameters
+  static const int fgkMaxGloCsts    = 10;   ///< Max. number of constraint equations
+  static const int fgkMaxGloPC     = 1010; ///< fgkMaxGlobalPar+fgkMaxGloCsts
 
 
 // Private methods 
 
-  Double_t GetParCorrelation(int i, int j);
+  // Double_t GetParCorrelation(int i, int j);
 
   int   SpmInv(double v[][fgkMaxGloPC], double b[], int n);
   int   SpmInv(double v[][fgkMaxLocalPar], double b[], int n);
@@ -64,57 +66,57 @@ private:
 
 // Matrices
 
-  double fMatCGlo[fgkMaxGloPC][fgkMaxGloPC];            // Matrix C global
-  double fMatCLoc[fgkMaxLocalPar][fgkMaxLocalPar];      // Matrix C local
-  double fMatCGloLoc[fgkMaxGlobalPar][fgkMaxLocalPar];  // Rectangular matrix C g*l
-  double fMatCGloCorr[fgkMaxGlobalPar][fgkMaxGlobalPar];// Correction of matrix C global
-  double fMatDerConstr[fgkMaxGloCsts][fgkMaxGlobalPar]; // Constrained derivatives
+  double fMatCGlo[fgkMaxGloPC][fgkMaxGloPC];            ///< Matrix C global
+  double fMatCLoc[fgkMaxLocalPar][fgkMaxLocalPar];      ///< Matrix C local
+  double fMatCGloLoc[fgkMaxGlobalPar][fgkMaxLocalPar];  ///< Rectangular matrix C g*l
+  double fMatCGloCorr[fgkMaxGlobalPar][fgkMaxGlobalPar];///< Correction of matrix C global
+  double fMatDerConstr[fgkMaxGloCsts][fgkMaxGlobalPar]; ///< Constrained derivatives
 
 // Vectors and useful variables
 
-  double fDiagCGlo[fgkMaxGloPC];        // Initial diagonal elements of C global matrix
-  double fVecBGlo[fgkMaxGloPC];         // Vector B global (parameters) 
-  double fVecBGloCorr[fgkMaxGlobalPar]; // Correction of vector B global
-  double fVecBLoc[fgkMaxLocalPar];      // Vector B local (parameters) 
+  double fDiagCGlo[fgkMaxGloPC];        ///< Initial diagonal elements of C global matrix
+  double fVecBGlo[fgkMaxGloPC];         ///< Vector B global (parameters) 
+  double fVecBGloCorr[fgkMaxGlobalPar]; ///< Correction of vector B global
+  double fVecBLoc[fgkMaxLocalPar];      ///< Vector B local (parameters) 
 
-  double fInitPar[fgkMaxGlobalPar];    // Initial global parameters
-  double fDeltaPar[fgkMaxGlobalPar];   // Variation of global parameters 
-  double fSigmaPar[fgkMaxGlobalPar];   // Sigma of allowed variation of global parameter 
+  double fInitPar[fgkMaxGlobalPar];    ///< Initial global parameters
+  double fDeltaPar[fgkMaxGlobalPar];   ///< Variation of global parameters 
+  double fSigmaPar[fgkMaxGlobalPar];   ///< Sigma of allowed variation of global parameter 
 
-  double fLagMult[fgkMaxGloCsts];   // Lagrange multipliers of constrained equations
+  double fLagMult[fgkMaxGloCsts];   ///< Lagrange multipliers of constrained equations
 
-  Bool_t fIsNonLinear[fgkMaxGlobalPar]; // Flag for non linear parameters
-  int   fGlo2CGLRow[fgkMaxGlobalPar];   // Global parameter to row in "used" g*l matrix
-  int   fCGLRow2Glo[fgkMaxGlobalPar];   // Row in "used" g*l matrix to global parameter 
+  Bool_t fIsNonLinear[fgkMaxGlobalPar]; ///< Flag for non linear parameters
+  int   fGlo2CGLRow[fgkMaxGlobalPar];   ///< Global parameter to row in "used" g*l matrix
+  int   fCGLRow2Glo[fgkMaxGlobalPar];   ///< Row in "used" g*l matrix to global parameter 
 
-  TArrayI fIndexLocEq; // Table of parameter indexes in local equation 
-  TArrayD fDerivLocEq; // Table of local equation derivatives wrt. parameter 
-  TArrayI fIndexAllEqs; // Index in all loc. eq. storage for iterations
-  TArrayD fDerivAllEqs; // derivative in all loc. eq. storage for iterations
-  TArrayI fLocEqPlace;  // Loc. Eq. position in AllEqs storage
+  TArrayI fIndexLocEq;  ///< Table of parameter indexes in local equation 
+  TArrayD fDerivLocEq;  ///< Table of local equation derivatives wrt. parameter 
+  TArrayI fIndexAllEqs; ///< Index in all loc. eq. storage for iterations
+  TArrayD fDerivAllEqs; ///< derivative in all loc. eq. storage for iterations
+  TArrayI fLocEqPlace;  ///< Loc. Eq. position in AllEqs storage
 
-  Int_t fNIndexLocEq;   // Number of entries in fIndexLocEq
-  Int_t fNDerivLocEq;   // Number of entries in fDerivLocEq
-  Int_t fNIndexAllEqs;  // Number of entries in fIndexAllEqs
-  Int_t fNDerivAllEqs;  // Number of entries in fDerivAllEqs
-  Int_t fNLocEqPlace;   // Number of entries in fLocEqPlace
+  Int_t fNIndexLocEq;   ///< Number of entries in fIndexLocEq
+  Int_t fNDerivLocEq;   ///< Number of entries in fDerivLocEq
+  Int_t fNIndexAllEqs;  ///< Number of entries in fIndexAllEqs
+  Int_t fNDerivAllEqs;  ///< Number of entries in fDerivAllEqs
+  Int_t fNLocEqPlace;   ///< Number of entries in fLocEqPlace
   
 
-  int    fNLocalEquations;       // Number of local equations 
-  double fResCutInit;            // Cut in residual for first iterartion
-  double fResCut;                // Cut in residual for other iterartiona
-
-  double fChi2CutFactor;         // Cut factor for chi2 cut to accept local fit 
-  double fChi2CutRef;            // Reference cut for chi2 cut to accept local fit 
-
-  int fIter;                   // Current iteration
-  int fMaxIter;                // Maximum number of iterations
-  int fNStdDev;                // Number of standard deviations for chi2 cut 
-  int fNGlobalConstraints;     // Number of constraint equations
-  int fNLocalFits;             // Number of local fits
-  int fNLocalFitsRejected;     // Number of local fits rejected
-  int fNGlobalPar;             // Number of global parameters
-  int fNLocalPar;              // Number of local parameters
+  int    fNLocalEquations;       ///< Number of local equations 
+  double fResCutInit;            ///< Cut in residual for first iterartion
+  double fResCut;                ///< Cut in residual for other iterartiona
+
+  double fChi2CutFactor;         ///< Cut factor for chi2 cut to accept local fit 
+  double fChi2CutRef;            ///< Reference cut for chi2 cut to accept local fit 
+
+  int fIter;                   ///< Current iteration
+  int fMaxIter;                ///< Maximum number of iterations
+  int fNStdDev;                ///< Number of standard deviations for chi2 cut 
+  int fNGlobalConstraints;     ///< Number of constraint equations
+  int fNLocalFits;             ///< Number of local fits
+  int fNLocalFitsRejected;     ///< Number of local fits rejected
+  int fNGlobalPar;             ///< Number of global parameters
+  int fNLocalPar;              ///< Number of local parameters
 
   ClassDef(AliMillepede, 0)  // Millepede Class
 };