ROOT: ROOT::Math::GSLMultiFit Class Reference

ROOT 6.06/09

Reference Guide

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

Definition at line 52 of file GSLMultiFit.h.

Public Member Functions
	GSLMultiFit (const gsl_multifit_fdfsolver_type *type=0)
	Default constructor No need to specify the type so far since only one solver exists so far. More...

	~GSLMultiFit ()
	Destructor (no operations) More...

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 More...

template<class Func >
int	Set (const std::vector< Func > &funcVec, const double *x)
	set the solver parameters More...

std::string	Name () const

int	Iterate ()

const double *	X () const
	parameter values at the minimum More...

const double *	Gradient () const
	gradient value at the minimum More...

const double *	CovarMatrix () const
	return covariance matrix of the parameters More...

int	TestGradient (double absTol) const
	test gradient (ask from solver gradient vector) More...

int	TestDelta (double absTol, double relTol) const
	test using abs and relative tolerance \|dx\| < absTol + relTol*\|x\| for every component More...

double	Edm () const

Private Member Functions
	GSLMultiFit (const GSLMultiFit &)
	Copy constructor. More...

GSLMultiFit &	operator= (const GSLMultiFit &rhs)
	Assignment operator. More...

Private Attributes
GSLMultiFitFunctionWrapper	fFunc

gsl_multifit_fdfsolver *	fSolver

gsl_vector *	fVec

gsl_matrix *	fCov

const gsl_multifit_fdfsolver_type *	fType

#include </mnt/vdb/lsf/workspace/root-makedoc-v606/rootspi/rdoc/src/v6-06-00-patches/math/mathmore/src/GSLMultiFit.h>

Collaboration diagram for ROOT::Math::GSLMultiFit:

Constructor & Destructor Documentation

ROOT::Math::GSLMultiFit::GSLMultiFit ( const gsl_multifit_fdfsolver_type * type = 0 )

inline

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

Definition at line 60 of file GSLMultiFit.h.

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

inline

Destructor (no operations)

Definition at line 72 of file GSLMultiFit.h.

ROOT::Math::GSLMultiFit::GSLMultiFit ( const GSLMultiFit & )

inlineprivate

Copy constructor.

Definition at line 84 of file GSLMultiFit.h.

Member Function Documentation

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

inline

return covariance matrix of the parameters

Definition at line 156 of file GSLMultiFit.h.

Referenced by Edm(), and ROOT::Math::GSLNLSMinimizer::Minimize().

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 98 of file GSLMultiFit.h.

Referenced by Set().

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

inline

Definition at line 189 of file GSLMultiFit.h.

Referenced by ROOT::Math::GSLNLSMinimizer::Minimize().

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

inline

gradient value at the minimum

Definition at line 145 of file GSLMultiFit.h.

Referenced by Edm(), ROOT::Math::GSLNLSMinimizer::MinGradient(), and TestGradient().

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

inline

Definition at line 132 of file GSLMultiFit.h.

Referenced by ROOT::Math::GSLNLSMinimizer::Minimize().

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

inline

Definition at line 127 of file GSLMultiFit.h.

Referenced by ROOT::Math::GSLNLSMinimizer::Minimize().

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

inlineprivate

Assignment operator.

Definition at line 89 of file GSLMultiFit.h.

template<class Func >

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

inline

set the solver parameters

Definition at line 105 of file GSLMultiFit.h.

Referenced by ROOT::Math::GSLNLSMinimizer::Minimize().

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 183 of file GSLMultiFit.h.

Referenced by ROOT::Math::GSLNLSMinimizer::Minimize().

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

inline

test gradient (ask from solver gradient vector)

Definition at line 175 of file GSLMultiFit.h.

Referenced by ROOT::Math::GSLNLSMinimizer::Minimize().

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

inline

parameter values at the minimum

Definition at line 138 of file GSLMultiFit.h.

Referenced by ROOT::Math::GSLNLSMinimizer::Minimize().

Member Data Documentation

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

mutableprivate

Definition at line 213 of file GSLMultiFit.h.

Referenced by CovarMatrix(), Edm(), and ~GSLMultiFit().

GSLMultiFitFunctionWrapper ROOT::Math::GSLMultiFit::fFunc

private

Definition at line 209 of file GSLMultiFit.h.

Referenced by Set().

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

private

Definition at line 210 of file GSLMultiFit.h.

Referenced by CovarMatrix(), CreateSolver(), Edm(), Gradient(), Iterate(), Name(), Set(), TestDelta(), TestGradient(), X(), and ~GSLMultiFit().

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

private

Definition at line 214 of file GSLMultiFit.h.

Referenced by CreateSolver(), Gradient(), and GSLMultiFit().

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

mutableprivate

Definition at line 212 of file GSLMultiFit.h.

Referenced by Edm(), Gradient(), Set(), TestGradient(), and ~GSLMultiFit().

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

math/mathmore/src/GSLMultiFit.h