ROOT logo
// @(#)root/mathcore:$Id: LogLikelihoodFCN.h 28946 2009-06-11 15:39:14Z moneta $
// Author: L. Moneta Fri Aug 17 14:29:24 2007

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

// Header file for class LogLikelihoodFCN

#ifndef ROOT_Fit_LogLikelihoodFCN
#define ROOT_Fit_LogLikelihoodFCN

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

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

#ifndef ROOT_Fit_UnBinData
#include "Fit/UnBinData.h"
#endif

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

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

namespace ROOT { 

   namespace Fit { 


//___________________________________________________________________________________
/** 
   LogLikelihoodFCN class 
   for likelihood fits 

   it is template to distinguish gradient and non-gradient case

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

public: 



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

   typedef  ::ROOT::Math::IParamMultiFunction IModelFunction;


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

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

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

   /** 
      Dummy Copy constructor (private)
   */ 
   LogLikelihoodFCN(const LogLikelihoodFCN &) {} 

   /** 
      Dummy Assignment operator (private)
   */ 
   LogLikelihoodFCN & operator = (const LogLikelihoodFCN & rhs) { 
      return *this;
   } 

public: 

   /// clone the function (need to return Base for Windows)
   virtual BaseFunction * Clone() const { return  new LogLikelihoodFCN(fData,fFunc); }


   //using BaseObjFunction::operator();

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

   /// i-th likelihood contribution and its gradient
   virtual double DataElement(const double * x, unsigned int i, double * g) const { 
      return FitUtil::EvaluatePdf(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::EvaluateLogLGradient(fFunc, fData, x, g, fNEffPoints);
   }

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

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

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


protected: 


private:

   /**
      Evaluation of the  function (required by interface)
    */
   virtual double DoEval (const double * x) const { 
      this->UpdateNCalls();

#ifdef ROOT_FIT_PARALLEL
      return FitUtilParallel::EvaluateLogL(fFunc, fData, x, fNEffPoints); 
#else 
      return FitUtil::EvaluateLogL(fFunc, fData, x, fNEffPoints); 
#endif
   } 

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

 
      //data member

   const UnBinData & fData; 
   mutable 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 LogLikelihoodFCN<ROOT::Math::IMultiGenFunction>  LogLikelihoodFunction; 
      typedef LogLikelihoodFCN<ROOT::Math::IMultiGradFunction> LogLikelihoodGradFunction; 

   } // end namespace Fit

} // end namespace ROOT


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