mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
The Exponentially Modified Gaussian Distribution

Utilities for working with the Exponentially Modified Gaussian Distribution

Functions

template<typename realT >
realT mx::math::func::expModGaussian (realT x, realT mu, realT sigma, realT lambda)
 The Exponentially Modified Gaussian at a point. More...
 
template<typename realT >
realT mx::math::func::expModGaussianMean (realT mu, realT lambda)
 The Mean of the Exponentially Modified Gaussian. More...
 
template<typename realT >
realT mx::math::func::expModGaussianVariance (realT sigma, realT lambda)
 The Variance of the Exponentially Modified Gaussian. More...
 
template<typename realT >
realT mx::math::func::expModGaussianMode (realT mu, realT sigma, realT lambda)
 The Mode of the Exponentially Modified Gaussian. More...
 

Function Documentation

◆ expModGaussian()

template<typename realT >
realT mx::math::func::expModGaussian ( realT  x,
realT  mu,
realT  sigma,
realT  lambda 
)

The Exponentially Modified Gaussian at a point.

Calculates the value of the Exponentially Modified Gaussian distribution at a location specified by x.

Template Parameters
realTa real floating point type
Returns
the value of the Exponentially Modified Gaussian distribution at x.
Parameters
[in]xthe location at which to calculate the distribution
[in]muthe mean parameter
[in]sigmathe standard deviation
[in]lambdathe rate of decay

Definition at line 54 of file expModGaussian.hpp.

References mx::astro::constants::sigma().

◆ expModGaussianMean()

template<typename realT >
realT mx::math::func::expModGaussianMean ( realT  mu,
realT  lambda 
)

The Mean of the Exponentially Modified Gaussian.

Calculates the mean of the Exponentially Modified Gaussian distribution.

Template Parameters
realTa real floating point type
Returns
the mean of the Exponentially Modified Gaussian.
Parameters
[in]muthe mean parameter
[in]lambdathe rate of decay

Definition at line 74 of file expModGaussian.hpp.

Referenced by mx::math::func::expModGaussianMode().

◆ expModGaussianMode()

template<typename realT >
realT mx::math::func::expModGaussianMode ( realT  mu,
realT  sigma,
realT  lambda 
)

The Mode of the Exponentially Modified Gaussian.

Calculates the mode of the Exponentially Modified Gaussian distribution. This is done iteratively with Brent's method.

Template Parameters
realTa real floating point type
Returns
the mode of the Exponentially Modified Gaussian.
Parameters
[in]muthe mean parameter
[in]sigmathe standard deviation
[in]lambdathe rate of decay

Definition at line 123 of file expModGaussian.hpp.

References mx::math::func::expModGaussianMean(), mx::math::func::expModGaussianVariance(), and mx::astro::constants::sigma().

◆ expModGaussianVariance()

template<typename realT >
realT mx::math::func::expModGaussianVariance ( realT  sigma,
realT  lambda 
)

The Variance of the Exponentially Modified Gaussian.

Calculates the variance of the Exponentially Modified Gaussian distribution.

Template Parameters
realTa real floating point type
Returns
the variance of the Exponentially Modified Gaussian.
Parameters
[in]sigmathe standard deviation
[in]lambdathe rate of decay

Definition at line 92 of file expModGaussian.hpp.

References mx::astro::constants::sigma().

Referenced by mx::math::func::expModGaussianMode().