mygsl::i_unary_function_with_parameters Class Reference

Abstract interface for unary functions with derivative. More...

#include <bayeux/mygsl/i_unary_function_with_parameters.h>

Inheritance diagram for mygsl::i_unary_function_with_parameters:

Public Member Functions
	i_unary_function_with_parameters ()
	Default constructor. More...
	i_unary_function_with_parameters (const parameter_store &store_)
	Constructor. More...
virtual	~i_unary_function_with_parameters ()
	Destructor. More...
virtual bool	is_initialized () const
	Check initialization status. More...
virtual void	initialize (const datatools::properties &config_, const unary_function_dict_type &functors_)
	Initialization from a container of parameters and a dictionary of functors. More...
virtual void	reset ()
	Reset the functor. More...
bool	has_parameter_store () const
	Check if an external parameter store is set. More...
void	set_parameter_store (const parameter_store &store_)
	Set an external parameter store. More...
void	reset_parameter_store ()
	Reset an external parameter store. More...
void	register_requested_parameter (const std::string &parameter_name_, datatools::basic_type parameter_type_)
	Register requested parameter. More...
int	get_parameter_index (const std::string &parameter_name_) const
	Return the registration index of a parameter given its name. More...
bool	is_parameter_set (int param_index_) const
	Check if a parameter at given index is set. More...
void	fetch_parameter (int param_index_, bool &value_) const
	Fetch a boolean parameter at given index. More...
void	fetch_parameter (int param_index_, int &value_) const
	Fetch an integer parameter at given index. More...
void	fetch_parameter (int param_index_, double &value_) const
	Fetch a real parameter at given index. More...
void	fetch_parameter (int param_index_, std::string &value_) const
	Fetch a string parameter at given index. More...
virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	Smart printing. More...
void	update_parameters ()
	Update parameter. More...
Public Member Functions inherited from mygsl::i_unary_function
	i_unary_function (double epsilon_=0.0)
	Constructor. More...
virtual	~i_unary_function ()
	Destructor. More...
virtual bool	has_explicit_domain_of_definition () const
	Check if the function has an explicit domain of definition (default: false) More...
virtual bool	is_in_domain_of_definition (double x_) const
	Check if a value is in the domain of definition of the function (default: true) More...
virtual double	eval (double x_) const
	The function evaluation method. More...
double	evaluate (double x_) const
	The function evaluation method. More...
virtual double	eval_no_check (double x_) const
	The function evaluation method with any value check. More...
virtual double	get_non_zero_domain_min () const
	The minimum bound of the non-zero domain (default is minus infinity) More...
bool	has_non_zero_domain_min () const
	Check the minimum bound of the non-zero domain. More...
virtual double	get_non_zero_domain_max () const
	The maximum bound of the non-zero domain (default is plus infinity) More...
bool	has_non_zero_domain_max () const
	Check the maximum bound of the non-zero domain. More...
bool	is_in_non_zero_domain (double x_) const
	Check if a value is in the non-zero domain. More...
bool	is_in_zero_domain (double x_) const
	Check if a value is in the zero domain. More...
bool	has_zero_domain () const
	Check if the functor has an explicit zero domain. More...
double	operator() (double x_) const
	Standard C++ functor interface. More...
void	write_ascii (std::ostream &fout_, double min_, double max_, unsigned int nsamples_, int x_precision_=16, int fx_precision_=16, uint32_t options_=wo_default) const
	Write the (x,y=f(x)) value pairs in an ASCII stream : More...
void	write_ascii_with_units (std::ostream &fout_, double min_, double max_, unsigned int nsamples_, double x_unit_, double fx_unit_, int x_precision_=16, int fx_precision_=16, uint32_t options_=wo_default) const
	Write the (x,y=f(x)) value pairs in an ASCII stream : More...
void	write_ascii_file (const std::string &filename_, double min_, double max_, unsigned int nsamples_, int x_precision_=16, int fx_precision_=16, uint32_t options_=wo_default) const
	Write the (x,y=f(x)) value pairs in an ASCII file (typical Gnuplot input) : More...
void	write_ascii_file_with_units (const std::string &filename_, double min_, double max_, unsigned int nsamples_, const std::string &x_unit_label_, const std::string &fx_unit_label_, int x_precision_=16, int fx_precision_=16, uint32_t options_=wo_default) const
	Write the (x,y=f(x)) value pairs in an ASCII file (typical Gnuplot input) : More...
void	set_epsilon (double)
	Set the precision. More...
double	get_epsilon () const
	Return the precision. More...
void	initialize_simple ()
	Simple initialization. More...
void	initialize_standalone (const datatools::properties &config_)
	Initialization from a container of parameters. More...
Public Member Functions inherited from datatools::i_tree_dumpable
	i_tree_dumpable ()
	Constructor. More...
virtual	~i_tree_dumpable ()
	Destructor. More...
virtual void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
	Main new interface method for printing. More...
void	print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
	Printing with jsonized options. More...
void	print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
	Printing with jsonized options. More...
void	tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const
void	tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const
void	smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const

Protected Member Functions
double	_eval (double x_) const
	Evaluation. More...
virtual double	_eval_from_parameters (double x_) const =0
	Evaluation from parameters of the store. More...
virtual void	_at_parameters_change ()=0
	Action to perform when some parameters of the store have changed. More...
Protected Member Functions inherited from mygsl::i_unary_function
void	_base_initialize (const datatools::properties &config_, const unary_function_dict_type &functors_)
void	_base_reset ()
void	_compute_auto_epsilon ()
void	_set_defaults ()
	Set defaults attributes. More...

Additional Inherited Members
Public Types inherited from mygsl::i_unary_function
enum	write_options_type {   wo_none = 0, wo_data_index = 0x1, wo_skip_nan = 0x2, wo_skip_inf = 0x4,   wo_skip_onzd = 0x8, wo_skip_odod = 0x10, wo_append = 0x20, wo_default = wo_none }
	Options for writing sampled function in an ASCII stream. More...
Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
	Enumeration for standard output streams. More...
Static Public Member Functions inherited from mygsl::i_unary_function
static double	g_function (double x_, void *functor_)
	A generic static function to feed the GSL gsl_function interface: More...
Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree &	empty_options ()
static boost::property_tree::ptree	make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)
static std::ostream &	last_skip_tag (std::ostream &out_)
static std::ostream &	skip_tag (std::ostream &out_)
static std::ostream &	last_tag (std::ostream &out_)
static std::ostream &	tag (std::ostream &out_)
Static Public Attributes inherited from mygsl::i_unary_function
static const double	DEFAULT_EPSILON
	Default error. More...
static const double	AUTO_EPSILON
	Value for automatic computation of the error. More...

Detailed Description

Abstract interface for unary functions with derivative.

Constructor & Destructor Documentation

i_unary_function_with_parameters() [1/2]

mygsl::i_unary_function_with_parameters::i_unary_function_with_parameters

(

)

Default constructor.

i_unary_function_with_parameters() [2/2]

mygsl::i_unary_function_with_parameters::i_unary_function_with_parameters

(

const parameter_store &

store_

)

Constructor.

~i_unary_function_with_parameters()

virtual mygsl::i_unary_function_with_parameters::~i_unary_function_with_parameters ( )

virtual

Destructor.

Member Function Documentation

_at_parameters_change()

virtual void mygsl::i_unary_function_with_parameters::_at_parameters_change ( )

protectedpure virtual

Action to perform when some parameters of the store have changed.

_eval()

double mygsl::i_unary_function_with_parameters::_eval ( double  x_ ) const

protectedvirtual

Evaluation.

Implements mygsl::i_unary_function.

_eval_from_parameters()

virtual double mygsl::i_unary_function_with_parameters::_eval_from_parameters ( double  x_ ) const

protectedpure virtual

Evaluation from parameters of the store.

fetch_parameter() [1/4]

void mygsl::i_unary_function_with_parameters::fetch_parameter	(	int	param_index_,
		bool &	value_
	)		const

Fetch a boolean parameter at given index.

fetch_parameter() [2/4]

void mygsl::i_unary_function_with_parameters::fetch_parameter	(	int	param_index_,
		int &	value_
	)		const

Fetch an integer parameter at given index.

fetch_parameter() [3/4]

void mygsl::i_unary_function_with_parameters::fetch_parameter	(	int	param_index_,
		double &	value_
	)		const

Fetch a real parameter at given index.

fetch_parameter() [4/4]

void mygsl::i_unary_function_with_parameters::fetch_parameter	(	int	param_index_,
		std::string &	value_
	)		const

Fetch a string parameter at given index.

get_parameter_index()

int mygsl::i_unary_function_with_parameters::get_parameter_index

(

const std::string &

parameter_name_

)

const

Return the registration index of a parameter given its name.

has_parameter_store()

bool mygsl::i_unary_function_with_parameters::has_parameter_store

(

)

const

Check if an external parameter store is set.

initialize()

virtual void mygsl::i_unary_function_with_parameters::initialize ( const datatools::properties &  config_, const unary_function_dict_type &  functors_  )

virtual

Initialization from a container of parameters and a dictionary of functors.

Reimplemented from mygsl::i_unary_function.

is_initialized()

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

virtual

Check initialization status.

Reimplemented from mygsl::i_unary_function.

is_parameter_set()

bool mygsl::i_unary_function_with_parameters::is_parameter_set

(

int

param_index_

)

const

Check if a parameter at given index is set.

register_requested_parameter()

void mygsl::i_unary_function_with_parameters::register_requested_parameter	(	const std::string &	parameter_name_,
		datatools::basic_type	parameter_type_
	)

Register requested parameter.

reset()

virtual void mygsl::i_unary_function_with_parameters::reset ( )

virtual

Reset the functor.

Reimplemented from mygsl::i_unary_function.

reset_parameter_store()

void mygsl::i_unary_function_with_parameters::reset_parameter_store

(

)

Reset an external parameter store.

set_parameter_store()

void mygsl::i_unary_function_with_parameters::set_parameter_store

(

const parameter_store &

store_

)

Set an external parameter store.

tree_dump()

virtual void mygsl::i_unary_function_with_parameters::tree_dump ( std::ostream &  out_ = std::clog, const std::string &  title_ = "", const std::string &  indent_ = "", bool  inherit_ = false  ) const

virtual

Smart printing.

Reimplemented from mygsl::i_unary_function.

update_parameters()

void mygsl::i_unary_function_with_parameters::update_parameters ( )

virtual

Update parameter.

Implements mygsl::parameter_store::i_subscriber.

---

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

• bayeux/mygsl/i_unary_function_with_parameters.h