ROOT logo
// @(#)root/mathcore:$Id: Chi2FCN.h 37232 2010-12-03 18:09:43Z moneta $
// Author: L. Moneta Tue Sep  5 09:13:32 2006

/**********************************************************************
 *                                                                    *
 * Copyright (c) 2006  LCG ROOT Math Team, CERN/PH-SFT                *
 *                                                                    *
 *                                                                    *
 **********************************************************************/

// Header file for class Chi2FCN

#ifndef ROOT_Fit_Chi2FCN
#define ROOT_Fit_Chi2FCN

#ifndef ROOT_Math_FitMethodFunction
#include "Math/FitMethodFunction.h"
#endif

#ifndef ROOT_Math_IParamFunction
#include "Math/IParamFunction.h"
#endif


#ifndef ROOT_Fit_BinData
#include "Fit/BinData.h"
#endif


#ifndef ROOT_Fit_FitUtil
#include "Fit/FitUtil.h"
#endif

//#define ROOT_FIT_PARALLEL

#ifdef ROOT_FIT_PARALLEL
#ifndef ROOT_Fit_FitUtilParallel
#include "Fit/FitUtilParallel.h"
#endif
#endif

/** 
@defgroup FitMethodFunc Fit Method Classes 

Classes describing Fit Method functions
@ingroup Fit
*/


namespace ROOT { 


   namespace Fit { 


template<class FunType> 
struct ModelFunctionTrait { 
   typedef  ::ROOT::Math::IParamMultiFunction ModelFunc;
};
template<>      
struct ModelFunctionTrait<ROOT::Math::IMultiGradFunction>  { 
   typedef  ::ROOT::Math::IParamMultiGradFunction ModelFunc;
};



//___________________________________________________________________________________
/** 
   Chi2FCN class for binnned fits using the least square methods 

   @ingroup  FitMethodFunc   
*/ 
template<class FunType> 
class Chi2FCN : public ::ROOT::Math::BasicFitMethodFunction<FunType> {

public: 



   typedef  ::ROOT::Math::BasicFitMethodFunction<FunType> BaseObjFunction; 
   typedef typename  BaseObjFunction::BaseFunction BaseFunction; 

   typedef  typename ModelFunctionTrait<FunType>::ModelFunc IModelFunction;
   typedef typename BaseObjFunction::Type_t Type_t;

   /** 
      Constructor from data set (binned ) and model function 
   */ 
   Chi2FCN (const BinData & data, const IModelFunction & func) : 
      BaseObjFunction(func.NPar(), data.Size() ),
      fData(data), 
      fFunc(func), 
      fNEffPoints(0),
      fGrad ( std::vector<double> ( func.NPar() ) )
   { }

   /** 
      Destructor (no operations)
   */ 
   virtual ~Chi2FCN ()  {}

#ifdef LATER
private:

   // usually copying is non trivial, so we make this unaccessible

   /** 
      Copy constructor
   */ 
   Chi2FCN(const Chi2FCN &); 

   /** 
      Assignment operator
   */ 
   Chi2FCN & operator = (const Chi2FCN & rhs); 

#endif
public: 

   virtual BaseFunction * Clone() const { 
      // clone the function
      Chi2FCN * fcn =  new Chi2FCN(fData,fFunc); 
      return fcn; 
   }
 


   using BaseObjFunction::operator();


   // effective points used in the fit (exclude the rejected one)
   virtual unsigned int NFitPoints() const { return fNEffPoints; }


   /// i-th chi-square residual  
   virtual double DataElement(const double * x, unsigned int i, double * g) const { 
      if (i==0) this->UpdateNCalls();
      return FitUtil::EvaluateChi2Residual(fFunc, fData, x, i, g); 
   }

   // need to be virtual to be instantited
   virtual void Gradient(const double *x, double *g) const { 
      // evaluate the chi2 gradient
      FitUtil::EvaluateChi2Gradient(fFunc, fData, x, g, fNEffPoints);
   }

   /// get type of fit method function
   virtual  typename BaseObjFunction::Type_t Type() const { return BaseObjFunction::kLeastSquare; }

   /// access to const reference to the data 
   virtual const BinData & Data() const { return fData; }

   /// access to const reference to the model function
   virtual const IModelFunction & ModelFunction() const { return fFunc; }



protected: 


   /// set number of fit points (need to be called in const methods, make it const) 
   virtual void SetNFitPoints(unsigned int n) const { fNEffPoints = n; }

private: 

   /**
      Evaluation of the  function (required by interface)
    */
   virtual double DoEval (const double * x) const { 
      this->UpdateNCalls();
#ifdef ROOT_FIT_PARALLEL
      return FitUtilParallel::EvaluateChi2(fFunc, fData, x, fNEffPoints); 
#else 
      if (!fData.HaveCoordErrors() ) 
         return FitUtil::EvaluateChi2(fFunc, fData, x, fNEffPoints); 
      else 
         return FitUtil::EvaluateChi2Effective(fFunc, fData, x, fNEffPoints); 
#endif
   } 

   // for derivatives 
   virtual double  DoDerivative(const double * x, unsigned int icoord ) const { 
      Gradient(x, &fGrad[0]); 
      return fGrad[icoord]; 
   }

   const BinData & fData; 
   const IModelFunction & fFunc; 

   mutable unsigned int fNEffPoints;  // number of effective points used in the fit 

   mutable std::vector<double> fGrad; // for derivatives


}; 

      // define useful typedef's
      typedef Chi2FCN<ROOT::Math::IMultiGenFunction> Chi2Function; 
      typedef Chi2FCN<ROOT::Math::IMultiGradFunction> Chi2GradFunction; 


   } // end namespace Fit

} // end namespace ROOT


#endif /* ROOT_Fit_Chi2FCN */
 Chi2FCN.h:1
 Chi2FCN.h:2
 Chi2FCN.h:3
 Chi2FCN.h:4
 Chi2FCN.h:5
 Chi2FCN.h:6
 Chi2FCN.h:7
 Chi2FCN.h:8
 Chi2FCN.h:9
 Chi2FCN.h:10
 Chi2FCN.h:11
 Chi2FCN.h:12
 Chi2FCN.h:13
 Chi2FCN.h:14
 Chi2FCN.h:15
 Chi2FCN.h:16
 Chi2FCN.h:17
 Chi2FCN.h:18
 Chi2FCN.h:19
 Chi2FCN.h:20
 Chi2FCN.h:21
 Chi2FCN.h:22
 Chi2FCN.h:23
 Chi2FCN.h:24
 Chi2FCN.h:25
 Chi2FCN.h:26
 Chi2FCN.h:27
 Chi2FCN.h:28
 Chi2FCN.h:29
 Chi2FCN.h:30
 Chi2FCN.h:31
 Chi2FCN.h:32
 Chi2FCN.h:33
 Chi2FCN.h:34
 Chi2FCN.h:35
 Chi2FCN.h:36
 Chi2FCN.h:37
 Chi2FCN.h:38
 Chi2FCN.h:39
 Chi2FCN.h:40
 Chi2FCN.h:41
 Chi2FCN.h:42
 Chi2FCN.h:43
 Chi2FCN.h:44
 Chi2FCN.h:45
 Chi2FCN.h:46
 Chi2FCN.h:47
 Chi2FCN.h:48
 Chi2FCN.h:49
 Chi2FCN.h:50
 Chi2FCN.h:51
 Chi2FCN.h:52
 Chi2FCN.h:53
 Chi2FCN.h:54
 Chi2FCN.h:55
 Chi2FCN.h:56
 Chi2FCN.h:57
 Chi2FCN.h:58
 Chi2FCN.h:59
 Chi2FCN.h:60
 Chi2FCN.h:61
 Chi2FCN.h:62
 Chi2FCN.h:63
 Chi2FCN.h:64
 Chi2FCN.h:65
 Chi2FCN.h:66
 Chi2FCN.h:67
 Chi2FCN.h:68
 Chi2FCN.h:69
 Chi2FCN.h:70
 Chi2FCN.h:71
 Chi2FCN.h:72
 Chi2FCN.h:73
 Chi2FCN.h:74
 Chi2FCN.h:75
 Chi2FCN.h:76
 Chi2FCN.h:77
 Chi2FCN.h:78
 Chi2FCN.h:79
 Chi2FCN.h:80
 Chi2FCN.h:81
 Chi2FCN.h:82
 Chi2FCN.h:83
 Chi2FCN.h:84
 Chi2FCN.h:85
 Chi2FCN.h:86
 Chi2FCN.h:87
 Chi2FCN.h:88
 Chi2FCN.h:89
 Chi2FCN.h:90
 Chi2FCN.h:91
 Chi2FCN.h:92
 Chi2FCN.h:93
 Chi2FCN.h:94
 Chi2FCN.h:95
 Chi2FCN.h:96
 Chi2FCN.h:97
 Chi2FCN.h:98
 Chi2FCN.h:99
 Chi2FCN.h:100
 Chi2FCN.h:101
 Chi2FCN.h:102
 Chi2FCN.h:103
 Chi2FCN.h:104
 Chi2FCN.h:105
 Chi2FCN.h:106
 Chi2FCN.h:107
 Chi2FCN.h:108
 Chi2FCN.h:109
 Chi2FCN.h:110
 Chi2FCN.h:111
 Chi2FCN.h:112
 Chi2FCN.h:113
 Chi2FCN.h:114
 Chi2FCN.h:115
 Chi2FCN.h:116
 Chi2FCN.h:117
 Chi2FCN.h:118
 Chi2FCN.h:119
 Chi2FCN.h:120
 Chi2FCN.h:121
 Chi2FCN.h:122
 Chi2FCN.h:123
 Chi2FCN.h:124
 Chi2FCN.h:125
 Chi2FCN.h:126
 Chi2FCN.h:127
 Chi2FCN.h:128
 Chi2FCN.h:129
 Chi2FCN.h:130
 Chi2FCN.h:131
 Chi2FCN.h:132
 Chi2FCN.h:133
 Chi2FCN.h:134
 Chi2FCN.h:135
 Chi2FCN.h:136
 Chi2FCN.h:137
 Chi2FCN.h:138
 Chi2FCN.h:139
 Chi2FCN.h:140
 Chi2FCN.h:141
 Chi2FCN.h:142
 Chi2FCN.h:143
 Chi2FCN.h:144
 Chi2FCN.h:145
 Chi2FCN.h:146
 Chi2FCN.h:147
 Chi2FCN.h:148
 Chi2FCN.h:149
 Chi2FCN.h:150
 Chi2FCN.h:151
 Chi2FCN.h:152
 Chi2FCN.h:153
 Chi2FCN.h:154
 Chi2FCN.h:155
 Chi2FCN.h:156
 Chi2FCN.h:157
 Chi2FCN.h:158
 Chi2FCN.h:159
 Chi2FCN.h:160
 Chi2FCN.h:161
 Chi2FCN.h:162
 Chi2FCN.h:163
 Chi2FCN.h:164
 Chi2FCN.h:165
 Chi2FCN.h:166
 Chi2FCN.h:167
 Chi2FCN.h:168
 Chi2FCN.h:169
 Chi2FCN.h:170
 Chi2FCN.h:171
 Chi2FCN.h:172
 Chi2FCN.h:173
 Chi2FCN.h:174
 Chi2FCN.h:175
 Chi2FCN.h:176
 Chi2FCN.h:177
 Chi2FCN.h:178
 Chi2FCN.h:179
 Chi2FCN.h:180
 Chi2FCN.h:181
 Chi2FCN.h:182
 Chi2FCN.h:183
 Chi2FCN.h:184
 Chi2FCN.h:185
 Chi2FCN.h:186
 Chi2FCN.h:187
 Chi2FCN.h:188
 Chi2FCN.h:189
 Chi2FCN.h:190
 Chi2FCN.h:191
 Chi2FCN.h:192
 Chi2FCN.h:193
 Chi2FCN.h:194
 Chi2FCN.h:195
 Chi2FCN.h:196
 Chi2FCN.h:197
 Chi2FCN.h:198
 Chi2FCN.h:199
 Chi2FCN.h:200
 Chi2FCN.h:201
 Chi2FCN.h:202
 Chi2FCN.h:203
 Chi2FCN.h:204
 Chi2FCN.h:205
 Chi2FCN.h:206
 Chi2FCN.h:207