ROOT: ROOT::Math::GSLMultiRootBaseSolver Class Reference

ROOT 6.06/09

Reference Guide

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...

bool	InitSolver (const std::vector< ROOT::Math::IMultiGenFunction * > &funcVec, const double *x)
	init the solver with function list and initial values More...

virtual std::string	Name () const =0
	return name More...

virtual int	Iterate ()=0
	perform an iteration More...

const double *	X () const
	solution values at the current iteration More...

const double *	FVal () const
	return function values More...

const double *	Dx () 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
virtual int	SetSolver (const std::vector< ROOT::Math::IMultiGenFunction * > &funcVec, const double *x)=0

virtual gsl_vector *	GetRoot () const =0

virtual gsl_vector *	GetF () const =0

virtual gsl_vector *	GetDx () const =0

#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::GSLMultiRootBaseSolver:

Constructor & Destructor Documentation

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

inlinevirtual

virtual Destructor

Definition at line 64 of file GSLMultiRootSolver.h.

Member Function Documentation

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

inline

return function steps

Definition at line 110 of file GSLMultiRootSolver.h.

Referenced by ROOT::Math::GSLMultiRootFinder::Dx().

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

inline

return function values

Definition at line 104 of file GSLMultiRootSolver.h.

Referenced by ROOT::Math::GSLMultiRootFinder::FVal(), and ROOT::Math::GSLMultiRootFinder::PrintState().

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

privatepure virtual

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

Referenced by Dx(), and TestDelta().

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

privatepure virtual

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

Referenced by FVal(), and TestResidual().

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

privatepure virtual

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

Referenced by TestDelta(), and X().

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.

Referenced by ROOT::Math::GSLMultiRootFinder::Solve().

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

pure virtual

perform an iteration

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

Referenced by ROOT::Math::GSLMultiRootFinder::Solve().

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

pure virtual

return name

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

Referenced by ROOT::Math::GSLMultiRootFinder::Name(), and ROOT::Math::GSLMultiRootFinder::Solve().

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

privatepure virtual

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

Referenced by InitSolver().

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.

Referenced by ROOT::Math::GSLMultiRootFinder::Solve().

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.

Referenced by ROOT::Math::GSLMultiRootFinder::Solve().

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

inline

solution values at the current iteration

Definition at line 98 of file GSLMultiRootSolver.h.

Referenced by ROOT::Math::GSLMultiRootFinder::PrintState(), and ROOT::Math::GSLMultiRootFinder::X().

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

math/mathmore/src/GSLMultiRootSolver.h