Collaboration diagram for Enumerated types:

Enumerations
enum	TasDREAM::TypeSamplingForm { TasDREAM::regform , TasDREAM::logform }
	Describes whether sampling should be done with the regular or logarithm form of the probability density. More...

enum	TasDREAM::TypeDistribution { TasDREAM::dist_uniform , TasDREAM::dist_gaussian , TasDREAM::dist_exponential , TasDREAM::dist_beta , TasDREAM::dist_gamma , TasDREAM::dist_none , TasDREAM::dist_null }
	Indicates a specific probability distribution for the associated function. More...

Variables
constexpr double	TasDREAM::DreamMaths::pi = TasGrid::Maths::pi
	Dream copy of TasGrid::Maths::pi. More...

Detailed Description

The Enumerate types used in the external and internal API of the DREAM module.

Enumeration Type Documentation

◆ TypeSamplingForm

enum TasDREAM::TypeSamplingForm

Describes whether sampling should be done with the regular or logarithm form of the probability density.

Probability distributions with very localized support will have values close to zero over most of the sampling domain. Sampling using the logarithm of the probability density can be more stable, when operations with very small numbers cause problems. In most cases, it is up to the user to provide the appropriate values, but the sampling algorithm needs to know which form is being used.

Enumerator
regform	Use the standard form for the probability density.
logform	Use the logarithm form for the probability density.

◆ TypeDistribution

enum TasDREAM::TypeDistribution

Indicates a specific probability distribution for the associated function.

Used to instantiate the getDensity() variadric template. See the template documentation for the specific formulas.

Enumerator
dist_uniform	Uniform distribution.
dist_gaussian	Gaussian or Normal distribution defined by mean and variance.
dist_exponential	Exponential distribution (i.e., special case of the Gamma distribution).
dist_beta	Beta distribution, corresponds to Gauss-Jacobi sparse grid rule TasGrid::rule_gaussjacobi.
dist_gamma	Gamma distribution, corresponds to Gauss-Laguerre sparse grid rule TasGrid::rule_gausslaguerre.
dist_none	Indicates a no-distribution (no correction).
dist_null	Indicates I/O error or unspecified distribution.

Variable Documentation

◆ pi

constexpr double TasDREAM::DreamMaths::pi = TasGrid::Maths::pi

constexpr

Dream copy of TasGrid::Maths::pi.