ROOT::Fit::BasicFCN< FunType, DataType > Class Template Reference

template<class FunType, class DataType>
class ROOT::Fit::BasicFCN< FunType, DataType >

BasicFCN class: base class for the objective functions used in the fits It has a reference to the data and th emodel function used in the fit.

It cannot be instantiated but constructed from the derived classes

Definition at line 43 of file BasicFCN.h.

Public Member Functions
virtual const DataType &	Data () const
	access to const reference to the data More...
std::shared_ptr< DataType >	DataPtr () const
	access to data pointer More...
virtual const IModelFunction &	ModelFunction () const
	access to const reference to the model function More...
std::shared_ptr< IModelFunction >	ModelFunctionPtr () 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 double	DataElement (const double *x, unsigned int i, double *g=0) const =0
	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. More...
virtual unsigned int	NPoints () const
	return the number of data points used in evaluating the function More...
virtual Type_t	Type () const
	return the type of method, override if needed 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...

Protected Types
typedef ::ROOT::Math::BasicFitMethodFunction< FunType >	BaseObjFunction
typedef BaseObjFunction::BaseFunction	BaseFunction
typedef ::ROOT::Math::IParamMultiFunction	IModelFunction

Protected Member Functions
	BasicFCN (const std::shared_ptr< DataType > &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< DataType > &data)
	Set the data pointer. More...
void	SetModelFunction (const std::shared_ptr< IModelFunction > &func)
	Set the function pointer. More...

Protected Attributes
std::shared_ptr< DataType >	fData
std::shared_ptr< IModelFunction >	fFunc

Additional Inherited Members
Public Types inherited from ROOT::Math::BasicFitMethodFunction< FunType >
enum	Type_t
	enumeration specyfing the possible fit method types More...
typedef FunType::BaseFunc	BaseFunction

#include <Fit/BasicFCN.h>

Inheritance diagram for ROOT::Fit::BasicFCN< FunType, DataType >:

Collaboration diagram for ROOT::Fit::BasicFCN< FunType, DataType >:

Member Typedef Documentation

template<class FunType, class DataType>

typedef BaseObjFunction::BaseFunction ROOT::Fit::BasicFCN< FunType, DataType >::BaseFunction

protected

Definition at line 49 of file BasicFCN.h.

template<class FunType, class DataType>

typedef ::ROOT::Math::BasicFitMethodFunction<FunType> ROOT::Fit::BasicFCN< FunType, DataType >::BaseObjFunction

protected

Definition at line 48 of file BasicFCN.h.

template<class FunType, class DataType>

typedef ::ROOT::Math::IParamMultiFunction ROOT::Fit::BasicFCN< FunType, DataType >::IModelFunction

protected

Definition at line 51 of file BasicFCN.h.

Constructor & Destructor Documentation

template<class FunType, class DataType>

ROOT::Fit::BasicFCN< FunType, DataType >::BasicFCN ( const std::shared_ptr< DataType > &  data, const std::shared_ptr< IModelFunction > &  func  )

inlineprotected

Constructor from data set and model function.

Definition at line 56 of file BasicFCN.h.

template<class FunType, class DataType>

virtual ROOT::Fit::BasicFCN< FunType, DataType >::~BasicFCN ( )

inlineprotectedvirtual

Destructor (no operations)

Definition at line 67 of file BasicFCN.h.

Member Function Documentation

template<class FunType, class DataType>

virtual const DataType& ROOT::Fit::BasicFCN< FunType, DataType >::Data ( ) const

inlinevirtual

access to const reference to the data

Definition at line 73 of file BasicFCN.h.

template<class FunType, class DataType>

std::shared_ptr<DataType> ROOT::Fit::BasicFCN< FunType, DataType >::DataPtr ( ) const

inline

access to data pointer

Definition at line 76 of file BasicFCN.h.

Referenced by ROOT::Fit::LogLikelihoodFCN< FunType >::operator=(), ROOT::Fit::PoissonLikelihoodFCN< FunType >::operator=(), and ROOT::Fit::Chi2FCN< FunType >::operator=().

template<class FunType, class DataType>

virtual const IModelFunction& ROOT::Fit::BasicFCN< FunType, DataType >::ModelFunction ( ) const

inlinevirtual

access to const reference to the model function

Definition at line 79 of file BasicFCN.h.

template<class FunType, class DataType>

std::shared_ptr<IModelFunction> ROOT::Fit::BasicFCN< FunType, DataType >::ModelFunctionPtr ( ) const

inline

access to function pointer

Definition at line 82 of file BasicFCN.h.

Referenced by ROOT::Fit::LogLikelihoodFCN< FunType >::operator=(), ROOT::Fit::PoissonLikelihoodFCN< FunType >::operator=(), and ROOT::Fit::Chi2FCN< FunType >::operator=().

template<class FunType, class DataType>

void ROOT::Fit::BasicFCN< FunType, DataType >::SetData ( const std::shared_ptr< DataType > &  data )

inlineprotected

Set the data pointer.

Definition at line 90 of file BasicFCN.h.

template<class FunType, class DataType>

void ROOT::Fit::BasicFCN< FunType, DataType >::SetModelFunction ( const std::shared_ptr< IModelFunction > &  func )

inlineprotected

Set the function pointer.

Definition at line 93 of file BasicFCN.h.

Member Data Documentation

template<class FunType, class DataType>

std::shared_ptr<DataType> ROOT::Fit::BasicFCN< FunType, DataType >::fData

protected

Definition at line 96 of file BasicFCN.h.

Referenced by ROOT::Fit::BasicFCN< FunType, BinData >::Data(), ROOT::Fit::BasicFCN< FunType, BinData >::DataPtr(), and ROOT::Fit::BasicFCN< FunType, BinData >::SetData().

template<class FunType, class DataType>

std::shared_ptr<IModelFunction> ROOT::Fit::BasicFCN< FunType, DataType >::fFunc

protected

Definition at line 97 of file BasicFCN.h.

Referenced by ROOT::Fit::BasicFCN< FunType, BinData >::ModelFunction(), ROOT::Fit::BasicFCN< FunType, BinData >::ModelFunctionPtr(), and ROOT::Fit::BasicFCN< FunType, BinData >::SetModelFunction().

---

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

• math/mathcore/inc/Fit/BasicFCN.h