ROOT  6.06/09
Reference Guide
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROOT::Math::GSLMultiRootDerivSolver Class Reference

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

Definition at line 267 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 int SetSolver (const std::vector< ROOT::Math::IMultiGenFunction * > &funcVec, const double *x)
 set the solver parameters for the case of derivative More...
 
virtual std::string Name () const
 return name More...
 
virtual int Iterate ()
 perform an iteration More...
 
virtual gsl_vector * GetRoot () const
 solution values at the current iteration More...
 
virtual gsl_vector * GetF () const
 return function values More...
 
virtual gsl_vector * GetDx () const
 return function steps More...
 
- Public Member Functions inherited from ROOT::Math::GSLMultiRootBaseSolver
virtual ~GSLMultiRootBaseSolver ()
 virtual Destructor More...
 
bool InitSolver (const std::vector< ROOT::Math::IMultiGenFunction * > &funcVec, const double *x)
 init the solver with function list and initial values More...
 
const doubleX () const
 solution values at the current iteration More...
 
const doubleFVal () const
 return function values More...
 
const doubleDx () const
 return function steps 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...
 

Private Member Functions

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

Private Attributes

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

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

+ Inheritance diagram for ROOT::Math::GSLMultiRootDerivSolver:
+ Collaboration diagram for ROOT::Math::GSLMultiRootDerivSolver:

Constructor & Destructor Documentation

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

Constructor.

Definition at line 274 of file GSLMultiRootSolver.h.

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

Destructor (no operations)

Definition at line 284 of file GSLMultiRootSolver.h.

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

Copy constructor.

Definition at line 295 of file GSLMultiRootSolver.h.

Member Function Documentation

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 310 of file GSLMultiRootSolver.h.

Referenced by GSLMultiRootDerivSolver().

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

return function steps

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 368 of file GSLMultiRootSolver.h.

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

return function values

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 362 of file GSLMultiRootSolver.h.

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

solution values at the current iteration

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 356 of file GSLMultiRootSolver.h.

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

perform an iteration

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 350 of file GSLMultiRootSolver.h.

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

return name

Implements ROOT::Math::GSLMultiRootBaseSolver.

Definition at line 345 of file GSLMultiRootSolver.h.

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

Assignment operator.

Definition at line 300 of file GSLMultiRootSolver.h.

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 320 of file GSLMultiRootSolver.h.

Member Data Documentation

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

Definition at line 377 of file GSLMultiRootSolver.h.

Referenced by SetSolver().

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

Definition at line 381 of file GSLMultiRootSolver.h.

Referenced by SetSolver().

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

Definition at line 380 of file GSLMultiRootSolver.h.

Referenced by SetSolver(), and ~GSLMultiRootDerivSolver().


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