yat  0.21pre
Public Member Functions | List of all members
theplu::yat::utility::Bisection Class Reference

#include <yat/utility/Bisection.h>

Inheritance diagram for theplu::yat::utility::Bisection:
theplu::yat::utility::RootFinder

Public Member Functions

 Bisection (void)
 Constructor.
 
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 lower, double upper, Stopper &&stopper)
 
template<class FUNC >
double operator() (FUNC &func, double lower, double upper, Stopper &&stopper, unsigned int max_epochs)
 

Detailed Description

Wrapper around gsl_root_fsolver_bisection

Since
New in yat 0.20

Member Function Documentation

◆ name()

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

◆ operator()() [1/2]

template<class FUNC >
double theplu::yat::utility::RootFinder::operator() ( FUNC &  func,
double  lower,
double  upper,
RootFinder::Stopper &&  stopper 
)
inherited

Find a value x within range [lower, upper] such that func(x) = 0. Function keeps iterating until stopper returns true.

◆ operator()() [2/2]

template<class FUNC >
double theplu::yat::utility::RootFinder::operator() ( FUNC &  func,
double  lower,
double  upper,
RootFinder::Stopper &&  stopper,
unsigned int  max_epochs 
)
inherited

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


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

Generated on Wed Jan 25 2023 03:34:29 for yat by  doxygen 1.8.14