mygsl::tabulated_sampling Class Reference

Tabulated sampling model. More...

#include <bayeux/mygsl/tabulated_sampling.h>

Inheritance diagram for mygsl::tabulated_sampling:

Public Member Functions
	tabulated_sampling ()
	Default constructor. More...
virtual	~tabulated_sampling ()
	Destructor. More...
virtual double	get_min () const
	Return the minimum sample. More...
virtual double	get_max () const
	Return the maximum sample. More...
std::size_t	get_nsteps () const
	Return the number of steps. More...
std::size_t	get_nsamples () const
	Return the number of nsamples. More...
double	get_guard () const
	Return the absolute guard distance around sampling alues. More...
double	get_min_step () const
	Return the minimum step. More...
double	get_max_step () const
	Return the maximum step. More...
virtual bool	is_initialized () const
	Check the initialization status of the sampling. More...
virtual void	initialize (const datatools::properties &)
	Reset/invalidate the sampling. More...
virtual void	reset ()
	Reset/invalidate the sampling. More...
virtual bool	value_to_index (const double x_, std::size_t &index_, sampling::index_classification_type &classification_flags_) const
	Return the index and a classification associated to a value. More...
virtual sampling::index_classification_type	index_to_value (const std::size_t index_, double &value_) const
	Return the value associated to a given index. More...
void	set_guard (const double guard_)
	Set the absolute guard distance around sampling alues. More...
void	append (const double value_)
	Add a tabulated value. More...
void	make_ordered (const std::vector< double > &values_, const double guard_=0.0)
void	lock ()
	Lock the sampling table. More...
Public Member Functions inherited from mygsl::base_sampling
	base_sampling ()
	Default constructor. More...
virtual	~base_sampling ()
	Destructor. More...
bool	value_to_index (const double x_, std::size_t &left_sample_index_) const
	Return the left sample index associated to a value. More...
virtual bool	has_index (const double value_, const std::size_t sample_index_) const
	Check if the checked value is associated to the given sample index. More...
std::size_t	get_first_index () const
	Return the first sample index. More...
std::size_t	get_last_index () const
	Return the last sample index. More...
std::size_t	get_first_step_index () const
	Return the first step index. More...
std::size_t	get_last_step_index () const
	Return the last step index. More...
bool	index_is_valid (const std::size_t sample_index_) const
	Check if a sample index is valid. More...
bool	value_is_valid (const double value_) const
	Check if a value is in the sampling domain. More...
bool	compute_step_bounds (const std::size_t step_index_, double &min_, double &max_) const
	Compute the bounds of step with given index. More...

Detailed Description

Tabulated sampling model.

Constructor & Destructor Documentation

tabulated_sampling()

mygsl::tabulated_sampling::tabulated_sampling

(

)

Default constructor.

~tabulated_sampling()

virtual mygsl::tabulated_sampling::~tabulated_sampling ( )

virtual

Destructor.

Member Function Documentation

append()

void mygsl::tabulated_sampling::append

(

const double

value_

)

Add a tabulated value.

get_guard()

double mygsl::tabulated_sampling::get_guard

(

)

const

Return the absolute guard distance around sampling alues.

get_max()

virtual double mygsl::tabulated_sampling::get_max ( ) const

virtual

Return the maximum sample.

Implements mygsl::base_sampling.

get_max_step()

double mygsl::tabulated_sampling::get_max_step

(

)

const

Return the maximum step.

get_min()

virtual double mygsl::tabulated_sampling::get_min ( ) const

virtual

Return the minimum sample.

Implements mygsl::base_sampling.

get_min_step()

double mygsl::tabulated_sampling::get_min_step

(

)

const

Return the minimum step.

get_nsamples()

std::size_t mygsl::tabulated_sampling::get_nsamples ( ) const

virtual

Return the number of nsamples.

Implements mygsl::base_sampling.

get_nsteps()

std::size_t mygsl::tabulated_sampling::get_nsteps ( ) const

virtual

Return the number of steps.

Implements mygsl::base_sampling.

index_to_value()

virtual sampling::index_classification_type mygsl::tabulated_sampling::index_to_value ( const std::size_t  index_, double &  value_  ) const

virtual

Return the value associated to a given index.

Implements mygsl::base_sampling.

initialize()

virtual void mygsl::tabulated_sampling::initialize ( const datatools::properties &  )

virtual

Reset/invalidate the sampling.

Implements mygsl::base_sampling.

is_initialized()

virtual bool mygsl::tabulated_sampling::is_initialized ( ) const

virtual

Check the initialization status of the sampling.

Implements mygsl::base_sampling.

lock()

void mygsl::tabulated_sampling::lock

(

)

Lock the sampling table.

make_ordered()

void mygsl::tabulated_sampling::make_ordered	(	const std::vector< double > &	values_,
		const double	guard_ = 0.0
	)

Build sampling from a ordered list of values

                  0      1      2             nsteps-2  nsteps-1
---------------+-----+------+--------+ - - - +--------+---------+---------> x
              val0  val1   val2     val3   valN-2   valN-2    valN-1
              min                                              max

reset()

virtual void mygsl::tabulated_sampling::reset ( )

virtual

Reset/invalidate the sampling.

Implements mygsl::base_sampling.

set_guard()

void mygsl::tabulated_sampling::set_guard

(

const double

guard_

)

Set the absolute guard distance around sampling alues.

value_to_index()

virtual bool mygsl::tabulated_sampling::value_to_index ( const double  x_, std::size_t &  index_, sampling::index_classification_type &  classification_flags_  ) const

virtual

Return the index and a classification associated to a value.

Implements mygsl::base_sampling.

---

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

• bayeux/mygsl/tabulated_sampling.h