mygsl::multimin_system::param_entry Class Reference

#include <bayeux/mygsl/multimin.h>

Public Types
enum	limit_t { LIMIT_NO = 0x0, LIMIT_MIN = 0x1, LIMIT_MAX = 0x2, LIMIT_RANGE = LIMIT_MIN|LIMIT_MAX }
enum	type_t { TYPE_FREE =0, TYPE_FIXED =1, TYPE_AUTO =2 }

Public Member Functions
bool	is_fixed () const
bool	is_free () const
bool	is_auto () const
bool	has_limit () const
bool	has_no_limit () const
bool	has_min () const
bool	has_max () const
bool	is_in_range () const
double	get_dist_to_min () const
double	get_dist_to_max () const
double	get_dist_to_limit () const
double	get_value () const
double	get_step () const
double	get_min () const
double	get_max () const
void	set_value (double value_)
void	set_value_no_check (double value_)

Static Public Member Functions
static param_entry	make_param_entry_auto (const std::string &name_)
static param_entry	make_param_entry_fixed (const std::string &name_, double value_)
static param_entry	make_param_entry_ranged (const std::string &name_, double value_, double min_, double max_, double step_, bool fixed_=false)

Public Attributes
std::string	name
double	value
int	type
int	limit
double	min
double	max
double	step

Member Enumeration Documentation

limit_t

enum mygsl::multimin_system::param_entry::limit_t

Enumerator
LIMIT_NO
LIMIT_MIN
LIMIT_MAX
LIMIT_RANGE

type_t

enum mygsl::multimin_system::param_entry::type_t

Enumerator
TYPE_FREE
TYPE_FIXED
TYPE_AUTO

Member Function Documentation

get_dist_to_limit()

double mygsl::multimin_system::param_entry::get_dist_to_limit

(

)

const

get_dist_to_max()

double mygsl::multimin_system::param_entry::get_dist_to_max

(

)

const

get_dist_to_min()

double mygsl::multimin_system::param_entry::get_dist_to_min

(

)

const

get_max()

double mygsl::multimin_system::param_entry::get_max

(

)

const

get_min()

double mygsl::multimin_system::param_entry::get_min

(

)

const

get_step()

double mygsl::multimin_system::param_entry::get_step

(

)

const

get_value()

double mygsl::multimin_system::param_entry::get_value

(

)

const

has_limit()

bool mygsl::multimin_system::param_entry::has_limit ( ) const

inline

has_max()

bool mygsl::multimin_system::param_entry::has_max ( ) const

inline

has_min()

bool mygsl::multimin_system::param_entry::has_min ( ) const

inline

has_no_limit()

bool mygsl::multimin_system::param_entry::has_no_limit ( ) const

inline

is_auto()

bool mygsl::multimin_system::param_entry::is_auto ( ) const

inline

is_fixed()

bool mygsl::multimin_system::param_entry::is_fixed ( ) const

inline

is_free()

bool mygsl::multimin_system::param_entry::is_free ( ) const

inline

is_in_range()

bool mygsl::multimin_system::param_entry::is_in_range

(

)

const

make_param_entry_auto()

static param_entry mygsl::multimin_system::param_entry::make_param_entry_auto ( const std::string &  name_ )

static

make_param_entry_fixed()

static param_entry mygsl::multimin_system::param_entry::make_param_entry_fixed ( const std::string &  name_, double  value_  )

static

make_param_entry_ranged()

static param_entry mygsl::multimin_system::param_entry::make_param_entry_ranged ( const std::string &  name_, double  value_, double  min_, double  max_, double  step_, bool  fixed_ = false  )

static

set_value()

void mygsl::multimin_system::param_entry::set_value

(

double

value_

)

set_value_no_check()

void mygsl::multimin_system::param_entry::set_value_no_check

(

double

value_

)

Member Data Documentation

limit

int mygsl::multimin_system::param_entry::limit

max

double mygsl::multimin_system::param_entry::max

min

double mygsl::multimin_system::param_entry::min

name

std::string mygsl::multimin_system::param_entry::name

step

double mygsl::multimin_system::param_entry::step

type

int mygsl::multimin_system::param_entry::type

value

double mygsl::multimin_system::param_entry::value

---

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

• bayeux/mygsl/multimin.h