KJB
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | List of all members
kjb::Generic_multimin< T > Class Template Reference

#include <gsl_multimin.h>

Inheritance diagram for kjb::Generic_multimin< T >:
kjb::Gsl_Multimin_f

Public Types

typedef boost::function1
< double, T > 
Evaluator
 
typedef boost::function2< void,
const gsl_vector *, T & > 
From_gsl
 
typedef boost::function2< void,
const T &, gsl_vector * > 
To_gsl
 

Public Member Functions

 Generic_multimin (size_t size, const To_gsl &to_gsl, const From_gsl &from_gsl, const gsl_multimin_fminimizer_type *type=gsl_multimin_fminimizer_nmsimplex2)
 
template<class Eval_type , class VectorType >
void initialize (const Eval_type &e, const T &guess, const VectorType &step_size, bool negate_evaluator=false)
 
const T & get () const
 
double min () const
 query the current best min value of the function to be minimized More...
 
- Public Member Functions inherited from kjb::Gsl_Multimin_f
 Gsl_Multimin_f (const gsl_multimin_fminimizer_type *type, gsl_multimin_function *f, const gsl_vector *x0, const gsl_vector *step_size, bool verbosity=true)
 ctor builds the minimizer by allocating and setting up params More...
 
 Gsl_Multimin_f (size_t size, const gsl_multimin_fminimizer_type *type=gsl_multimin_fminimizer_nmsimplex2)
 
void initialize (gsl_multimin_function *f, const gsl_vector *x0, const gsl_vector *step_size)
 
size_t dim () const
 
int iterate ()
 Perform one iteration of the minimizer. More...
 
gsl_vectorargmin () const
 query the current best argmin of the minimizer More...
 
const char * name () const
 access a string describing the algorithm More...
 
int test_size (double epsabs) const
 check the magnitude the minimizer specific characteristic size against the tolerance epsabs. More...
 
void swap (Gsl_Multimin_f &that)
 Swap the contents of this minimizer and another (fast). More...
 
bool verbosity (bool v)
 Alter the verbosity attribute of the object. More...
 

Member Typedef Documentation

template<class T >
typedef boost::function1<double, T> kjb::Generic_multimin< T >::Evaluator
template<class T >
typedef boost::function2<void, const gsl_vector*, T&> kjb::Generic_multimin< T >::From_gsl
template<class T >
typedef boost::function2<void, const T&, gsl_vector*> kjb::Generic_multimin< T >::To_gsl

Constructor & Destructor Documentation

template<class T >
kjb::Generic_multimin< T >::Generic_multimin ( size_t  size,
const To_gsl to_gsl,
const From_gsl from_gsl,
const gsl_multimin_fminimizer_type type = gsl_multimin_fminimizer_nmsimplex2 
)
inline

Member Function Documentation

template<class T >
const T& kjb::Generic_multimin< T >::get ( ) const
inline
template<class T >
template<class Eval_type , class VectorType >
void kjb::Generic_multimin< T >::initialize ( const Eval_type &  e,
const T &  guess,
const VectorType &  step_size,
bool  negate_evaluator = false 
)
inline
template<class T >
double kjb::Generic_multimin< T >::min ( ) const
inlinevirtual

query the current best min value of the function to be minimized

Reimplemented from kjb::Gsl_Multimin_f.


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