 ROOT   Reference Guide ROOT::Math::LSResidualFunc Class Reference

LSResidualFunc class description.

Internal class used for accessing the residuals of the Least Square function and their derivates which are estimated numerically using GSL numerical derivation. The class contains a pointer to the fit method function and an index specifying the i-th residual and wraps it in a multi-dim gradient function interface ROOT::Math::IGradientFunctionMultiDim. The class is used by ROOT::Math::GSLNLSMinimizer (GSL non linear least square fitter)

Definition at line 63 of file GSLNLSMinimizer.h.

Public Member Functions

LSResidualFunc ()

LSResidualFunc (const LSResidualFunc &rhs)

LSResidualFunc (const ROOT::Math::FitMethodFunction &func, unsigned int i)

IMultiGenFunctionClone () const
Clone a function. More...

void FdF (const double *x, double &f, double *g) const

void Gradient (const double *x, double *g) const

unsigned int NDim () const
Retrieve the dimension of the function. More...

LSResidualFuncoperator= (const LSResidualFunc &rhs) Public Member Functions inherited from ROOT::Math::IGradientFunctionMultiDimTempl< T >
Virtual Destructor (no operations) More...

virtual void FdF (const T *x, T &f, T *df) const
Optimized method to evaluate at the same time the function value and derivative at a point x. More...

Evaluate all the vector of function derivatives (gradient) at a point x. More...

In some cases, the gradient algorithm will use information from the previous step, these can be passed in with this overload. More...

virtual unsigned int NDim () const=0
Retrieve the dimension of the function. More...

virtual bool returnsInMinuit2ParameterSpace () const Public Member Functions inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
IBaseFunctionMultiDimTempl ()

virtual ~IBaseFunctionMultiDimTempl ()
virtual destructor More...

virtual IBaseFunctionMultiDimTempl< T > * Clone () const =0
Clone a function. More...

virtual unsigned int NDim () const =0
Retrieve the dimension of the function. More...

operator() (const T *x) const
Evaluate the function at a point x[]. More... Public Member Functions inherited from ROOT::Math::IGradientMultiDimTempl< T >
virtual destructor More...

Derivative (const T *x, unsigned int icoord, T *previous_grad, T *previous_g2, T *previous_gstep) const
In some cases, the derivative algorithm will use information from the previous step, these can be passed in with this overload. More...

Derivative (const T *x, unsigned int icoord=0) const
Return the partial derivative with respect to the passed coordinate. More...

virtual void FdF (const T *x, T &f, T *df) const =0
Optimized method to evaluate at the same time the function value and derivative at a point x. More...

Evaluate all the vector of function derivatives (gradient) at a point x. More...

Private Member Functions

double DoDerivative (const double *x, unsigned int icoord) const

double DoEval (const double *x) const

Private Attributes

const ROOT::Math::FitMethodFunctionfChi2

unsigned int fIndex

std::vector< doublefX2 Public Types inherited from ROOT::Math::IGradientFunctionMultiDimTempl< T >
typedef IBaseFunctionMultiDimTempl< T > BaseFunc Public Types inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
typedef T BackendType

typedef IBaseFunctionMultiDimTempl< T > BaseFunc

#include <Math/GSLNLSMinimizer.h>

Inheritance diagram for ROOT::Math::LSResidualFunc:
[legend]

◆ LSResidualFunc() [1/3]

 ROOT::Math::LSResidualFunc::LSResidualFunc ( )
inline

Definition at line 67 of file GSLNLSMinimizer.h.

◆ LSResidualFunc() [2/3]

 ROOT::Math::LSResidualFunc::LSResidualFunc ( const ROOT::Math::FitMethodFunction & func, unsigned int i )
inline

Definition at line 71 of file GSLNLSMinimizer.h.

◆ LSResidualFunc() [3/3]

 ROOT::Math::LSResidualFunc::LSResidualFunc ( const LSResidualFunc & rhs )
inline

Definition at line 79 of file GSLNLSMinimizer.h.

◆ Clone()

 IMultiGenFunction * ROOT::Math::LSResidualFunc::Clone ( ) const
inlinevirtual

Clone a function.

Each derived class must implement their version of the Clone method

Implements ROOT::Math::IBaseFunctionMultiDimTempl< T >.

Definition at line 95 of file GSLNLSMinimizer.h.

◆ DoDerivative()

 double ROOT::Math::LSResidualFunc::DoDerivative ( const double * x, unsigned int icoord ) const
inlineprivate

Definition at line 125 of file GSLNLSMinimizer.h.

◆ DoEval()

 double ROOT::Math::LSResidualFunc::DoEval ( const double * x ) const
inlineprivate

Definition at line 121 of file GSLNLSMinimizer.h.

◆ FdF()

 void ROOT::Math::LSResidualFunc::FdF ( const double * x, double & f, double * g ) const
inline

Definition at line 106 of file GSLNLSMinimizer.h.

 void ROOT::Math::LSResidualFunc::Gradient ( const double * x, double * g ) const
inline

Definition at line 101 of file GSLNLSMinimizer.h.

◆ NDim()

 unsigned int ROOT::Math::LSResidualFunc::NDim ( ) const
inlinevirtual

Retrieve the dimension of the function.

Implements ROOT::Math::IBaseFunctionMultiDimTempl< T >.

Definition at line 99 of file GSLNLSMinimizer.h.

◆ operator=()

 LSResidualFunc & ROOT::Math::LSResidualFunc::operator= ( const LSResidualFunc & rhs )
inline

Definition at line 87 of file GSLNLSMinimizer.h.

◆ fChi2

 const ROOT::Math::FitMethodFunction* ROOT::Math::LSResidualFunc::fChi2
private

Definition at line 134 of file GSLNLSMinimizer.h.

◆ fIndex

 unsigned int ROOT::Math::LSResidualFunc::fIndex
private

Definition at line 133 of file GSLNLSMinimizer.h.

◆ fX2

 std::vector ROOT::Math::LSResidualFunc::fX2
mutableprivate

Definition at line 135 of file GSLNLSMinimizer.h.

Libraries for ROOT::Math::LSResidualFunc: [legend]

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