Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
ROOT::Math::GSLRootFinder Class Reference
Math » Core Math Functionality (MathCore) » Numerical Algorithms » One-dimensional Root-Finding

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:

  • ROOT::Math::Roots::Bisection
  • ROOT::Math::Roots::FalsePos
  • ROOT::Math::Roots::Brent

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

Definition at line 73 of file GSLRootFinder.h.

Public Types

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

Public Member Functions

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

Protected Member Functions

void FreeSolver ()
void SetSolver (GSLRootFSolver *s)

Private Attributes

GSLFunctionWrapper * fFunction
int fIter
double fRoot
GSLRootFSolver * fS
int fStatus
bool fValidInterval
double fXlow
double fXup

#include <Math/GSLRootFinder.h>

Inheritance diagram for ROOT::Math::GSLRootFinder:
ROOT::Math::IRootFinderMethod ROOT::Math::Roots::Bisection ROOT::Math::Roots::Brent ROOT::Math::Roots::FalsePos

Member Typedef Documentation

◆ GSLFuncPointer

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

Definition at line 94 of file GSLRootFinder.h.

Constructor & Destructor Documentation

◆ GSLRootFinder() [1/3]

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

Definition at line 49 of file GSLRootFinder.cxx.

◆ ~GSLRootFinder()

ROOT::Math::GSLRootFinder::~GSLRootFinder ( )
override

Definition at line 59 of file GSLRootFinder.cxx.

◆ GSLRootFinder() [2/3]

ROOT::Math::GSLRootFinder::GSLRootFinder ( const GSLRootFinder & )
delete

◆ GSLRootFinder() [3/3]

ROOT::Math::GSLRootFinder::GSLRootFinder ( GSLRootFinder && )
delete

Member Function Documentation

◆ FreeSolver()

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

Definition at line 101 of file GSLRootFinder.cxx.

◆ Iterate()

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

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 106 of file GSLRootFinder.cxx.

◆ Iterations()

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

Return number of iterations.

Reimplemented from ROOT::Math::IRootFinderMethod.

Definition at line 112 of file GSLRootFinder.h.

◆ Name()

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

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

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

Implements ROOT::Math::IRootFinderMethod.

Definition at line 147 of file GSLRootFinder.cxx.

◆ operator=() [1/2]

GSLRootFinder & ROOT::Math::GSLRootFinder::operator= ( const GSLRootFinder & )
delete

◆ operator=() [2/2]

GSLRootFinder & ROOT::Math::GSLRootFinder::operator= ( GSLRootFinder && )
delete

◆ Root()

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

Returns the previously calculated root.

Implements ROOT::Math::IRootFinderMethod.

Definition at line 134 of file GSLRootFinder.cxx.

◆ SetFunction() [1/3]

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

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 81 of file GSLRootFinder.cxx.

◆ SetFunction() [2/3]

virtual bool ROOT::Math::IRootFinderMethod::SetFunction ( const ROOT::Math::IGradFunction & ,
double  )
inlinevirtual

Sets the function for algorithms using derivatives.

Reimplemented from ROOT::Math::IRootFinderMethod.

Definition at line 45 of file IRootFinderMethod.h.

◆ SetFunction() [3/3]

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

Definition at line 65 of file GSLRootFinder.cxx.

◆ SetSolver()

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

Definition at line 96 of file GSLRootFinder.cxx.

◆ Solve()

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

Find the root.

Implements ROOT::Math::IRootFinderMethod.

Definition at line 152 of file GSLRootFinder.cxx.

◆ Status()

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

Return the status of last root finding.

Implements ROOT::Math::IRootFinderMethod.

Definition at line 117 of file GSLRootFinder.h.

Member Data Documentation

◆ fFunction

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

Definition at line 131 of file GSLRootFinder.h.

◆ fIter

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

Definition at line 137 of file GSLRootFinder.h.

◆ fRoot

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

Definition at line 134 of file GSLRootFinder.h.

◆ fS

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

Definition at line 132 of file GSLRootFinder.h.

◆ fStatus

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

Definition at line 138 of file GSLRootFinder.h.

◆ fValidInterval

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

Definition at line 139 of file GSLRootFinder.h.

◆ fXlow

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

Definition at line 135 of file GSLRootFinder.h.

◆ fXup

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

Definition at line 136 of file GSLRootFinder.h.

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