Logo ROOT   6.08/07
Reference Guide
List of all members | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROOT::Fit::PoissonLikelihoodFCN< FunType > Class Template Reference

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

class evaluating the log likelihood for binned Poisson likelihood fits it is template to distinguish gradient and non-gradient case

Definition at line 56 of file PoissonLikelihoodFCN.h.

Public Types

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

Public Member Functions

 PoissonLikelihoodFCN (const std::shared_ptr< BinData > &data, const std::shared_ptr< IModelFunction > &func, int weight=0, bool extended=true)
 Constructor from unbin data set and model function (pdf) More...
 
 PoissonLikelihoodFCN (const BinData &data, const IModelFunction &func, int weight=0, bool extended=true)
 Constructor from unbin data set and model function (pdf) managed by the users. More...
 
 PoissonLikelihoodFCN (const PoissonLikelihoodFCN &f)
 Copy constructor. More...
 
virtual ~PoissonLikelihoodFCN ()
 Destructor (no operations) More...
 
virtual BaseFunctionClone () const
 clone the function (need to return Base for Windows) More...
 
virtual double DataElement (const double *x, unsigned int i, double *g) const
 i-th likelihood element and its gradient More...
 
virtual void Gradient (const double *x, double *g) const
 evaluate gradient More...
 
bool IsWeighted () const
 
virtual unsigned int NFitPoints () const
 
PoissonLikelihoodFCNoperator= (const PoissonLikelihoodFCN &rhs)
 Assignment operator. More...
 
virtual BaseObjFunction::Type_t Type () const
 get type of fit method function More...
 
void UseSumOfWeights ()
 
void UseSumOfWeightSquare (bool on=true)
 
- Public Member Functions inherited from ROOT::Fit::BasicFCN< FunType, BinData >
virtual const BinDataData () const
 access to const reference to the data More...
 
std::shared_ptr< BinDataDataPtr () 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 NCalls () const
 return the total number of function calls (overrided if needed) 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 void ResetNCalls ()
 reset number of function calls More...
 
virtual void UpdateNCalls () const
 update number of calls More...
 

Private Member Functions

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

Private Attributes

std::vector< double > fGrad
 
bool fIsExtended
 
unsigned int fNEffPoints
 
int fWeight
 

Additional Inherited Members

- Protected Types inherited from ROOT::Fit::BasicFCN< FunType, BinData >
typedef BaseObjFunction::BaseFunction BaseFunction
 
typedef ::ROOT::Math::BasicFitMethodFunction< FunType > BaseObjFunction
 
typedef ::ROOT::Math::IParamMultiFunction IModelFunction
 
- Protected Member Functions inherited from ROOT::Fit::BasicFCN< FunType, BinData >
 BasicFCN (const std::shared_ptr< BinData > &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< BinData > &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, BinData >
std::shared_ptr< BinDatafData
 
std::shared_ptr< IModelFunctionfFunc
 

#include <Fit/PoissonLikelihoodFCN.h>

Inheritance diagram for ROOT::Fit::PoissonLikelihoodFCN< FunType >:
[legend]

Member Typedef Documentation

◆ BaseFCN

template<class FunType>
typedef BasicFCN<FunType,BinData> ROOT::Fit::PoissonLikelihoodFCN< FunType >::BaseFCN

Definition at line 60 of file PoissonLikelihoodFCN.h.

◆ BaseFunction

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

Definition at line 63 of file PoissonLikelihoodFCN.h.

◆ BaseObjFunction

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

Definition at line 62 of file PoissonLikelihoodFCN.h.

◆ IModelFunction

Definition at line 65 of file PoissonLikelihoodFCN.h.

Constructor & Destructor Documentation

◆ PoissonLikelihoodFCN() [1/3]

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

Constructor from unbin data set and model function (pdf)

Definition at line 71 of file PoissonLikelihoodFCN.h.

◆ PoissonLikelihoodFCN() [2/3]

template<class FunType>
ROOT::Fit::PoissonLikelihoodFCN< FunType >::PoissonLikelihoodFCN ( const BinData data,
const IModelFunction func,
int  weight = 0,
bool  extended = true 
)
inline

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

Definition at line 82 of file PoissonLikelihoodFCN.h.

◆ ~PoissonLikelihoodFCN()

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

Destructor (no operations)

Definition at line 94 of file PoissonLikelihoodFCN.h.

◆ PoissonLikelihoodFCN() [3/3]

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

Copy constructor.

Definition at line 99 of file PoissonLikelihoodFCN.h.

Member Function Documentation

◆ Clone()

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

clone the function (need to return Base for Windows)

Definition at line 121 of file PoissonLikelihoodFCN.h.

◆ DataElement()

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

i-th likelihood element and its gradient

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

Definition at line 127 of file PoissonLikelihoodFCN.h.

◆ DoDerivative()

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

Definition at line 172 of file PoissonLikelihoodFCN.h.

◆ DoEval()

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

Evaluation of the function (required by interface)

Definition at line 166 of file PoissonLikelihoodFCN.h.

◆ Gradient()

template<class FunType>
virtual void ROOT::Fit::PoissonLikelihoodFCN< FunType >::Gradient ( const double *  x,
double *  g 
) const
inlinevirtual

evaluate gradient

Definition at line 133 of file PoissonLikelihoodFCN.h.

◆ IsWeighted()

template<class FunType>
bool ROOT::Fit::PoissonLikelihoodFCN< FunType >::IsWeighted ( ) const
inline

Definition at line 141 of file PoissonLikelihoodFCN.h.

◆ NFitPoints()

template<class FunType>
virtual unsigned int ROOT::Fit::PoissonLikelihoodFCN< FunType >::NFitPoints ( ) const
inlinevirtual

Definition at line 124 of file PoissonLikelihoodFCN.h.

◆ operator=()

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

Assignment operator.

Definition at line 110 of file PoissonLikelihoodFCN.h.

◆ Type()

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

get type of fit method function

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

Definition at line 139 of file PoissonLikelihoodFCN.h.

◆ UseSumOfWeights()

template<class FunType>
void ROOT::Fit::PoissonLikelihoodFCN< FunType >::UseSumOfWeights ( )
inline

Definition at line 144 of file PoissonLikelihoodFCN.h.

◆ UseSumOfWeightSquare()

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

Definition at line 151 of file PoissonLikelihoodFCN.h.

Member Data Documentation

◆ fGrad

template<class FunType>
std::vector<double> ROOT::Fit::PoissonLikelihoodFCN< FunType >::fGrad
mutableprivate

Definition at line 185 of file PoissonLikelihoodFCN.h.

◆ fIsExtended

template<class FunType>
bool ROOT::Fit::PoissonLikelihoodFCN< FunType >::fIsExtended
private

Definition at line 180 of file PoissonLikelihoodFCN.h.

◆ fNEffPoints

template<class FunType>
unsigned int ROOT::Fit::PoissonLikelihoodFCN< FunType >::fNEffPoints
mutableprivate

Definition at line 183 of file PoissonLikelihoodFCN.h.

◆ fWeight

template<class FunType>
int ROOT::Fit::PoissonLikelihoodFCN< FunType >::fWeight
private

Definition at line 181 of file PoissonLikelihoodFCN.h.


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