ROOT  6.06/09
Reference Guide
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROOT::Fit::LogLikelihoodFCN< FunType > Class Template Reference

template<class FunType>
class ROOT::Fit::LogLikelihoodFCN< FunType >

LogLikelihoodFCN class for likelihood fits.

it is template to distinguish gradient and non-gradient case

Definition at line 55 of file LogLikelihoodFCN.h.

Public Types

typedef BasicFCN< FunType, UnBinDataBaseFCN
 
typedef ::ROOT::Math::BasicFitMethodFunction< FunType > BaseObjFunction
 
typedef BaseObjFunction::BaseFunction BaseFunction
 
typedef ::ROOT::Math::IParamMultiFunction IModelFunction
 
- Public Types inherited from ROOT::Math::BasicFitMethodFunction< FunType >
enum  Type_t
 enumeration specyfing the possible fit method types More...
 
typedef FunType::BaseFunc BaseFunction
 

Public Member Functions

 LogLikelihoodFCN (const std::shared_ptr< UnBinData > &data, const std::shared_ptr< IModelFunction > &func, int weight=0, bool extended=false)
 Constructor from unbin data set and model function (pdf) More...
 
 LogLikelihoodFCN (const UnBinData &data, const IModelFunction &func, int weight=0, bool extended=false)
 Constructor from unbin data set and model function (pdf) for object managed by users. More...
 
virtual ~LogLikelihoodFCN ()
 Destructor (no operations) More...
 
 LogLikelihoodFCN (const LogLikelihoodFCN &f)
 Copy constructor. More...
 
LogLikelihoodFCNoperator= (const LogLikelihoodFCN &rhs)
 Assignment operator. More...
 
virtual BaseFunctionClone () const
 clone the function (need to return Base for Windows) More...
 
virtual unsigned int NFitPoints () const
 
virtual double DataElement (const double *x, unsigned int i, double *g) const
 i-th likelihood contribution and its gradient More...
 
virtual void Gradient (const double *x, double *g) const
 
virtual BaseObjFunction::Type_t Type () const
 get type of fit method function More...
 
void UseSumOfWeightSquare (bool on=true)
 
- Public Member Functions inherited from ROOT::Fit::BasicFCN< FunType, UnBinData >
virtual const UnBinDataData () const
 access to const reference to the data More...
 
std::shared_ptr< UnBinDataDataPtr () const
 access to data pointer More...
 
virtual const IModelFunctionModelFunction () const
 access to const reference to the model function More...
 
std::shared_ptr< IModelFunctionModelFunctionPtr () const
 access to function pointer More...
 
- Public Member Functions inherited from ROOT::Math::BasicFitMethodFunction< FunType >
 BasicFitMethodFunction (int dim, int npoint)
 
virtual ~BasicFitMethodFunction ()
 Virtual Destructor (no operations) More...
 
virtual unsigned int NDim () const
 Number of dimension (parameters) . More...
 
virtual unsigned int NPoints () const
 return the number of data points used in evaluating the function More...
 
virtual unsigned int NCalls () const
 return the total number of function calls (overrided if needed) More...
 
virtual void UpdateNCalls () const
 update number of calls More...
 
virtual void ResetNCalls ()
 reset number of function calls More...
 

Private Member Functions

virtual double DoEval (const double *x) const
 Evaluation of the function (required by interface) More...
 
virtual double DoDerivative (const double *x, unsigned int icoord) const
 

Private Attributes

bool fIsExtended
 
int fWeight
 
unsigned int fNEffPoints
 
std::vector< doublefGrad
 

Additional Inherited Members

- Protected Types inherited from ROOT::Fit::BasicFCN< FunType, UnBinData >
typedef ::ROOT::Math::BasicFitMethodFunction< FunType > BaseObjFunction
 
typedef BaseObjFunction::BaseFunction BaseFunction
 
typedef ::ROOT::Math::IParamMultiFunction IModelFunction
 
- Protected Member Functions inherited from ROOT::Fit::BasicFCN< FunType, UnBinData >
 BasicFCN (const std::shared_ptr< UnBinData > &data, const std::shared_ptr< IModelFunction > &func)
 Constructor from data set and model function. More...
 
virtual ~BasicFCN ()
 Destructor (no operations) More...
 
void SetData (const std::shared_ptr< UnBinData > &data)
 Set the data pointer. More...
 
void SetModelFunction (const std::shared_ptr< IModelFunction > &func)
 Set the function pointer. More...
 
- Protected Attributes inherited from ROOT::Fit::BasicFCN< FunType, UnBinData >
std::shared_ptr< UnBinDatafData
 
std::shared_ptr< IModelFunctionfFunc
 

#include <Fit/LogLikelihoodFCN.h>

+ Inheritance diagram for ROOT::Fit::LogLikelihoodFCN< FunType >:
+ Collaboration diagram for ROOT::Fit::LogLikelihoodFCN< FunType >:

Member Typedef Documentation

template<class FunType>
typedef BasicFCN<FunType,UnBinData> ROOT::Fit::LogLikelihoodFCN< FunType >::BaseFCN

Definition at line 59 of file LogLikelihoodFCN.h.

template<class FunType>
typedef BaseObjFunction::BaseFunction ROOT::Fit::LogLikelihoodFCN< FunType >::BaseFunction

Definition at line 62 of file LogLikelihoodFCN.h.

template<class FunType>
typedef ::ROOT::Math::BasicFitMethodFunction<FunType> ROOT::Fit::LogLikelihoodFCN< FunType >::BaseObjFunction

Definition at line 61 of file LogLikelihoodFCN.h.

template<class FunType>
typedef ::ROOT::Math::IParamMultiFunction ROOT::Fit::LogLikelihoodFCN< FunType >::IModelFunction

Definition at line 64 of file LogLikelihoodFCN.h.

Constructor & Destructor Documentation

template<class FunType>
ROOT::Fit::LogLikelihoodFCN< FunType >::LogLikelihoodFCN ( const std::shared_ptr< UnBinData > &  data,
const std::shared_ptr< IModelFunction > &  func,
int  weight = 0,
bool  extended = false 
)
inline

Constructor from unbin data set and model function (pdf)

Definition at line 70 of file LogLikelihoodFCN.h.

Referenced by ROOT::Fit::LogLikelihoodFCN< FunType >::Clone().

template<class FunType>
ROOT::Fit::LogLikelihoodFCN< FunType >::LogLikelihoodFCN ( const UnBinData data,
const IModelFunction func,
int  weight = 0,
bool  extended = false 
)
inline

Constructor from unbin data set and model function (pdf) for object managed by users.

Definition at line 81 of file LogLikelihoodFCN.h.

template<class FunType>
virtual ROOT::Fit::LogLikelihoodFCN< FunType >::~LogLikelihoodFCN ( )
inlinevirtual

Destructor (no operations)

Definition at line 92 of file LogLikelihoodFCN.h.

template<class FunType>
ROOT::Fit::LogLikelihoodFCN< FunType >::LogLikelihoodFCN ( const LogLikelihoodFCN< FunType > &  f)
inline

Copy constructor.

Definition at line 97 of file LogLikelihoodFCN.h.

Member Function Documentation

template<class FunType>
virtual BaseFunction* ROOT::Fit::LogLikelihoodFCN< FunType >::Clone ( ) const
inlinevirtual

clone the function (need to return Base for Windows)

Definition at line 120 of file LogLikelihoodFCN.h.

template<class FunType>
virtual double ROOT::Fit::LogLikelihoodFCN< FunType >::DataElement ( const double x,
unsigned int  i,
double g 
) const
inlinevirtual

i-th likelihood contribution and its gradient

Implements ROOT::Math::BasicFitMethodFunction< FunType >.

Definition at line 129 of file LogLikelihoodFCN.h.

template<class FunType>
virtual double ROOT::Fit::LogLikelihoodFCN< FunType >::DoDerivative ( const double x,
unsigned int  icoord 
) const
inlineprivatevirtual

Definition at line 174 of file LogLikelihoodFCN.h.

template<class FunType>
virtual double ROOT::Fit::LogLikelihoodFCN< FunType >::DoEval ( const double x) const
inlineprivatevirtual

Evaluation of the function (required by interface)

Definition at line 163 of file LogLikelihoodFCN.h.

template<class FunType>
virtual void ROOT::Fit::LogLikelihoodFCN< FunType >::Gradient ( const double x,
double g 
) const
inlinevirtual
template<class FunType>
virtual unsigned int ROOT::Fit::LogLikelihoodFCN< FunType >::NFitPoints ( ) const
inlinevirtual

Definition at line 126 of file LogLikelihoodFCN.h.

template<class FunType>
LogLikelihoodFCN& ROOT::Fit::LogLikelihoodFCN< FunType >::operator= ( const LogLikelihoodFCN< FunType > &  rhs)
inline

Assignment operator.

Definition at line 109 of file LogLikelihoodFCN.h.

template<class FunType>
virtual BaseObjFunction::Type_t ROOT::Fit::LogLikelihoodFCN< FunType >::Type ( ) const
inlinevirtual

get type of fit method function

Reimplemented from ROOT::Math::BasicFitMethodFunction< FunType >.

Definition at line 142 of file LogLikelihoodFCN.h.

Referenced by ROOT::Fit::Fitter::DoUnbinnedLikelihoodFit().

template<class FunType>
void ROOT::Fit::LogLikelihoodFCN< FunType >::UseSumOfWeightSquare ( bool  on = true)
inline

Definition at line 147 of file LogLikelihoodFCN.h.

Referenced by ROOT::Fit::Fitter::DoUnbinnedLikelihoodFit().

Member Data Documentation

template<class FunType>
std::vector<double> ROOT::Fit::LogLikelihoodFCN< FunType >::fGrad
mutableprivate
template<class FunType>
bool ROOT::Fit::LogLikelihoodFCN< FunType >::fIsExtended
private
template<class FunType>
unsigned int ROOT::Fit::LogLikelihoodFCN< FunType >::fNEffPoints
mutableprivate
template<class FunType>
int ROOT::Fit::LogLikelihoodFCN< FunType >::fWeight
private

The documentation for this class was generated from the following file: