Bayeux  3.4.1
Core Foundation library for SuperNEMO
Namespaces | Classes | Typedefs | Enumerations | Functions
mygsl Namespace Reference

Top-level namespace of the Bayeux/mygsl module library. More...

Namespaces

 constants
 Nested namespace of the Bayeux/mygsl module library (constants)
 

Classes

class  arithmetic_mean
 Arithmetic mean computing algorithm. More...
 
class  base_sampling
 Base class for all sampling models. More...
 
class  best_value
 A data structure representing a numeric value and its associated error. More...
 
class  composite_function
 Composite function. More...
 
class  convolution_function
 Convolution function. More...
 
class  datapoint
 A serializable (x,y,sigma(y)) triplet. More...
 
class  error
 GSL error handling. More...
 
class  fft_real
 Fast Fourier transform algorithm. More...
 
class  function_with_domain
 Function with interval/domain of definition. More...
 
class  functor_factory
 Factory of functors. More...
 
class  gate_function
 Gate function. More...
 
class  gauss_kernel_smoother
 Gauss kernel smoother. More...
 
class  gaussian_function
 Gaussian function. More...
 
class  gompertz_function
 Gompertz function. More...
 
class  heaviside_function
 
class  histogram
 One dimensional histogram. More...
 
class  histogram_2d
 Two dimensional histogram. More...
 
class  histogram_pool
 A pool of histograms. More...
 
struct  i_kernel_smoother
 Kernel smoother interface. More...
 
class  i_unary_function
 Abstract interface for unary functions : R -> R. More...
 
class  i_unary_function_with_derivative
 Abstract interface for unary functions with derivative. More...
 
class  i_unary_function_with_parameters
 Abstract interface for unary functions with derivative. More...
 
class  identity_function
 The identity function. More...
 
class  interval
 An interval with real bounds. More...
 
class  ioutils
 
class  IstreamManipulatorRef
 
class  linear_combination_function
 A linear combination function. More...
 
class  linear_regression
 The linear regression algorithm. More...
 
class  linear_sampling
 Linear sampling model. More...
 
class  linear_system_solver
 brief Linear system solver algorithm More...
 
class  logistic_function
 Logistic function. More...
 
class  min_max
 Record the min and max values from a set of values. More...
 
class  multi_eval
 Abstract functor from a R^n space to R. More...
 
class  multidimensional_minimization
 Multidimensional minimization algorithm. More...
 
class  multidimensional_minimization_system
 System for multidimensional minimization algorithm. More...
 
class  multimin
 
class  multimin_system
 
class  multiparameter_system
 System with several parameters. More...
 
struct  multiparameter_system_test
 
class  nw_sampled_function_smoother
 Nadaraya-Watson kernel-weigthed average functor. More...
 
class  ode_driver
 
struct  ode_system
 System for ODE solving. More...
 
class  one_dimensional_minimization
 One dimensional minimization algorithm. More...
 
class  one_dimensional_root_solver
 One dimensional root solver algorithm. More...
 
class  OstreamManipulator
 
class  param_entry
 
struct  param_has_name
 
struct  param_is_auto
 
struct  param_is_const
 
struct  param_is_free
 
struct  param_ptr_has_name
 
class  parameter_store
 Store of parameters. More...
 
class  permutation
 
struct  plain_function_entry
 
class  plain_function_wrapper
 Wrapper for C/C++ plain function with signature 'double (*)(double)'. More...
 
class  polynomial
 A real polynomial of arbitrary degree. More...
 
class  prng_state_manager
 A manager that can store the internal states associated to a set of PRNGs addressed with some labels. More...
 
class  product_function
 Product function. More...
 
class  random_utils
 
class  rectangular_function
 Rectangular function (unit pulse) More...
 
class  rng
 Pseudo random number generator. More...
 
struct  sampling
 Constants and resources used for sampling. More...
 
class  seed_manager
 
class  tabulated_function
 Tabulated function. More...
 
class  tabulated_sampling
 Tabulated sampling model. More...
 
class  triangle_function
 General asymmetric triangle function. More...
 
class  unary_eval_from_multi
 
class  unary_function_handle
 Smart handle to an unary function object. More...
 
class  unary_function_promoted_with_numeric_derivative
 Unary functions wrapper that adds numeric derivative. More...
 
struct  version
 Describe the mygsl API version and features. More...
 
class  von_neumann_method
 Von Neumann's rejection method for one dimensional PDF. More...
 
class  weighted_mean
 Weighted mean computing algorithm. More...
 
class  zero_function
 The zero function. More...
 

Typedefs

typedef histogram histogram_1d
 
typedef double(* plain_function_type) (double)
 Typedef for a simple function C-style function : More...
 
typedef double(* plain_function_with_parameters_type) (double, void *)
 Typedef for a function C-style function with anonymous parameters : More...
 
typedef std::map< std::string, plain_function_entryplain_function_dict_type
 Type alias for a dictionary of registered plain functions. More...
 
typedef polynomial polynomial_function
 
typedef seed_manager prng_seed_manager
 WHY IS THIS NEEDED??????? More...
 
typedef datatools::handle< i_unary_functionunary_function_handle_type
 Alias for a handle to an unary function object. More...
 
typedef datatools::handle< const i_unary_functionconst_unary_function_handle_type
 Alias for a handle to a const unary function object. More...
 
typedef std::map< std::string, unary_function_handle_typeunary_function_dict_type
 Alias for dictionary of handles to unary function objects. More...
 

Enumerations

enum  compare_score_type {
  COMPARE_LESS_EQUAL = -2, COMPARE_LESS = -1, COMPARE_EQUAL = 0, COMPARE_GREATER = 1,
  COMPARE_GREATER_EQUAL = 2, COMPARE_UNORDERED = 3
}
 Comparison score. More...
 
enum  bin_mode_type { BIN_MODE_INVALID = 0, BIN_MODE_LINEAR = 1, BIN_MODE_LOG = 2 }
 Histogram binning mode. More...
 
enum  bin_axis_type { BIN_AXIS_INVALID = -1, BIN_AXIS_X = 0, BIN_AXIS_Y = 1 }
 Histogram axis type. More...
 
enum  plain_function_flag { PLAIN_FUNCTION_INVALID = 0, PLAIN_FUNCTION_SIMPLE = 1, PLAIN_FUNCTION_WITH_PARAMS = 2 }
 brief Describe the signature of function More...
 

Functions

std::ostream & operator<< (std::ostream &out_, const best_value &bv_)
 
compare_score_type compare_relative (double x_, double y_, double epsilon_)
 
compare_score_type compare_absolute (double x_, double y_, double epsilon_)
 
bool approximately_equal (double x_, double y_, double epsilon_)
 
bool essentially_equal (double x_, double b, double epsilon_)
 
bool definitely_greater_than (double x_, double y_, double epsilon_)
 
bool definitely_less_than (double x_, double b, double epsilon_)
 
bool nearly_equal (double x_, double y_, double epsilon_)
 
std::ostream & ostream_odouble (std::ostream &os_, const double &x_)
 
OstreamManipulator< double > odouble (const double &x_)
 
std::istream & istream_idouble (std::istream &is_, double &x_)
 
IstreamManipulatorRef< double > idouble (double &x_)
 
bool linear_system_2x2_solve (double a1_, double b1_, double c1_, double a2_, double b2_, double c2_, double &x_, double &y_)
 
void basic_plain_function_registration (plain_function_dict_type &dict_)
 Basic registration of some plain functions in a dictionary. More...
 
void register_plain_function_simple (plain_function_dict_type &dict_, const std::string &name_, const plain_function_type &func_)
 Registration of a plain simple function. More...
 
void register_plain_function_with_params (plain_function_dict_type &dict_, const std::string &name_, const plain_function_with_parameters_type &func_with_params_)
 Registration of a plain function with parameters. More...
 
void tree_dump (const plain_function_dict_type &dict_, std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="")
 Smart print of a dictionary of registered plain functions. More...
 
plain_function_dict_typegrab_plain_function_dict ()
 
const plain_function_dict_typeget_plain_function_dict ()
 
bool plain_function_is_known (const std::string &name_)
 
bool is_plain_function_simple (const std::string &name_)
 
bool is_plain_function_with_params (const std::string &name_)
 
plain_function_type get_simple_function (const std::string &name_)
 
double derivative_central (const i_unary_function &eval_, double x_, double h_, double &abserr_)
 
double derivative_central (const i_unary_function &eval_, double x_, double h_)
 
double derivative_forward (const i_unary_function &eval_, double x_, double h_, double &abserr_)
 
double derivative_forward (const i_unary_function &eval_, double x_, double h_)
 
double derivative_backward (const i_unary_function &eval_, double x_, double h_, double &abserr_)
 
double derivative_backward (const i_unary_function &eval_, double x_, double h_)
 
double derivative (const i_unary_function &eval_, double x_, const interval &domain_, double &abserr_)
 
double derivative (const i_unary_function &eval_, double x_, const interval &domain_)
 
double derivative_central_regular_sampled_2 (double f_1_, double f1_, double h_)
 
double derivative_central_regular_sampled_4 (double f_2_, double f_1_, double f1_, double f2_, double h_)
 
double second_derivative_central_regular_sampled_2 (double f_1_, double f0_, double f1_, double h_)
 
double second_derivative_central_regular_sampled_4 (double f_2_, double f_1_, double f0_, double f1_, double f2_, double h_)
 
double derivative_forward_regular_sampled_1 (double f0_, double f1_, double h_)
 
double derivative_forward_regular_sampled_2 (double f0_, double f1_, double f2_, double h_)
 
double derivative_forward_regular_sampled_3 (double f0_, double f1_, double f2_, double f3_, double h_)
 
double derivative_forward_regular_sampled_4 (double f0_, double f1_, double f2_, double f3_, double f4_, double h_)
 
double second_derivative_forward_regular_sampled_1 (double f0_, double f1_, double f2_, double h_)
 
double second_derivative_forward_regular_sampled_2 (double f0_, double f1_, double f2_, double f3_, double h_)
 
double derivative_backward_regular_sampled_1 (double f_1_, double f0_, double h_)
 
double derivative_backward_regular_sampled_2 (double f_2_, double f_1_, double f0_, double h_)
 
double derivative_backward_regular_sampled_3 (double f_3_, double f_2_, double f_1_, double f0_, double h_)
 
double derivative_backward_regular_sampled_4 (double f_4_, double f_3_, double f_2_, double f_1_, double f0_, double h_)
 
double second_derivative_backward_regular_sampled_1 (double f_2_, double f_1_, double f0_, double h_)
 
double second_derivative_backward_regular_sampled_2 (double f_3_, double f_2_, double f_1_, double f_0_, double h_)
 

Detailed Description

Top-level namespace of the Bayeux/mygsl module library.

mygsl/mygsl_config.h

mygsl/constants.h

Top-level namespace of the Bayeux/mygsl module library

Typedef Documentation

◆ const_unary_function_handle_type

Alias for a handle to a const unary function object.

◆ histogram_1d

◆ plain_function_dict_type

typedef std::map<std::string, plain_function_entry> mygsl::plain_function_dict_type

Type alias for a dictionary of registered plain functions.

◆ plain_function_type

typedef double(* mygsl::plain_function_type) (double)

Typedef for a simple function C-style function :

◆ plain_function_with_parameters_type

typedef double(* mygsl::plain_function_with_parameters_type) (double, void *)

Typedef for a function C-style function with anonymous parameters :

◆ polynomial_function

◆ prng_seed_manager

WHY IS THIS NEEDED???????

◆ unary_function_dict_type

Alias for dictionary of handles to unary function objects.

◆ unary_function_handle_type

Alias for a handle to an unary function object.

Enumeration Type Documentation

◆ bin_axis_type

Histogram axis type.

Enumerator
BIN_AXIS_INVALID 

invalid axis

BIN_AXIS_X 

X axis.

BIN_AXIS_Y 

Y axis.

◆ bin_mode_type

Histogram binning mode.

Enumerator
BIN_MODE_INVALID 

Invalid mode.

BIN_MODE_LINEAR 

Linear.

BIN_MODE_LOG 

Logarithmic.

◆ compare_score_type

Comparison score.

Enumerator
COMPARE_LESS_EQUAL 
COMPARE_LESS 
COMPARE_EQUAL 
COMPARE_GREATER 
COMPARE_GREATER_EQUAL 
COMPARE_UNORDERED 

◆ plain_function_flag

brief Describe the signature of function

Enumerator
PLAIN_FUNCTION_INVALID 

Invalid plain function.

PLAIN_FUNCTION_SIMPLE 

Simple plain function.

PLAIN_FUNCTION_WITH_PARAMS 

Simple plain function.

Function Documentation

◆ approximately_equal()

bool mygsl::approximately_equal ( double  x_,
double  y_,
double  epsilon_ 
)

◆ basic_plain_function_registration()

void mygsl::basic_plain_function_registration ( plain_function_dict_type dict_)

Basic registration of some plain functions in a dictionary.

◆ compare_absolute()

compare_score_type mygsl::compare_absolute ( double  x_,
double  y_,
double  epsilon_ 
)

◆ compare_relative()

compare_score_type mygsl::compare_relative ( double  x_,
double  y_,
double  epsilon_ 
)

◆ definitely_greater_than()

bool mygsl::definitely_greater_than ( double  x_,
double  y_,
double  epsilon_ 
)

◆ definitely_less_than()

bool mygsl::definitely_less_than ( double  x_,
double  b,
double  epsilon_ 
)

◆ derivative() [1/2]

double mygsl::derivative ( const i_unary_function eval_,
double  x_,
const interval domain_,
double &  abserr_ 
)

◆ derivative() [2/2]

double mygsl::derivative ( const i_unary_function eval_,
double  x_,
const interval domain_ 
)

◆ derivative_backward() [1/2]

double mygsl::derivative_backward ( const i_unary_function eval_,
double  x_,
double  h_,
double &  abserr_ 
)

◆ derivative_backward() [2/2]

double mygsl::derivative_backward ( const i_unary_function eval_,
double  x_,
double  h_ 
)

◆ derivative_backward_regular_sampled_1()

double mygsl::derivative_backward_regular_sampled_1 ( double  f_1_,
double  f0_,
double  h_ 
)

◆ derivative_backward_regular_sampled_2()

double mygsl::derivative_backward_regular_sampled_2 ( double  f_2_,
double  f_1_,
double  f0_,
double  h_ 
)

◆ derivative_backward_regular_sampled_3()

double mygsl::derivative_backward_regular_sampled_3 ( double  f_3_,
double  f_2_,
double  f_1_,
double  f0_,
double  h_ 
)

◆ derivative_backward_regular_sampled_4()

double mygsl::derivative_backward_regular_sampled_4 ( double  f_4_,
double  f_3_,
double  f_2_,
double  f_1_,
double  f0_,
double  h_ 
)

◆ derivative_central() [1/2]

double mygsl::derivative_central ( const i_unary_function eval_,
double  x_,
double  h_,
double &  abserr_ 
)

◆ derivative_central() [2/2]

double mygsl::derivative_central ( const i_unary_function eval_,
double  x_,
double  h_ 
)

◆ derivative_central_regular_sampled_2()

double mygsl::derivative_central_regular_sampled_2 ( double  f_1_,
double  f1_,
double  h_ 
)

◆ derivative_central_regular_sampled_4()

double mygsl::derivative_central_regular_sampled_4 ( double  f_2_,
double  f_1_,
double  f1_,
double  f2_,
double  h_ 
)

◆ derivative_forward() [1/2]

double mygsl::derivative_forward ( const i_unary_function eval_,
double  x_,
double  h_,
double &  abserr_ 
)

◆ derivative_forward() [2/2]

double mygsl::derivative_forward ( const i_unary_function eval_,
double  x_,
double  h_ 
)

◆ derivative_forward_regular_sampled_1()

double mygsl::derivative_forward_regular_sampled_1 ( double  f0_,
double  f1_,
double  h_ 
)

◆ derivative_forward_regular_sampled_2()

double mygsl::derivative_forward_regular_sampled_2 ( double  f0_,
double  f1_,
double  f2_,
double  h_ 
)

◆ derivative_forward_regular_sampled_3()

double mygsl::derivative_forward_regular_sampled_3 ( double  f0_,
double  f1_,
double  f2_,
double  f3_,
double  h_ 
)

◆ derivative_forward_regular_sampled_4()

double mygsl::derivative_forward_regular_sampled_4 ( double  f0_,
double  f1_,
double  f2_,
double  f3_,
double  f4_,
double  h_ 
)

◆ essentially_equal()

bool mygsl::essentially_equal ( double  x_,
double  b,
double  epsilon_ 
)

◆ get_plain_function_dict()

const plain_function_dict_type& mygsl::get_plain_function_dict ( )

◆ get_simple_function()

plain_function_type mygsl::get_simple_function ( const std::string &  name_)

◆ grab_plain_function_dict()

plain_function_dict_type& mygsl::grab_plain_function_dict ( )

◆ idouble()

IstreamManipulatorRef<double> mygsl::idouble ( double &  x_)

◆ is_plain_function_simple()

bool mygsl::is_plain_function_simple ( const std::string &  name_)

◆ is_plain_function_with_params()

bool mygsl::is_plain_function_with_params ( const std::string &  name_)

◆ istream_idouble()

std::istream& mygsl::istream_idouble ( std::istream &  is_,
double &  x_ 
)

◆ linear_system_2x2_solve()

bool mygsl::linear_system_2x2_solve ( double  a1_,
double  b1_,
double  c1_,
double  a2_,
double  b2_,
double  c2_,
double &  x_,
double &  y_ 
)

◆ nearly_equal()

bool mygsl::nearly_equal ( double  x_,
double  y_,
double  epsilon_ 
)

◆ odouble()

OstreamManipulator<double> mygsl::odouble ( const double &  x_)

◆ operator<<()

std::ostream& mygsl::operator<< ( std::ostream &  out_,
const best_value bv_ 
)

◆ ostream_odouble()

std::ostream& mygsl::ostream_odouble ( std::ostream &  os_,
const double &  x_ 
)

◆ plain_function_is_known()

bool mygsl::plain_function_is_known ( const std::string &  name_)

◆ register_plain_function_simple()

void mygsl::register_plain_function_simple ( plain_function_dict_type dict_,
const std::string &  name_,
const plain_function_type func_ 
)

Registration of a plain simple function.

◆ register_plain_function_with_params()

void mygsl::register_plain_function_with_params ( plain_function_dict_type dict_,
const std::string &  name_,
const plain_function_with_parameters_type func_with_params_ 
)

Registration of a plain function with parameters.

◆ second_derivative_backward_regular_sampled_1()

double mygsl::second_derivative_backward_regular_sampled_1 ( double  f_2_,
double  f_1_,
double  f0_,
double  h_ 
)

◆ second_derivative_backward_regular_sampled_2()

double mygsl::second_derivative_backward_regular_sampled_2 ( double  f_3_,
double  f_2_,
double  f_1_,
double  f_0_,
double  h_ 
)

◆ second_derivative_central_regular_sampled_2()

double mygsl::second_derivative_central_regular_sampled_2 ( double  f_1_,
double  f0_,
double  f1_,
double  h_ 
)

◆ second_derivative_central_regular_sampled_4()

double mygsl::second_derivative_central_regular_sampled_4 ( double  f_2_,
double  f_1_,
double  f0_,
double  f1_,
double  f2_,
double  h_ 
)

◆ second_derivative_forward_regular_sampled_1()

double mygsl::second_derivative_forward_regular_sampled_1 ( double  f0_,
double  f1_,
double  f2_,
double  h_ 
)

◆ second_derivative_forward_regular_sampled_2()

double mygsl::second_derivative_forward_regular_sampled_2 ( double  f0_,
double  f1_,
double  f2_,
double  f3_,
double  h_ 
)

◆ tree_dump()

void mygsl::tree_dump ( const plain_function_dict_type dict_,
std::ostream &  out_ = std::clog,
const std::string &  title_ = "",
const std::string &  indent_ = "" 
)

Smart print of a dictionary of registered plain functions.