Golden Class Reference

#include <FindMinimum.hpp>

Inherits BracketMethod.

Public Member Functions
	Golden (const Real toll=3.0e-8)
	Default constructor. More...
template<class T >
Real	minimize (T &func)
Public Member Functions inherited from BracketMethod
	BracketMethod ()
	Default constructor. More...
template<class T >
void	bracket (const Real a, const Real b, T &func)
void	setMaxStep (const Real &step)

Private Attributes
Real	xmin
Real	fmin
const Real	tol

Additional Inherited Members
Protected Member Functions inherited from BracketMethod
void	shft2 (Real &a, Real &b, const Real c)
void	shft3 (Real &a, Real &b, Real &c, const Real d)
void	mov3 (Real &a, Real &b, Real &c, const Real d, const Real e, const Real f)
void	swap (Real &a, Real &b)
Protected Attributes inherited from BracketMethod
Real	m_maxStep
Real	ax
Real	bx
Real	cx
Real	fa
Real	fb
Real	fc

Detailed Description

Golden: This class is finds the minimum of a given function, using the golden method.

Author

Willem Deconinck Based on Numerical Recipes v3.02

Use:

/// class Function
/// {
///   Real operator() (const Real& x) { return x*x;}
/// };
/// Function func;
/// Golden golden;
/// golden.bracket(a,b,func);
/// Real xmin = golden.minimize(func);
/// 

Definition at line 162 of file FindMinimum.hpp.

Constructor & Destructor Documentation

Golden ( const Real  toll = 3.0e-8 )

inline

Default constructor.

Definition at line 169 of file FindMinimum.hpp.

Member Function Documentation

Real minimize ( T &  func )

inline

Minimizes the given function

Parameters

func	The given function

Returns

The minimum of the function

Definition at line 175 of file FindMinimum.hpp.

Member Data Documentation

Real fmin

private

Definition at line 164 of file FindMinimum.hpp.

const Real tol

private

Definition at line 165 of file FindMinimum.hpp.

Real xmin

private

Definition at line 164 of file FindMinimum.hpp.

---

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

• cf3/math/FindMinimum.hpp