multimin_fminimizer Class Reference

Wrapper class for GSL gradient - free multidimensional function minimization routines. More...

#include <src/gsl_wrappers/gsl_multidim_fminimizer.h>

List of all members.

Public Member Functions
	multimin_fminimizer (uint _dim, double _etol, const gsl_multimin_fminimizer_type *type=gsl_multimin_fminimizer_nmsimplex2rand)
	Class constructor to initialize minimizer.
	~multimin_fminimizer ()
	Class destructor for multimin_fminimizer.
int	set (multimin_f &function, const vector &initial_x, const vector &step_size)
	Function to set, or reset an existing minimizer.
int	iterate ()
	Function that performs an iteration of the minimizer.
double	minimum ()
	Function returning current minimum value of function after an iteration.
vector	x_value ()
	Function that returns the current vector where minimum of the function is attained.
void	SetMaxIterations (int n)
	Function that sets the maximum number of iterations.
int	GetNIterations ()
	Function that returns the number of iteration that were performed.
bool	is_converged ()
	Function that checks if iterations have converged.
Private Member Functions
void	assert_set ()
	Error handling function.
Private Attributes
uint	dim
	Unsigned integer for dimension of space where function is defined.
double	etol
	Error tolerance.
bool	isSet
	Boolean variable to check everything is set properly.
bool	isConverged
	Boolean variable to check if iterations converge.
int	nIterations
	Index for current iteration number.
int	maxIterations
	Maximum number of iterations to be pursued.
gsl_multimin_fminimizer *	s
	GSL multidimensional minimizer object.
gsl_multimin_function	f
	Multidimensionla function called by GSL during minimization.

---

Detailed Description

Wrapper class for GSL gradient - free multidimensional function minimization routines.

---

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

• src/gsl_wrappers/gsl_multidim_fminimizer.h
• src/gsl_wrappers/gsl_multidim_fminimizer.c