Logo ROOT   6.19/01
Reference Guide
ROOT::Math::GSLMultiRootDerivSolver Class Reference

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

Definition at line 268 of file GSLMultiRootSolver.h.

Public Member Functions

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

Private Member Functions

 GSLMultiRootDerivSolver (const GSLMultiRootDerivSolver &)
 Copy constructor. More...
 
GSLMultiRootDerivSolveroperator= (const GSLMultiRootDerivSolver &rhs)
 Assignment operator. More...
 

Private Attributes

GSLMultiRootDerivFunctionWrapper fDerivFunctions
 
gsl_multiroot_fdfsolver * fDerivSolver
 
std::vector< ROOT::Math::IMultiGradFunction * > fGradFuncVec
 
std::string fName
 
gsl_vector * fVec
 

#include </mnt/build/workspace/root-makedoc/rootspi/rdoc/src/master/math/mathmore/src/GSLMultiRootSolver.h>

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

Constructor & Destructor Documentation

◆ GSLMultiRootDerivSolver() [1/2]

ROOT::Math::GSLMultiRootDerivSolver::GSLMultiRootDerivSolver ( const gsl_multiroot_fdfsolver_type *  type,
int  n 
)
inline

Constructor.

Definition at line 275 of file GSLMultiRootSolver.h.

◆ ~GSLMultiRootDerivSolver()

virtual ROOT::Math::GSLMultiRootDerivSolver::~GSLMultiRootDerivSolver ( )
inlinevirtual

Destructor (no operations)

Definition at line 286 of file GSLMultiRootSolver.h.

◆ GSLMultiRootDerivSolver() [2/2]

ROOT::Math::GSLMultiRootDerivSolver::GSLMultiRootDerivSolver ( const GSLMultiRootDerivSolver )
inlineprivate

Copy constructor.

Definition at line 297 of file GSLMultiRootSolver.h.

Member Function Documentation

◆ CreateSolver()

void ROOT::Math::GSLMultiRootDerivSolver::CreateSolver ( const gsl_multiroot_fdfsolver_type *  type,
unsigned int  n 
)
inline

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

Definition at line 312 of file GSLMultiRootSolver.h.

◆ GetDx()

virtual gsl_vector* ROOT::Math::GSLMultiRootDerivSolver::GetDx ( ) const
inlinevirtual

return function steps

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 370 of file GSLMultiRootSolver.h.

◆ GetF()

virtual gsl_vector* ROOT::Math::GSLMultiRootDerivSolver::GetF ( ) const
inlinevirtual

return function values

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 364 of file GSLMultiRootSolver.h.

◆ GetRoot()

virtual gsl_vector* ROOT::Math::GSLMultiRootDerivSolver::GetRoot ( ) const
inlinevirtual

solution values at the current iteration

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 358 of file GSLMultiRootSolver.h.

◆ Iterate()

virtual int ROOT::Math::GSLMultiRootDerivSolver::Iterate ( )
inlinevirtual

perform an iteration

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 352 of file GSLMultiRootSolver.h.

◆ Name()

virtual const std::string& ROOT::Math::GSLMultiRootDerivSolver::Name ( ) const
inlinevirtual

return name

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 348 of file GSLMultiRootSolver.h.

◆ operator=()

GSLMultiRootDerivSolver& ROOT::Math::GSLMultiRootDerivSolver::operator= ( const GSLMultiRootDerivSolver rhs)
inlineprivate

Assignment operator.

Definition at line 302 of file GSLMultiRootSolver.h.

◆ SetSolver()

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

set the solver parameters for the case of derivative

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 323 of file GSLMultiRootSolver.h.

Member Data Documentation

◆ fDerivFunctions

GSLMultiRootDerivFunctionWrapper ROOT::Math::GSLMultiRootDerivSolver::fDerivFunctions
private

Definition at line 379 of file GSLMultiRootSolver.h.

◆ fDerivSolver

gsl_multiroot_fdfsolver* ROOT::Math::GSLMultiRootDerivSolver::fDerivSolver
private

Definition at line 380 of file GSLMultiRootSolver.h.

◆ fGradFuncVec

std::vector<ROOT::Math::IMultiGradFunction*> ROOT::Math::GSLMultiRootDerivSolver::fGradFuncVec
private

Definition at line 383 of file GSLMultiRootSolver.h.

◆ fName

std::string ROOT::Math::GSLMultiRootDerivSolver::fName
private

Definition at line 384 of file GSLMultiRootSolver.h.

◆ fVec

gsl_vector* ROOT::Math::GSLMultiRootDerivSolver::fVec
mutableprivate

Definition at line 382 of file GSLMultiRootSolver.h.


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