Logo ROOT  
Reference Guide
ROOT::Math::GSLRootFinder Class Reference

Base class for GSL Root-Finding algorithms for one dimensional functions which do not use function derivatives.

For finding the roots users should not use this class directly but instantiate the derived classes, for example ROOT::Math::Roots::Brent for using the Brent algorithm. All the classes defining the alhorithms are defined in the header Math/RootFinderAlgorithm.h They possible types implementing root bracketing algorithms which they do not require function derivatives are:

See also the specific classes for the documentation. See the GSL online manual for information on the GSL Root-Finding algorithms

Definition at line 111 of file GSLRootFinder.h.

Public Types

typedef double(* GSLFuncPointer) (double, void *)
 

Public Member Functions

 GSLRootFinder ()
 
virtual ~GSLRootFinder ()
 
int Iterate ()
 This method is implemented only by the GSLRootFinder and GSLRootFinderDeriv classes and will return an error if it's not one of them. More...
 
int Iterations () const
 Return number of iterations. More...
 
const char * Name () const
 double GSLRootFinder::XLower() const { return fXlow; } More...
 
double Root () const
 Returns the previously calculated root. More...
 
bool SetFunction (const IGenFunction &f, double xlow, double xup)
 Sets the function for the rest of the algorithms. More...
 
virtual bool SetFunction (const ROOT::Math::IGenFunction &, double, double)
 Sets the function for the rest of the algorithms. More...
 
virtual bool SetFunction (const ROOT::Math::IGradFunction &, double)
 Sets the function for algorithms using derivatives. More...
 
bool SetFunction (GSLFuncPointer f, void *params, double xlow, double xup)
 
bool Solve (int maxIter=100, double absTol=1E-8, double relTol=1E-10)
 Find the root. More...
 
int Status () const
 Return the status of last root finding. More...
 
- Public Member Functions inherited from ROOT::Math::IRootFinderMethod
 IRootFinderMethod ()
 Default Constructor. More...
 
virtual ~IRootFinderMethod ()
 Default Destructor. More...
 
virtual bool SetFunction (const ROOT::Math::IGradFunction &, double)
 Sets the function for algorithms using derivatives. More...
 

Protected Member Functions

void FreeSolver ()
 
void SetSolver (GSLRootFSolver *s)
 

Private Member Functions

 GSLRootFinder (const GSLRootFinder &)
 
GSLRootFinderoperator= (const GSLRootFinder &)
 

Private Attributes

GSLFunctionWrapperfFunction
 
int fIter
 
double fRoot
 
GSLRootFSolverfS
 
int fStatus
 
bool fValidInterval
 
double fXlow
 
double fXup
 

#include <Math/GSLRootFinder.h>

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

Member Typedef Documentation

◆ GSLFuncPointer

typedef double( * ROOT::Math::GSLRootFinder::GSLFuncPointer) (double, void *)

Definition at line 134 of file GSLRootFinder.h.

Constructor & Destructor Documentation

◆ GSLRootFinder() [1/2]

ROOT::Math::GSLRootFinder::GSLRootFinder ( )

Definition at line 87 of file GSLRootFinder.cxx.

◆ ~GSLRootFinder()

ROOT::Math::GSLRootFinder::~GSLRootFinder ( )
virtual

Definition at line 97 of file GSLRootFinder.cxx.

◆ GSLRootFinder() [2/2]

ROOT::Math::GSLRootFinder::GSLRootFinder ( const GSLRootFinder )
private

Definition at line 103 of file GSLRootFinder.cxx.

Member Function Documentation

◆ FreeSolver()

void ROOT::Math::GSLRootFinder::FreeSolver ( )
protected

Definition at line 151 of file GSLRootFinder.cxx.

◆ Iterate()

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

This method is implemented only by the GSLRootFinder and GSLRootFinderDeriv classes and will return an error if it's not one of them.

Reimplemented from ROOT::Math::IRootFinderMethod.

Definition at line 156 of file GSLRootFinder.cxx.

◆ Iterations()

int ROOT::Math::GSLRootFinder::Iterations ( ) const
inlinevirtual

Return number of iterations.

Reimplemented from ROOT::Math::IRootFinderMethod.

Definition at line 152 of file GSLRootFinder.h.

◆ Name()

const char * ROOT::Math::GSLRootFinder::Name ( ) const
virtual

double GSLRootFinder::XLower() const { return fXlow; }

double GSLRootFinder::XUpper() const { return fXup; }

Implements ROOT::Math::IRootFinderMethod.

Definition at line 197 of file GSLRootFinder.cxx.

◆ operator=()

GSLRootFinder & ROOT::Math::GSLRootFinder::operator= ( const GSLRootFinder rhs)
private

Definition at line 107 of file GSLRootFinder.cxx.

◆ Root()

double ROOT::Math::GSLRootFinder::Root ( ) const
virtual

Returns the previously calculated root.

Implements ROOT::Math::IRootFinderMethod.

Definition at line 184 of file GSLRootFinder.cxx.

◆ SetFunction() [1/4]

bool ROOT::Math::GSLRootFinder::SetFunction ( const IGenFunction ,
double  ,
double   
)
virtual

Sets the function for the rest of the algorithms.

The parameters set the interval where the root has to be calculated.

Reimplemented from ROOT::Math::IRootFinderMethod.

Definition at line 131 of file GSLRootFinder.cxx.

◆ SetFunction() [2/4]

virtual bool ROOT::Math::IRootFinderMethod::SetFunction
inline

Sets the function for the rest of the algorithms.

The parameters set the interval where the root has to be calculated.

Definition at line 68 of file IRootFinderMethod.h.

◆ SetFunction() [3/4]

virtual bool ROOT::Math::IRootFinderMethod::SetFunction
inline

Sets the function for algorithms using derivatives.


Definition at line 60 of file IRootFinderMethod.h.

◆ SetFunction() [4/4]

bool ROOT::Math::GSLRootFinder::SetFunction ( GSLFuncPointer  f,
void params,
double  xlow,
double  xup 
)

Definition at line 115 of file GSLRootFinder.cxx.

◆ SetSolver()

void ROOT::Math::GSLRootFinder::SetSolver ( GSLRootFSolver s)
protected

Definition at line 146 of file GSLRootFinder.cxx.

◆ Solve()

bool ROOT::Math::GSLRootFinder::Solve ( int  maxIter = 100,
double  absTol = 1E-8,
double  relTol = 1E-10 
)
virtual

Find the root.

Implements ROOT::Math::IRootFinderMethod.

Definition at line 202 of file GSLRootFinder.cxx.

◆ Status()

int ROOT::Math::GSLRootFinder::Status ( ) const
inlinevirtual

Return the status of last root finding.

Implements ROOT::Math::IRootFinderMethod.

Definition at line 157 of file GSLRootFinder.h.

Member Data Documentation

◆ fFunction

GSLFunctionWrapper* ROOT::Math::GSLRootFinder::fFunction
private

Definition at line 171 of file GSLRootFinder.h.

◆ fIter

int ROOT::Math::GSLRootFinder::fIter
private

Definition at line 177 of file GSLRootFinder.h.

◆ fRoot

double ROOT::Math::GSLRootFinder::fRoot
private

Definition at line 174 of file GSLRootFinder.h.

◆ fS

GSLRootFSolver* ROOT::Math::GSLRootFinder::fS
private

Definition at line 172 of file GSLRootFinder.h.

◆ fStatus

int ROOT::Math::GSLRootFinder::fStatus
private

Definition at line 178 of file GSLRootFinder.h.

◆ fValidInterval

bool ROOT::Math::GSLRootFinder::fValidInterval
private

Definition at line 179 of file GSLRootFinder.h.

◆ fXlow

double ROOT::Math::GSLRootFinder::fXlow
private

Definition at line 175 of file GSLRootFinder.h.

◆ fXup

double ROOT::Math::GSLRootFinder::fXup
private

Definition at line 176 of file GSLRootFinder.h.

Libraries for ROOT::Math::GSLRootFinder:
[legend]

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