ROOT::Math::GSLMultiRootSolver Class Reference

GSLMultiRootSolver, internal class for implementing GSL multi-root finders not using derivatives.

Definition at line 155 of file GSLMultiRootSolver.h.

Public Member Functions
	GSLMultiRootSolver (const gsl_multiroot_fsolver_type *type, int n)
	Constructor from type and simension of system (number of functions)
	~GSLMultiRootSolver () override
	Destructor (no operations)
void	CreateSolver (const gsl_multiroot_fsolver_type *type, unsigned int n)
gsl_vector *	GetDx () const override
	return function steps
gsl_vector *	GetF () const override
	return function values
gsl_vector *	GetRoot () const override
	solution values at the current iteration
int	Iterate () override
	perform an iteration
const std::string &	Name () const override
	return name
int	SetSolver (const std::vector< ROOT::Math::IMultiGenFunction * > &funcVec, const double *x) override
	set the solver parameters
Public Member Functions inherited from ROOT::Math::GSLMultiRootBaseSolver
virtual	~GSLMultiRootBaseSolver ()
	virtual Destructor
const double *	Dx () const
	return function steps
const double *	FVal () const
	return function values
bool	InitSolver (const std::vector< ROOT::Math::IMultiGenFunction * > &funcVec, const double *x)
	init the solver with function list and initial values
int	TestDelta (double absTol, double relTol) const
	test using abs and relative tolerance |dx| < absTol + relTol*|x| for every component
int	TestResidual (double absTol) const
	test using abs tolerance Sum |f|_i < absTol
const double *	X () const
	solution values at the current iteration

Private Member Functions
	GSLMultiRootSolver (const GSLMultiRootSolver &)
	Copy constructor.
GSLMultiRootSolver &	operator= (const GSLMultiRootSolver &rhs)
	Assignment operator.

Private Attributes
GSLMultiRootFunctionWrapper	fFunctions
std::string	fName
gsl_multiroot_fsolver *	fSolver
gsl_vector *	fVec

#include </github/home/ROOT-CI/src/math/mathmore/src/GSLMultiRootSolver.h>

Inheritance diagram for ROOT::Math::GSLMultiRootSolver:

Constructor & Destructor Documentation

GSLMultiRootSolver() [1/2]

ROOT::Math::GSLMultiRootSolver::GSLMultiRootSolver ( const gsl_multiroot_fsolver_type * type, int n )

inline

Constructor from type and simension of system (number of functions)

Definition at line 162 of file GSLMultiRootSolver.h.

~GSLMultiRootSolver()

ROOT::Math::GSLMultiRootSolver::~GSLMultiRootSolver ( )

inlineoverride

Destructor (no operations)

Definition at line 173 of file GSLMultiRootSolver.h.

GSLMultiRootSolver() [2/2]

ROOT::Math::GSLMultiRootSolver::GSLMultiRootSolver ( const GSLMultiRootSolver & )

inlineprivate

Copy constructor.

Definition at line 184 of file GSLMultiRootSolver.h.

Member Function Documentation

CreateSolver()

void ROOT::Math::GSLMultiRootSolver::CreateSolver ( const gsl_multiroot_fsolver_type * type, unsigned int n )

inline

Definition at line 198 of file GSLMultiRootSolver.h.

GetDx()

gsl_vector * ROOT::Math::GSLMultiRootSolver::GetDx ( ) const

inlineoverridevirtual

return function steps

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 246 of file GSLMultiRootSolver.h.

GetF()

gsl_vector * ROOT::Math::GSLMultiRootSolver::GetF ( ) const

inlineoverridevirtual

return function values

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 240 of file GSLMultiRootSolver.h.

GetRoot()

gsl_vector * ROOT::Math::GSLMultiRootSolver::GetRoot ( ) const

inlineoverridevirtual

solution values at the current iteration

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 234 of file GSLMultiRootSolver.h.

Iterate()

int ROOT::Math::GSLMultiRootSolver::Iterate ( )

inlineoverridevirtual

perform an iteration

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 228 of file GSLMultiRootSolver.h.

Name()

const std::string & ROOT::Math::GSLMultiRootSolver::Name ( ) const

inlineoverridevirtual

return name

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 224 of file GSLMultiRootSolver.h.

operator=()

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

inlineprivate

Assignment operator.

Definition at line 189 of file GSLMultiRootSolver.h.

SetSolver()

int ROOT::Math::GSLMultiRootSolver::SetSolver ( const std::vector< ROOT::Math::IMultiGenFunction * > & funcVec, const double * x )

inlineoverridevirtual

set the solver parameters

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 208 of file GSLMultiRootSolver.h.

Member Data Documentation

fFunctions

GSLMultiRootFunctionWrapper ROOT::Math::GSLMultiRootSolver::fFunctions

private

Definition at line 254 of file GSLMultiRootSolver.h.

fName

std::string ROOT::Math::GSLMultiRootSolver::fName

private

Definition at line 258 of file GSLMultiRootSolver.h.

fSolver

gsl_multiroot_fsolver* ROOT::Math::GSLMultiRootSolver::fSolver

private

Definition at line 255 of file GSLMultiRootSolver.h.

fVec

gsl_vector* ROOT::Math::GSLMultiRootSolver::fVec

mutableprivate

Definition at line 257 of file GSLMultiRootSolver.h.