/usr/include/root/Math/FitMethodFunction.h is in libroot-math-mathcore-dev 5.34.19+dfsg-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | // @(#)root/mathcore:$Id$
// Author: L. Moneta Thu Aug 16 15:40:28 2007
/**********************************************************************
* *
* Copyright (c) 2007 LCG ROOT Math Team, CERN/PH-SFT *
* *
* *
**********************************************************************/
// Header file for class FitMethodFunction
#ifndef ROOT_Math_FitMethodFunction
#define ROOT_Math_FitMethodFunction
#ifndef ROOT_Math_IFunction
#include "Math/IFunction.h"
#endif
// #ifndef ROOT_Math_IParamFunctionfwd
// #include "Math/IParamFunctionfwd.h"
// #endif
namespace ROOT {
namespace Math {
//______________________________________________________________________________________
/**
FitMethodFunction class
Interface for objective functions (like chi2 and likelihood used in the fit)
In addition to normal function interface provide interface for calculating each
data contrinution to the function which is required by some algorithm (like Fumili)
@ingroup FitMethodFunc
*/
template<class FunctionType>
class BasicFitMethodFunction : public FunctionType {
public:
typedef typename FunctionType::BaseFunc BaseFunction;
/// enumeration specyfing the possible fit method types
enum Type_t { kUndefined , kLeastSquare, kLogLikelihood };
BasicFitMethodFunction(int dim, int npoint) :
fNDim(dim),
fNPoints(npoint),
fNCalls(0)
{}
/**
Virtual Destructor (no operations)
*/
virtual ~BasicFitMethodFunction () {}
/**
Number of dimension (parameters) . From IGenMultiFunction interface
*/
virtual unsigned int NDim() const { return fNDim; }
/**
method returning the data i-th contribution to the fit objective function
For example the residual for the least square functions or the pdf element for the
likelihood functions.
Estimating eventually also the gradient of the data element if the passed pointer is not null
*/
virtual double DataElement(const double *x, unsigned int i, double *g = 0) const = 0;
/**
return the number of data points used in evaluating the function
*/
virtual unsigned int NPoints() const { return fNPoints; }
/**
return the type of method, override if needed
*/
virtual Type_t Type() const { return kUndefined; }
/**
return the total number of function calls (overrided if needed)
*/
virtual unsigned int NCalls() const { return fNCalls; }
/**
update number of calls
*/
virtual void UpdateNCalls() const { fNCalls++; }
/**
reset number of function calls
*/
virtual void ResetNCalls() { fNCalls = 0; }
public:
protected:
private:
unsigned int fNDim; // function dimension
unsigned int fNPoints; // size of the data
mutable unsigned int fNCalls; // number of function calls
};
// define the normal and gradient function
typedef BasicFitMethodFunction<ROOT::Math::IMultiGenFunction> FitMethodFunction;
typedef BasicFitMethodFunction<ROOT::Math::IMultiGradFunction> FitMethodGradFunction;
// useful template definition to use these interface in
// generic programming
// (comment them out since they are not used anymore)
/*
template<class FunType>
struct ParamFunctionTrait {
typedef IParamMultiFunction PFType;
};
// specialization for the gradient param functions
template<>
struct ParamFunctionTrait<ROOT::Math::IMultiGradFunction> {
typedef IParamMultiGradFunction PFType;
};
*/
} // end namespace Math
} // end namespace ROOT
#endif /* ROOT_Math_FitMethodFunction */
|