mygsl::param_entry Class Reference

#include <bayeux/mygsl/param_entry.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_NULL = 0x0, TYPE_FREE = 0x1, TYPE_CONST = 0x2, TYPE_AUTO = 0x4,   TYPE_AUTO_COMPUTED = 0x8 }

Public Member Functions
bool	has_step () const
bool	has_value () const
const std::string &	get_name () const
const std::string &	get_comment () const
void	set_name (const std::string &name_)
void	set_comment (const std::string &comment_)
void	set_best_value (const best_value &best_value_)
void	reset_best_value ()
bool	is_auto_computed () const
void	set_auto_computed (bool=true)
bool	has_best_value () const
const best_value &	get_best_value () const
best_value &	get_best_value ()
bool	is_const () 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
bool	is_in_safe_range () const
bool	is_in_range_but_close_to_min () const
bool	is_in_range_but_close_to_max () const
double	get_overflow () const
double	get_underflow () const
double	get_dist_to_min () const
double	get_dist_to_max () const
double	get_dist_to_limit () const
double	get_sign_limit () const
double	get_value () const
double	get_value_safe () const
double	get_value_safe (double &dist_) const
double	get_step () const
double	get_min () const
double	get_max () const
void	set_min_max (double min_, double max_)
void	set_min (double min_)
void	set_no_min ()
void	set_max (double max_)
void	set_no_max ()
void	set_step (double step_)
void	set_value (double value_)
void	set_value_no_check (double value_)
bool	check_value () const
void	print (std::ostream &out_=std::clog, const std::string &title_="Parameter", const std::string &indent_="") const
void	print_status (std::ostream &out_=std::clog) const

Static Public Member Functions
static param_entry	make_auto (const std::string &name_, double step_=AUTO_STEP)
static param_entry	make_auto_range (const std::string &name_, double min_, double max_, double step_=AUTO_STEP)
static param_entry	make_auto_min (const std::string &name_, double min_, double step_=AUTO_STEP)
static param_entry	make_auto_max (const std::string &name_, double max_, double step_=AUTO_STEP)
static param_entry	make_free (const std::string &name_, double value_, double step_=AUTO_STEP)
static param_entry	make_free_range (const std::string &name_, double min_, double max_, double value_, double step_=AUTO_STEP)
static param_entry	make_free_min (const std::string &name_, double min_, double value_, double step_=AUTO_STEP)
static param_entry	make_free_max (const std::string &name_, double max_, double value_, double step_=AUTO_STEP)
static param_entry	make_const (const std::string &name_, double value_)

Static Public Attributes
static const double	NO_MIN_VALUE
static const double	NO_MAX_VALUE
static const double	NO_VALUE
static const double	DEFAULT_STEP
static const double	AUTO_STEP
static const std::string	AUTO_LABEL
static const std::string	FREE_LABEL
static const std::string	CONST_LABEL

Member Enumeration Documentation

limit_t

enum mygsl::param_entry::limit_t

Enumerator
LIMIT_NO
LIMIT_MIN
LIMIT_MAX
LIMIT_RANGE

type_t

enum mygsl::param_entry::type_t

Enumerator
TYPE_NULL
TYPE_FREE
TYPE_CONST
TYPE_AUTO
TYPE_AUTO_COMPUTED

Member Function Documentation

check_value()

bool mygsl::param_entry::check_value

(

)

const

get_best_value() [1/2]

const best_value& mygsl::param_entry::get_best_value

(

)

const

get_best_value() [2/2]

best_value& mygsl::param_entry::get_best_value

(

)

get_comment()

const std::string& mygsl::param_entry::get_comment

(

)

const

get_dist_to_limit()

double mygsl::param_entry::get_dist_to_limit

(

)

const

get_dist_to_max()

double mygsl::param_entry::get_dist_to_max

(

)

const

get_dist_to_min()

double mygsl::param_entry::get_dist_to_min

(

)

const

get_max()

double mygsl::param_entry::get_max

(

)

const

get_min()

double mygsl::param_entry::get_min

(

)

const

get_name()

const std::string& mygsl::param_entry::get_name

(

)

const

get_overflow()

double mygsl::param_entry::get_overflow

(

)

const

get_sign_limit()

double mygsl::param_entry::get_sign_limit

(

)

const

get_step()

double mygsl::param_entry::get_step

(

)

const

get_underflow()

double mygsl::param_entry::get_underflow

(

)

const

get_value()

double mygsl::param_entry::get_value

(

)

const

get_value_safe() [1/2]

double mygsl::param_entry::get_value_safe

(

)

const

get_value_safe() [2/2]

double mygsl::param_entry::get_value_safe

(

double &

dist_

)

const

has_best_value()

bool mygsl::param_entry::has_best_value

(

)

const

has_limit()

bool mygsl::param_entry::has_limit

(

)

const

has_max()

bool mygsl::param_entry::has_max

(

)

const

has_min()

bool mygsl::param_entry::has_min

(

)

const

has_no_limit()

bool mygsl::param_entry::has_no_limit

(

)

const

has_step()

bool mygsl::param_entry::has_step

(

)

const

has_value()

bool mygsl::param_entry::has_value

(

)

const

is_auto()

bool mygsl::param_entry::is_auto

(

)

const

is_auto_computed()

bool mygsl::param_entry::is_auto_computed

(

)

const

is_const()

bool mygsl::param_entry::is_const

(

)

const

is_free()

bool mygsl::param_entry::is_free

(

)

const

is_in_range()

bool mygsl::param_entry::is_in_range

(

)

const

is_in_range_but_close_to_max()

bool mygsl::param_entry::is_in_range_but_close_to_max

(

)

const

is_in_range_but_close_to_min()

bool mygsl::param_entry::is_in_range_but_close_to_min

(

)

const

is_in_safe_range()

bool mygsl::param_entry::is_in_safe_range

(

)

const

make_auto()

static param_entry mygsl::param_entry::make_auto ( const std::string &  name_, double  step_ = AUTO_STEP  )

static

make_auto_max()

static param_entry mygsl::param_entry::make_auto_max ( const std::string &  name_, double  max_, double  step_ = AUTO_STEP  )

static

make_auto_min()

static param_entry mygsl::param_entry::make_auto_min ( const std::string &  name_, double  min_, double  step_ = AUTO_STEP  )

static

make_auto_range()

static param_entry mygsl::param_entry::make_auto_range ( const std::string &  name_, double  min_, double  max_, double  step_ = AUTO_STEP  )

static

make_const()

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

static

make_free()

static param_entry mygsl::param_entry::make_free ( const std::string &  name_, double  value_, double  step_ = AUTO_STEP  )

static

make_free_max()

static param_entry mygsl::param_entry::make_free_max ( const std::string &  name_, double  max_, double  value_, double  step_ = AUTO_STEP  )

static

make_free_min()

static param_entry mygsl::param_entry::make_free_min ( const std::string &  name_, double  min_, double  value_, double  step_ = AUTO_STEP  )

static

make_free_range()

static param_entry mygsl::param_entry::make_free_range ( const std::string &  name_, double  min_, double  max_, double  value_, double  step_ = AUTO_STEP  )

static

print()

void mygsl::param_entry::print	(	std::ostream &	out_ = std::clog,
		const std::string &	title_ = "Parameter",
		const std::string &	indent_ = ""
	)		const

print_status()

void mygsl::param_entry::print_status

(

std::ostream &

out_ = std::clog

)

const

reset_best_value()

void mygsl::param_entry::reset_best_value

(

)

set_auto_computed()

void mygsl::param_entry::set_auto_computed

(

bool

= true

)

set_best_value()

void mygsl::param_entry::set_best_value

(

const best_value &

best_value_

)

set_comment()

void mygsl::param_entry::set_comment

(

const std::string &

comment_

)

set_max()

void mygsl::param_entry::set_max

(

double

max_

)

set_min()

void mygsl::param_entry::set_min

(

double

min_

)

set_min_max()

void mygsl::param_entry::set_min_max	(	double	min_,
		double	max_
	)

set_name()

void mygsl::param_entry::set_name

(

const std::string &

name_

)

set_no_max()

void mygsl::param_entry::set_no_max

(

)

set_no_min()

void mygsl::param_entry::set_no_min

(

)

set_step()

void mygsl::param_entry::set_step

(

double

step_

)

set_value()

void mygsl::param_entry::set_value

(

double

value_

)

set_value_no_check()

void mygsl::param_entry::set_value_no_check

(

double

value_

)

Member Data Documentation

AUTO_LABEL

const std::string mygsl::param_entry::AUTO_LABEL

static

AUTO_STEP

const double mygsl::param_entry::AUTO_STEP

static

CONST_LABEL

const std::string mygsl::param_entry::CONST_LABEL

static

DEFAULT_STEP

const double mygsl::param_entry::DEFAULT_STEP

static

FREE_LABEL

const std::string mygsl::param_entry::FREE_LABEL

static

NO_MAX_VALUE

const double mygsl::param_entry::NO_MAX_VALUE

static

NO_MIN_VALUE

const double mygsl::param_entry::NO_MIN_VALUE

static

NO_VALUE

const double mygsl::param_entry::NO_VALUE

static

---

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

• bayeux/mygsl/param_entry.h