theplu::yat::utility::RootFinder Class Reference

#include <yat/utility/RootFinder.h>

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

Classes
class	Delta
class	Interval
class	Residual
class	Stopper

Public Member Functions
	RootFinder (const RootFinder &)=delete
	Copy is not allowed.
RootFinder &	operator= (const RootFinder &)=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 lower, double upper, Stopper &&stopper)
template<class FUNC >
double	operator() (FUNC &func, double lower, double upper, Stopper &&stopper, unsigned int max_epochs)

Protected Member Functions
	RootFinder (const gsl_root_fsolver_type *t)
	Constructor. More...

Detailed Description

Wrapper class around GSL One-Dimensional Root-Finding

Since

New in yat 0.20

Constructor & Destructor Documentation

RootFinder()

theplu::yat::utility::RootFinder::RootFinder ( const gsl_root_fsolver_type *  t )

protected

Constructor.

Parameters

t	defines type of GSL minimizer

Member Function Documentation

name()

const char* theplu::yat::utility::RootFinder::name

(

void

)

const

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
	)

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
	)

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

---

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

• yat/utility/RootFinder.h