Logo ROOT  

Reference Guide
List of all members | Public Member Functions | Private Member Functions | List of all members
ROOT::Math::GSLMultiRootBaseSolver Class Referenceabstract
Math » MathCore | Math » MathMore » Numerical Algorithms » Multidimensional ROOT finding

GSLMultiRootBaseSolver, internal class for implementing GSL multi-root finders This is the base class for GSLMultiRootSolver (solver not using derivatives) and GSLMUltiRootDerivSolver (solver using derivatives)

Definition at line 57 of file GSLMultiRootSolver.h.

Public Member Functions

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...
 
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 double * X () const
 solution values at the current iteration More...
 

Private Member Functions

virtual gsl_vector * GetDx () const =0
 
virtual gsl_vector * GetF () const =0
 
virtual gsl_vector * GetRoot () const =0
 
virtual int SetSolver (const std::vector< ROOT::Math::IMultiGenFunction * > &funcVec, const double *x)=0
 

#include </home/sftnight/build/workspace/root-makedoc-v622/rootspi/rdoc/src/v6-22-00-patches/math/mathmore/src/GSLMultiRootSolver.h>

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

Constructor & Destructor Documentation

◆ ~GSLMultiRootBaseSolver()

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

virtual Destructor

Definition at line 64 of file GSLMultiRootSolver.h.

Member Function Documentation

◆ Dx()

const double * ROOT::Math::GSLMultiRootBaseSolver::Dx ( ) const
inline

return function steps

Definition at line 110 of file GSLMultiRootSolver.h.

◆ FVal()

const double * ROOT::Math::GSLMultiRootBaseSolver::FVal ( ) const
inline

return function values

Definition at line 104 of file GSLMultiRootSolver.h.

◆ GetDx()

virtual gsl_vector * ROOT::Math::GSLMultiRootBaseSolver::GetDx ( ) const
privatepure virtual

Implemented in ROOT::Math::GSLMultiRootSolver, and ROOT::Math::GSLMultiRootDerivSolver.

◆ GetF()

virtual gsl_vector * ROOT::Math::GSLMultiRootBaseSolver::GetF ( ) const
privatepure virtual

Implemented in ROOT::Math::GSLMultiRootSolver, and ROOT::Math::GSLMultiRootDerivSolver.

◆ GetRoot()

virtual gsl_vector * ROOT::Math::GSLMultiRootBaseSolver::GetRoot ( ) const
privatepure virtual

Implemented in ROOT::Math::GSLMultiRootSolver, and ROOT::Math::GSLMultiRootDerivSolver.

◆ InitSolver()

bool ROOT::Math::GSLMultiRootBaseSolver::InitSolver ( const std::vector< ROOT::Math::IMultiGenFunction * > &  funcVec,
const double *  x 
)
inline

init the solver with function list and initial values

Definition at line 71 of file GSLMultiRootSolver.h.

◆ Iterate()

virtual int ROOT::Math::GSLMultiRootBaseSolver::Iterate ( )
pure virtual

perform an iteration

Implemented in ROOT::Math::GSLMultiRootSolver, and ROOT::Math::GSLMultiRootDerivSolver.

◆ Name()

virtual const std::string & ROOT::Math::GSLMultiRootBaseSolver::Name ( ) const
pure virtual

return name

Implemented in ROOT::Math::GSLMultiRootSolver, and ROOT::Math::GSLMultiRootDerivSolver.

◆ SetSolver()

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

Implemented in ROOT::Math::GSLMultiRootSolver, and ROOT::Math::GSLMultiRootDerivSolver.

◆ TestDelta()

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

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

Definition at line 117 of file GSLMultiRootSolver.h.

◆ TestResidual()

int ROOT::Math::GSLMultiRootBaseSolver::TestResidual ( double  absTol) const
inline

test using abs tolerance Sum |f|_i < absTol

Definition at line 126 of file GSLMultiRootSolver.h.

◆ X()

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

solution values at the current iteration

Definition at line 98 of file GSLMultiRootSolver.h.

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