min_fminimizer Class Reference

Wrapper class for GSL function minimization routines. More...

#include <src/gsl_wrappers/gsl_min_fminimizer.h>

List of all members.

Public Member Functions
	min_fminimizer (const gsl_min_fminimizer_type *type=gsl_min_fminimizer_brent)
	Class constructor to initialize minimizer.
	~min_fminimizer ()
	Class destructor minimizer.
int	set (min_f &function, double minimum, double x_lower, double x_upper)
	Function to set, or reset, an existing minimizer.
int	set_with_values (min_f &function, double minimum, double f_minimum, double x_lower, double f_lower, double x_upper, double f_upper)
	Function to set or reset the minimizer with maximum and minimum function values.
int	iterate ()
	Function that performs an iteration of the minimizer.
double	minimum ()
	Function that returns the current minimum of the function.
double	x_upper ()
	Function that returns the current upper bound of the interval for the minimizer.
double	x_lower ()
	Function that returns the current lower bound of the interval for the minimizer.
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 function converged.
Private Member Functions
void	assert_set ()
	Error handling function.
Private Attributes
bool	isSet
	Boolean variable to check if everything is properly set.
bool	isConverged
	Boolean variable to check if converged.
int	nIterations
	Index for current number of iterations.
int	maxIterations
	Maximum number of iterations.
gsl_min_fminimizer *	s
	Function minimizer object.
gsl_function	f
	Function that GSL minimizes.

---

Detailed Description

Wrapper class for GSL function minimization routines.

---

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

• src/gsl_wrappers/gsl_min_fminimizer.h
• src/gsl_wrappers/gsl_min_fminimizer.c