Logo ROOT  
Reference Guide
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) More...
 ~GSLMultiRootSolver () override
 Destructor (no operations) More...
void CreateSolver (const gsl_multiroot_fsolver_type *type, unsigned int n)
gsl_vector * GetDx () const override
 return function steps More...
gsl_vector * GetF () const override
 return function values More...
gsl_vector * GetRoot () const override
 solution values at the current iteration More...
int Iterate () override
 perform an iteration More...
const std::string & Name () const override
 return name More...
int SetSolver (const std::vector< ROOT::Math::IMultiGenFunction * > &funcVec, const double *x) override
 set the solver parameters More...
- Public Member Functions inherited from ROOT::Math::GSLMultiRootBaseSolver
virtual ~GSLMultiRootBaseSolver ()
 virtual Destructor More...
const doubleDx () const
 return function steps More...
const doubleFVal () 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...
virtual int Iterate ()=0
 perform an iteration More...
virtual const std::string & Name () const =0
 return name 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 doubleX () const
 solution values at the current iteration More...

Private Member Functions

 GSLMultiRootSolver (const GSLMultiRootSolver &)
 Copy constructor. More...
GSLMultiRootSolveroperator= (const GSLMultiRootSolver &rhs)
 Assignment operator. More...

Private Attributes

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

#include </home/sftnight/build/workspace/root-makedoc-master/rootspi/rdoc/src/master/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 

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

Definition at line 162 of file GSLMultiRootSolver.h.

◆ ~GSLMultiRootSolver()

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

Destructor (no operations)

Definition at line 173 of file GSLMultiRootSolver.h.

◆ GSLMultiRootSolver() [2/2]

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

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 

Definition at line 198 of file GSLMultiRootSolver.h.

◆ GetDx()

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

return function steps

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 246 of file GSLMultiRootSolver.h.

◆ GetF()

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

return function values

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 240 of file GSLMultiRootSolver.h.

◆ GetRoot()

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

solution values at the current iteration

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 234 of file GSLMultiRootSolver.h.

◆ Iterate()

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

perform an iteration

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 228 of file GSLMultiRootSolver.h.

◆ Name()

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

return name

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 224 of file GSLMultiRootSolver.h.

◆ operator=()

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

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 

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

Definition at line 254 of file GSLMultiRootSolver.h.

◆ fName

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

Definition at line 258 of file GSLMultiRootSolver.h.

◆ fSolver

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

Definition at line 255 of file GSLMultiRootSolver.h.

◆ fVec

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

Definition at line 257 of file GSLMultiRootSolver.h.

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