til::Brent< TFunctor > Class Template Reference

A class to minimize a functional within a bracketing triplet. More...

#include <cathier/minTools.h>

Public Types
typedef TFunctor::argument_type	input_type
typedef value_type_of< input_type >::type	input_prec
typedef TFunctor::result_type	output_prec
typedef combine< input_prec, output_prec >::type	max_prec

Public Member Functions
	Brent ()
	Brent (TFunctor functor)
void	init ()
	Somewhat meaningful default values. More...
void	setMaxIterations (int itmax)
max_prec	tol () const
void	setTol (input_prec tol)
input_prec	xmin () const
output_prec	fmin () const
bool &	verbose ()
void	operator() (input_prec a, input_prec m, input_prec b, input_type point, input_type dir)
	Minimize functor starting from p and in the direction dir [a,m,b] is a bracketing triplet of the minimum. More...

Detailed Description

template<typename TFunctor>
class til::Brent< TFunctor >

A class to minimize a functional within a bracketing triplet.

Definition at line 85 of file minTools.h.

Member Typedef Documentation

input_prec

template<typename TFunctor>

typedef value_type_of<input_type>::type til::Brent< TFunctor >::input_prec

Definition at line 90 of file minTools.h.

input_type

template<typename TFunctor>

typedef TFunctor::argument_type til::Brent< TFunctor >::input_type

Definition at line 89 of file minTools.h.

max_prec

template<typename TFunctor>

typedef combine<input_prec, output_prec>::type til::Brent< TFunctor >::max_prec

Definition at line 92 of file minTools.h.

output_prec

template<typename TFunctor>

typedef TFunctor::result_type til::Brent< TFunctor >::output_prec

Definition at line 91 of file minTools.h.

Constructor & Destructor Documentation

Brent() [1/2]

template<typename TFunctor>

til::Brent< TFunctor >::Brent

(

)

Brent() [2/2]

template<typename TFunctor>

til::Brent< TFunctor >::Brent

(

TFunctor

functor

)

Member Function Documentation

fmin()

template<typename TFunctor>

output_prec til::Brent< TFunctor >::fmin ( ) const

inline

Definition at line 120 of file minTools.h.

init()

template<typename TFunctor>

void til::Brent< TFunctor >::init ( )

inline

Somewhat meaningful default values.

Definition at line 102 of file minTools.h.

References til::sqrt().

operator()()

template<typename TFunctor>

void til::Brent< TFunctor >::operator()	(	input_prec	a,
		input_prec	m,
		input_prec	b,
		input_type	point,
		input_type	dir
	)

Minimize functor starting from p and in the direction dir [a,m,b] is a bracketing triplet of the minimum.

setMaxIterations()

template<typename TFunctor>

void til::Brent< TFunctor >::setMaxIterations ( int  itmax )

inline

Definition at line 112 of file minTools.h.

setTol()

template<typename TFunctor>

void til::Brent< TFunctor >::setTol ( input_prec  tol )

inline

Definition at line 115 of file minTools.h.

tol()

template<typename TFunctor>

max_prec til::Brent< TFunctor >::tol ( ) const

inline

Definition at line 114 of file minTools.h.

verbose()

template<typename TFunctor>

bool& til::Brent< TFunctor >::verbose ( )

inline

Definition at line 122 of file minTools.h.

References til::Mnbrak< TFunctor >::operator()().

xmin()

template<typename TFunctor>

input_prec til::Brent< TFunctor >::xmin ( ) const

inline

Definition at line 118 of file minTools.h.

---

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

• cathier/minTools.h