yat  0.20.3pre
Classes | Public Member Functions | Protected Member Functions | List of all members
theplu::yat::utility::RootFinderDerivative Class Reference

#include <yat/utility/RootFinderDerivative.h>

Inheritance diagram for theplu::yat::utility::RootFinderDerivative:
theplu::yat::utility::Newton theplu::yat::utility::Secant theplu::yat::utility::Steffenson

Classes

class  Delta
 
class  Residual
 
class  Stopper
 

Public Member Functions

 RootFinderDerivative (const RootFinderDerivative &)=delete
 Copy is not allowed.
 
RootFinderDerivativeoperator= (const RootFinderDerivative &)=delete
 Assignment is not allowed.
 
unsigned int epochs (void) const
 Number of epochs (iterations) used in last minimisation.
 
const char * name (void) const
 
template<class FUNC >
double operator() (FUNC &func, double guess, Stopper &&stopper)
 
template<class FUNC >
double operator() (FUNC &func, double guess, Stopper &&stopper, unsigned int max_epochs)
 

Protected Member Functions

 RootFinderDerivative (const gsl_root_fdfsolver_type *t)
 Constructor. More...
 

Detailed Description

Wrapper class around GSL One-Dimensional Root-Finding

Since
New in yat 0.20

Constructor & Destructor Documentation

◆ RootFinderDerivative()

theplu::yat::utility::RootFinderDerivative::RootFinderDerivative ( const gsl_root_fdfsolver_type *  t)
protected

Constructor.

Parameters
tdefines type of GSL minimizer

Member Function Documentation

◆ name()

const char* theplu::yat::utility::RootFinderDerivative::name ( void  ) const
Returns
name of the type of root finder

◆ operator()() [1/2]

template<class FUNC >
double theplu::yat::utility::RootFinderDerivative::operator() ( FUNC &  func,
double  guess,
RootFinderDerivative::Stopper &&  stopper 
)

Starting at guess, find a value x such that func(x) = 0. Function keeps iterating until stopper returns true.

Requirement on FUNC:

  • double operator(x)
  • double derivative(x)

◆ operator()() [2/2]

template<class FUNC >
double theplu::yat::utility::RootFinderDerivative::operator() ( FUNC &  func,
double  guess,
RootFinderDerivative::Stopper &&  stopper,
unsigned int  max_epochs 
)

Same as operator()(4) but do maximum max_epochs iterations.


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

Generated on Sat Feb 18 2023 03:31:45 for yat by  doxygen 1.8.14