Logo ROOT   master
Reference Guide
ROOT::Math::Roots::Secant Class Reference

Secant algorithm, simplified version of Newton method, which does not require the derivative at every step.

See the GSL manual for more information

Definition at line 155 of file RootFinderAlgorithms.h.

Public Member Functions

 Secant ()
 
virtual ~Secant ()
 
- Public Member Functions inherited from ROOT::Math::GSLRootFinderDeriv
 GSLRootFinderDeriv ()
 
virtual ~GSLRootFinderDeriv ()
 
int Iterate ()
 iterate (return GSL_SUCCESS in case of successful iteration) More...
 
int Iterations () const
 Return number of iterations. More...
 
const char * Name () const
 Return name of root finder algorithm. More...
 
double Root () const
 Returns the previously calculated root. More...
 
bool SetFunction (const IGradFunction &f, double xstart)
 Sets the function for algorithms using derivatives. More...
 
bool SetFunction (GSLFuncPointer f, GSLFuncPointer df, GSLFdFPointer fdf, void *p, double Root)
 
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 Solve (int maxIter=100, double absTol=1E-8, double relTol=1E-10)
 Find the root (return false if failed) 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::IGenFunction &, double, double)
 Sets the function for the rest of the algorithms. More...
 

Private Member Functions

 Secant (const Secant &)
 
Secantoperator= (const Secant &)
 

Additional Inherited Members

- Public Types inherited from ROOT::Math::GSLRootFinderDeriv
typedef void(* GSLFdFPointer) (double, void *, double *, double *)
 
typedef double(* GSLFuncPointer) (double, void *)
 
- Protected Member Functions inherited from ROOT::Math::GSLRootFinderDeriv
void FreeSolver ()
 
void SetSolver (GSLRootFdFSolver *s)
 

#include <Math/RootFinderAlgorithms.h>

Inheritance diagram for ROOT::Math::Roots::Secant:
[legend]

Constructor & Destructor Documentation

◆ Secant() [1/2]

ROOT::Math::Roots::Secant::Secant ( )

Definition at line 160 of file RootFinderAlgorithms.cxx.

◆ ~Secant()

ROOT::Math::Roots::Secant::~Secant ( )
virtual

Definition at line 167 of file RootFinderAlgorithms.cxx.

◆ Secant() [2/2]

ROOT::Math::Roots::Secant::Secant ( const Secant )
private

Definition at line 173 of file RootFinderAlgorithms.cxx.

Member Function Documentation

◆ operator=()

Secant & ROOT::Math::Roots::Secant::operator= ( const Secant rhs)
private

Definition at line 178 of file RootFinderAlgorithms.cxx.

Libraries for ROOT::Math::Roots::Secant:
[legend]

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