yat  0.20.3pre
Public Member Functions | List of all members
theplu::yat::utility::RootFinderDerivative::Residual< FUNC > Class Template Reference

#include <yat/utility/RootFinderDerivative.h>

Inheritance diagram for theplu::yat::utility::RootFinderDerivative::Residual< FUNC >:
theplu::yat::utility::RootFinderDerivative::Stopper

Public Member Functions

 Residual (const FUNC &func, double epsabs)
 
bool operator() (const gsl_root_fdfsolver *)
 

Detailed Description

template<class FUNC>
class theplu::yat::utility::RootFinderDerivative::Residual< FUNC >

wrapper around gsl_root_test_residual

Constructor & Destructor Documentation

◆ Residual()

template<class FUNC >
theplu::yat::utility::RootFinderDerivative::Residual< FUNC >::Residual ( const FUNC &  func,
double  epsabs 
)
inline
Parameters
funcsame functor as used in RootFinder::operator().
epsabsabsolute tolerance

Member Function Documentation

◆ operator()()

template<class FUNC >
bool theplu::yat::utility::RootFinderDerivative::Residual< FUNC >::operator() ( const gsl_root_fdfsolver *  s)
virtual
Returns
true if current residual f satisfies $ |f| < epsabs $

Implements theplu::yat::utility::RootFinderDerivative::Stopper.


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