mygsl::multidimensional_minimization Class Reference

Multidimensional minimization algorithm. More...

#include <bayeux/mygsl/multidimensional_minimization.h>

Classes
class	at_step_action
struct	default_step_action

Public Types
enum	mode_t { MODE_FDF = 0, MODE_F = 1 }
enum	stopping_t { STOPPING_GRADIENT = 0, STOPPING_SIZE = 1 }

Public Member Functions
void	set_max_iter (size_t max_)
void	set_modulo_iter (size_t modulo_)
size_t	get_n_iter () const
size_t	get_modulo_iter () const
size_t	get_max_iter () const
double	get_epsabs () const
double	get_fval () const
void	unset_step_action ()
void	set_default_step_action ()
void	set_step_action (at_step_action &asd_)
std::string	get_name () const
void	init (const std::string &name_, multidimensional_minimization_system &ms_)
void	reset ()
	multidimensional_minimization ()
virtual	~multidimensional_minimization ()
int	minimize (double epsabs_)
void	devel_dump_x () const

Static Public Member Functions
static double	f (const gsl_vector *v_, void *params_)
static void	df (const gsl_vector *v_, void *params_, gsl_vector *gradient_)
static void	fdf (const gsl_vector *v_, void *params_, double *f_, gsl_vector *gradient_)
static bool	name_is_valid (const std::string &name_)
static void	print_types (std::ostream &)

Public Attributes
datatools::logger::priority	logging = datatools::logger::PRIO_FATAL

Static Public Attributes
static const size_t	DEFAULT_MAX_ITER
static const size_t	DEFAULT_MODULO_ITER
static const double	DEFAULT_EPSABS
static default_step_action	__default_step_action

Protected Member Functions
void	_at_step_hook (int status_, size_t iter_, double *x_, size_t dim_, double f_)

Detailed Description

Multidimensional minimization algorithm.

Member Enumeration Documentation

mode_t

enum mygsl::multidimensional_minimization::mode_t

Enumerator
MODE_FDF
MODE_F

stopping_t

enum mygsl::multidimensional_minimization::stopping_t

Enumerator
STOPPING_GRADIENT
STOPPING_SIZE

Constructor & Destructor Documentation

multidimensional_minimization()

mygsl::multidimensional_minimization::multidimensional_minimization

(

)

~multidimensional_minimization()

virtual mygsl::multidimensional_minimization::~multidimensional_minimization ( )

virtual

Member Function Documentation

_at_step_hook()

void mygsl::multidimensional_minimization::_at_step_hook ( int  status_, size_t  iter_, double *  x_, size_t  dim_, double  f_  )

protected

devel_dump_x()

void mygsl::multidimensional_minimization::devel_dump_x

(

)

const

df()

static void mygsl::multidimensional_minimization::df ( const gsl_vector *  v_, void *  params_, gsl_vector *  gradient_  )

static

f()

static double mygsl::multidimensional_minimization::f ( const gsl_vector *  v_, void *  params_  )

static

fdf()

static void mygsl::multidimensional_minimization::fdf ( const gsl_vector *  v_, void *  params_, double *  f_, gsl_vector *  gradient_  )

static

get_epsabs()

double mygsl::multidimensional_minimization::get_epsabs

(

)

const

get_fval()

double mygsl::multidimensional_minimization::get_fval

(

)

const

get_max_iter()

size_t mygsl::multidimensional_minimization::get_max_iter

(

)

const

get_modulo_iter()

size_t mygsl::multidimensional_minimization::get_modulo_iter

(

)

const

get_n_iter()

size_t mygsl::multidimensional_minimization::get_n_iter

(

)

const

get_name()

std::string mygsl::multidimensional_minimization::get_name

(

)

const

init()

void mygsl::multidimensional_minimization::init	(	const std::string &	name_,
		multidimensional_minimization_system &	ms_
	)

minimize()

int mygsl::multidimensional_minimization::minimize

(

double

epsabs_

)

name_is_valid()

static bool mygsl::multidimensional_minimization::name_is_valid ( const std::string &  name_ )

static

print_types()

static void mygsl::multidimensional_minimization::print_types ( std::ostream &  )

static

reset()

void mygsl::multidimensional_minimization::reset

(

)

set_default_step_action()

void mygsl::multidimensional_minimization::set_default_step_action

(

)

set_max_iter()

void mygsl::multidimensional_minimization::set_max_iter

(

size_t

max_

)

set_modulo_iter()

void mygsl::multidimensional_minimization::set_modulo_iter

(

size_t

modulo_

)

set_step_action()

void mygsl::multidimensional_minimization::set_step_action

(

at_step_action &

asd_

)

unset_step_action()

void mygsl::multidimensional_minimization::unset_step_action

(

)

Member Data Documentation

__default_step_action

default_step_action mygsl::multidimensional_minimization::__default_step_action

static

DEFAULT_EPSABS

const double mygsl::multidimensional_minimization::DEFAULT_EPSABS

static

DEFAULT_MAX_ITER

const size_t mygsl::multidimensional_minimization::DEFAULT_MAX_ITER

static

DEFAULT_MODULO_ITER

const size_t mygsl::multidimensional_minimization::DEFAULT_MODULO_ITER

static

logging

datatools::logger::priority mygsl::multidimensional_minimization::logging = datatools::logger::PRIO_FATAL

---

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

• bayeux/mygsl/multidimensional_minimization.h