A class for doing parabolic interpolation and minimisation of 1D functions using Brent's method. More...

#include <Minimise1DBrent.h>

Public Member Functions
	Minimise1DBrent (const FCLASS &pf, const double &t=3.0E-8)

void	bracket (const double &ax, const double &xx, eng_pointer eng)
	Bracket the minium. More...

double	minimise (eng_pointer eng)
	Find the minimum between two brackets. More...

double	getMinimumValue () const
	Return the value of the function at the minimum. More...

Private Types
typedef double(FCLASS::*	eng_pointer) (const double &val)
	This is the type specifier for the function to minimise. More...

Private Attributes
bool	bracketed
	Has the minimum been bracketed. More...

bool	minimised
	Has the function been minimised. More...

double	tol
	The tolerance for the line minimiser. More...

const double	GOLD
	The default ration by which successive intervals are magnified. More...

const double	GLIMIT
	The maximum magnification allowed for a parabolic fit step. More...

const double	TINY
	Use to prevent any possible division by zero. More...

const unsigned	ITMAX
	Maximum number of interactions in line minimiser. More...

const double	CGOLD
	The value of the golden ratio. More...

const double	ZEPS
	A small number that protects against trying to achieve fractional accuracy for a minimum that happens to be exactly zero. More...

double	ax
	Three points bracketting the minimum and the corresponding function values. More...

double	bx

double	cx

double	fa

double	fb

double	fc

double	fmin

FCLASS	myclass_func
	The class containing the function we are trying to minimise. More...

Detailed Description

template<class FCLASS>
class PLMD::Minimise1DBrent< FCLASS >

A class for doing parabolic interpolation and minimisation of 1D functions using Brent's method.

Member Typedef Documentation

◆ eng_pointer

template<class FCLASS >

typedef double(FCLASS::* PLMD::Minimise1DBrent< FCLASS >::eng_pointer) (const double &val)

private

This is the type specifier for the function to minimise.

Constructor & Destructor Documentation

◆ Minimise1DBrent()

template<class FCLASS >

PLMD::Minimise1DBrent< FCLASS >::Minimise1DBrent	(	const FCLASS &	pf,
		const double &	t = `3.0E-8`
	)

explicit

Member Function Documentation

◆ bracket()

template<class FCLASS >

void PLMD::Minimise1DBrent< FCLASS >::bracket	(	const double &	ax,
		const double &	xx,
		eng_pointer	eng
	)

Bracket the minium.

◆ getMinimumValue()

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::getMinimumValue ( ) const

Return the value of the function at the minimum.

◆ minimise()

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::minimise ( eng_pointer eng )

Find the minimum between two brackets.

Member Data Documentation

◆ ax

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::ax

private

Three points bracketting the minimum and the corresponding function values.

◆ bracketed

template<class FCLASS >

bool PLMD::Minimise1DBrent< FCLASS >::bracketed

private

Has the minimum been bracketed.

◆ bx

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::bx

private

◆ CGOLD

template<class FCLASS >

const double PLMD::Minimise1DBrent< FCLASS >::CGOLD

private

The value of the golden ratio.

◆ cx

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::cx

private

◆ fa

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::fa

private

◆ fb

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::fb

private

◆ fc

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::fc

private

◆ fmin

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::fmin

private

◆ GLIMIT

template<class FCLASS >

const double PLMD::Minimise1DBrent< FCLASS >::GLIMIT

private

The maximum magnification allowed for a parabolic fit step.

◆ GOLD

template<class FCLASS >

const double PLMD::Minimise1DBrent< FCLASS >::GOLD

private

The default ration by which successive intervals are magnified.

◆ ITMAX

template<class FCLASS >

const unsigned PLMD::Minimise1DBrent< FCLASS >::ITMAX

private

Maximum number of interactions in line minimiser.

◆ minimised

template<class FCLASS >

bool PLMD::Minimise1DBrent< FCLASS >::minimised

private

Has the function been minimised.

◆ myclass_func

template<class FCLASS >

FCLASS PLMD::Minimise1DBrent< FCLASS >::myclass_func

private

The class containing the function we are trying to minimise.

◆ TINY

template<class FCLASS >

const double PLMD::Minimise1DBrent< FCLASS >::TINY

private

Use to prevent any possible division by zero.

◆ tol

template<class FCLASS >

double PLMD::Minimise1DBrent< FCLASS >::tol

private

The tolerance for the line minimiser.

◆ ZEPS

template<class FCLASS >

const double PLMD::Minimise1DBrent< FCLASS >::ZEPS

private

A small number that protects against trying to achieve fractional accuracy for a minimum that happens to be exactly zero.

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

tools/Minimise1DBrent.h

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<class FCLASS> class PLMD::Minimise1DBrent< FCLASS >

Member Typedef Documentation

◆ eng_pointer

Constructor & Destructor Documentation

◆ Minimise1DBrent()

Member Function Documentation

◆ bracket()

◆ getMinimumValue()

◆ minimise()

Member Data Documentation

◆ ax

◆ bracketed

◆ bx

◆ CGOLD

◆ cx

◆ fa

◆ fb

◆ fc

◆ fmin

◆ GLIMIT

◆ GOLD

◆ ITMAX

◆ minimised

◆ myclass_func

◆ TINY

◆ tol

◆ ZEPS

template<class FCLASS>
class PLMD::Minimise1DBrent< FCLASS >