Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Math::GSLMultiFit Class Reference

GSLMultiFit, internal class for implementing GSL non linear least square GSL fitting.

Definition at line 53 of file GSLMultiFit.h.

Public Member Functions

 GSLMultiFit (const gsl_multifit_fdfsolver_type *type=nullptr)
 Default constructor No need to specify the type so far since only one solver exists so far.
 
 GSLMultiFit (const GSLMultiFit &)=delete
 
 GSLMultiFit (GSLMultiFit &&)=delete
 
 ~GSLMultiFit ()
 Destructor (no operations)
 
const doubleCovarMatrix () const
 return covariance matrix of the parameters
 
void CreateSolver (unsigned int npoints, unsigned int npar)
 create the minimizer from the type and size of number of fitting points and number of parameters
 
double Edm () const
 
const doubleGradient () const
 gradient value at the minimum
 
int Iterate ()
 
std::string Name () const
 
GSLMultiFitoperator= (const GSLMultiFit &rhs)=delete
 
GSLMultiFitoperator= (GSLMultiFit &&rhs)=delete
 
template<class Func >
int Set (const std::vector< Func > &funcVec, const double *x)
 set the solver parameters
 
int TestDelta (double absTol, double relTol) const
 test using abs and relative tolerance |dx| < absTol + relTol*|x| for every component
 
int TestGradient (double absTol) const
 test gradient (ask from solver gradient vector)
 
const doubleX () const
 parameter values at the minimum
 

Private Attributes

gsl_matrix * fCov
 
GSLMultiFitFunctionWrapper fFunc
 
gsl_multifit_fdfsolver * fSolver
 
gsl_vector * fTmp
 
const gsl_multifit_fdfsolver_type * fType
 
gsl_vector * fVec
 

#include </home/sftnight/build/workspace/root-makedoc-master/rootspi/rdoc/src/master/math/mathmore/src/GSLMultiFit.h>

Constructor & Destructor Documentation

◆ GSLMultiFit() [1/3]

ROOT::Math::GSLMultiFit::GSLMultiFit ( const gsl_multifit_fdfsolver_type *  type = nullptr)
inline

Default constructor No need to specify the type so far since only one solver exists so far.

Definition at line 61 of file GSLMultiFit.h.

◆ ~GSLMultiFit()

ROOT::Math::GSLMultiFit::~GSLMultiFit ( )
inline

Destructor (no operations)

Definition at line 77 of file GSLMultiFit.h.

◆ GSLMultiFit() [2/3]

ROOT::Math::GSLMultiFit::GSLMultiFit ( const GSLMultiFit )
delete

◆ GSLMultiFit() [3/3]

ROOT::Math::GSLMultiFit::GSLMultiFit ( GSLMultiFit &&  )
delete

Member Function Documentation

◆ CovarMatrix()

const double * ROOT::Math::GSLMultiFit::CovarMatrix ( ) const
inline

return covariance matrix of the parameters

Definition at line 169 of file GSLMultiFit.h.

◆ CreateSolver()

void ROOT::Math::GSLMultiFit::CreateSolver ( unsigned int  npoints,
unsigned int  npar 
)
inline

create the minimizer from the type and size of number of fitting points and number of parameters

Definition at line 94 of file GSLMultiFit.h.

◆ Edm()

double ROOT::Math::GSLMultiFit::Edm ( ) const
inline

Definition at line 197 of file GSLMultiFit.h.

◆ Gradient()

const double * ROOT::Math::GSLMultiFit::Gradient ( ) const
inline

gradient value at the minimum

Definition at line 158 of file GSLMultiFit.h.

◆ Iterate()

int ROOT::Math::GSLMultiFit::Iterate ( )
inline

Definition at line 145 of file GSLMultiFit.h.

◆ Name()

std::string ROOT::Math::GSLMultiFit::Name ( ) const
inline

Definition at line 140 of file GSLMultiFit.h.

◆ operator=() [1/2]

GSLMultiFit & ROOT::Math::GSLMultiFit::operator= ( const GSLMultiFit rhs)
delete

◆ operator=() [2/2]

GSLMultiFit & ROOT::Math::GSLMultiFit::operator= ( GSLMultiFit &&  rhs)
delete

◆ Set()

template<class Func >
int ROOT::Math::GSLMultiFit::Set ( const std::vector< Func > &  funcVec,
const double x 
)
inline

set the solver parameters

Definition at line 111 of file GSLMultiFit.h.

◆ TestDelta()

int ROOT::Math::GSLMultiFit::TestDelta ( double  absTol,
double  relTol 
) const
inline

test using abs and relative tolerance |dx| < absTol + relTol*|x| for every component

Definition at line 191 of file GSLMultiFit.h.

◆ TestGradient()

int ROOT::Math::GSLMultiFit::TestGradient ( double  absTol) const
inline

test gradient (ask from solver gradient vector)

Definition at line 183 of file GSLMultiFit.h.

◆ X()

const double * ROOT::Math::GSLMultiFit::X ( ) const
inline

parameter values at the minimum

Definition at line 151 of file GSLMultiFit.h.

Member Data Documentation

◆ fCov

gsl_matrix* ROOT::Math::GSLMultiFit::fCov
mutableprivate

Definition at line 221 of file GSLMultiFit.h.

◆ fFunc

GSLMultiFitFunctionWrapper ROOT::Math::GSLMultiFit::fFunc
private

Definition at line 216 of file GSLMultiFit.h.

◆ fSolver

gsl_multifit_fdfsolver* ROOT::Math::GSLMultiFit::fSolver
private

Definition at line 217 of file GSLMultiFit.h.

◆ fTmp

gsl_vector* ROOT::Math::GSLMultiFit::fTmp
mutableprivate

Definition at line 220 of file GSLMultiFit.h.

◆ fType

const gsl_multifit_fdfsolver_type* ROOT::Math::GSLMultiFit::fType
private

Definition at line 225 of file GSLMultiFit.h.

◆ fVec

gsl_vector* ROOT::Math::GSLMultiFit::fVec
mutableprivate

Definition at line 219 of file GSLMultiFit.h.

  • math/mathmore/src/GSLMultiFit.h