ExRandom  3.0
exrandom::aux_info Class Reference

Some auxiliary functions related to normal and exponential distributions. More...

#include <exrandom/aux_info.hpp>

Static Public Member Functions

static double pi ()
 
static double cumulative_uniform (double x)
 
static double cumulative_exponential (double x)
 
static double cumulative_normal (double x)
 
static double uniform_entropy ()
 
static double exponential_entropy ()
 
static double normal_entropy ()
 
static double uniform_mean_exponent ()
 
static double exponential_mean_exponent ()
 
static double normal_mean_exponent ()
 
template<typename param_type >
static double discrete_normal_prob (const param_type &p, int i, double norm=1)
 
template<typename param_type >
static double discrete_normal_norm (const param_type &p, double &H)
 

Detailed Description

Some auxiliary functions related to normal and exponential distributions.

These are implemented as static functions. These are only needed to implement the chi-squared tests and to compute the cost and toll of the algorithms.

Definition at line 28 of file aux_info.hpp.

Member Function Documentation

◆ pi()

static double exrandom::aux_info::pi ( )
inlinestatic
Returns
the value of pi.

Definition at line 33 of file aux_info.hpp.

◆ cumulative_uniform()

static double exrandom::aux_info::cumulative_uniform ( double  x)
inlinestatic

The cumulative uniform function.

Parameters
x
Returns
the cumulative probabilty at x.
Examples
chisq_test.cpp.

Definition at line 41 of file aux_info.hpp.

◆ cumulative_exponential()

static double exrandom::aux_info::cumulative_exponential ( double  x)
inlinestatic

The cumulative exponential function.

Parameters
x
Returns
the cumulative probabilty at x.
Examples
chisq_test.cpp.

Definition at line 50 of file aux_info.hpp.

◆ cumulative_normal()

static double exrandom::aux_info::cumulative_normal ( double  x)
inlinestatic

The cumulative normal function.

Parameters
x
Returns
the cumulative probabilty at x.
Examples
chisq_test.cpp.

Definition at line 60 of file aux_info.hpp.

◆ uniform_entropy()

static double exrandom::aux_info::uniform_entropy ( )
inlinestatic
Returns
the entropy of the unit uniform distribution.
Examples
count_bits.cpp.

Definition at line 66 of file aux_info.hpp.

◆ exponential_entropy()

static double exrandom::aux_info::exponential_entropy ( )
inlinestatic
Returns
the entropy of the unit exponential distribution.
Examples
count_bits.cpp.

Definition at line 71 of file aux_info.hpp.

◆ normal_entropy()

static double exrandom::aux_info::normal_entropy ( )
inlinestatic
Returns
the entropy of the unit exponential distribution.
Examples
count_bits.cpp.

Definition at line 76 of file aux_info.hpp.

◆ uniform_mean_exponent()

static double exrandom::aux_info::uniform_mean_exponent ( )
inlinestatic
Returns
the mean exponent of the floating point representation of a unit uniform deviate.
Examples
count_bits.cpp.

Definition at line 82 of file aux_info.hpp.

◆ exponential_mean_exponent()

static double exrandom::aux_info::exponential_mean_exponent ( )
inlinestatic
Returns
the mean exponent of the floating point representation of a unit exponential deviate.
Examples
count_bits.cpp.

Definition at line 88 of file aux_info.hpp.

◆ normal_mean_exponent()

static double exrandom::aux_info::normal_mean_exponent ( )
inlinestatic
Returns
the mean exponent of the floating point representation of a unit normal deviate.
Examples
count_bits.cpp.

Definition at line 104 of file aux_info.hpp.

◆ discrete_normal_prob()

template<typename param_type >
static double exrandom::aux_info::discrete_normal_prob ( const param_type &  p,
int  i,
double  norm = 1 
)
inlinestatic
Template Parameters
param_typethe type of the discrete_normal_dist::param_type.
Parameters
pthe parameters for the discrete_normal_dist.
i
normthe normalizing constant.
Returns
the probabilty at i (unnormalized if norm = 1).
Examples
chisq_test.cpp.

Definition at line 126 of file aux_info.hpp.

◆ discrete_normal_norm()

template<typename param_type >
static double exrandom::aux_info::discrete_normal_norm ( const param_type &  p,
double &  H 
)
inlinestatic
Template Parameters
param_typethe type of the discrete_normal_dist::param_type.
Parameters
pthe parameters for the discrete_normal_dist.
Hthe entropy of the distribution.
Returns
the normalizing constant.
Examples
chisq_test.cpp, and discrete_count_bits.cpp.

Definition at line 139 of file aux_info.hpp.


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