theplu::yat::utility::NelderMeadSimplex2 Class Reference

#include <yat/utility/NelderMeadSimplex2.h>

Inheritance diagram for theplu::yat::utility::NelderMeadSimplex2:

Public Member Functions
	NelderMeadSimplex2 (size_t size)
unsigned int	epochs (void) const
	Number of epochs (iterations) used in last minimisation.
const yat::utility::Vector &	step (void) const
	The size of the first step. More...
yat::utility::Vector &	step (void)
	Modify the initial step size. More...
template<class FUNC >
void	operator() (yat::utility::VectorMutable &x, FUNC &func, Stopper &&stopper)
template<class FUNC >
void	operator() (yat::utility::VectorMutable &, FUNC &func, Stopper &&stopper, unsigned int max_epochs)

Detailed Description

Wrapper around GSL gsl_multimin_fminimizer_nmsimplex2

Since

New in yat 0.20

Constructor & Destructor Documentation

NelderMeadSimplex2()

theplu::yat::utility::NelderMeadSimplex2::NelderMeadSimplex2

(

size_t

size

)

Parameters

size	dimension of space we are minimizing in.

Member Function Documentation

operator()() [1/2]

template<class FUNC >

void theplu::yat::utility::MultiMinimizer::operator() ( yat::utility::VectorMutable &  x, FUNC &  func, MultiMinimizer::Stopper &&  stopper  )

inherited

Function finds an x that minimizes the function defined by func. It calls gsl_multimin_fminimizer_iterate until either GSL_ENOPROG is returned or the stopper returns true.

Type Requirements:

• FUNC must have an operator double operator()(const VectorBase& x)

operator()() [2/2]

template<class FUNC >

void theplu::yat::utility::MultiMinimizer::operator() ( yat::utility::VectorMutable &  x, FUNC &  func, MultiMinimizer::Stopper &&  stopper, unsigned int  max_epochs  )

inherited

Same as operator()(yat::utility::VectorMutable&, FUNC& func, Stopper&&); but at maximum run max_epochs epochs (iterations).

step() [1/2]

const yat::utility::Vector& theplu::yat::utility::MultiMinimizer::step ( void  ) const

inherited

The size of the first step.

See also

parameter step_size in gsl_multimin_fminimizer_set

step() [2/2]

yat::utility::Vector& theplu::yat::utility::MultiMinimizer::step ( void  )

inherited

Modify the initial step size.

The size of the vector cannot be modified but must equal the size set in constructor.

---

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

• yat/utility/NelderMeadSimplex2.h