Log-Normal Distribution¶
Table of contents
Density Function¶
The density function of the log-Normal distribution:
Methods for scalar input, as well as for vector/matrix input, are listed below.
Scalar Input¶
-
template<typename T1, typename T2, typename T3>
constexpr common_return_t<T1, T2, T3> dlnorm(const T1 x, const T2 mu_par, const T3 sigma_par, const bool log_form = false) noexcept¶ Density function of the Log-Normal distribution.
Example:
stats::dlnorm(2.0,1.0,2.0,false);
- Parameters
x – a real-valued input.
mu_par – the mean parameter, a real-valued input.
sigma_par – the standard deviation parameter, a real-valued input.
log_form – return the log-density or the true form.
- Returns
the density function evaluated at
x
.
Vector/Matrix Input¶
STL Containers¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>>
inline std::vector<rT> dlnorm(const std::vector<eT> &x, const T1 mu_par, const T2 sigma_par, const bool log_form = false)¶ Density function of the Log-Normal distribution.
Example:
std::vector<double> x = {0.0, 1.0, 2.0}; stats::dlnorm(x,1.0,2.0,false);
- Parameters
x – a standard vector.
mu_par – the mean parameter, a real-valued input.
sigma_par – the standard deviation parameter, a real-valued input.
log_form – return the log-density or the true form.
- Returns
a vector of density function values corresponding to the elements of
x
.
Armadillo¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>>
inline ArmaMat<rT> dlnorm(const ArmaMat<eT> &X, const T1 mu_par, const T2 sigma_par, const bool log_form = false)¶ Density function of the Log-Normal distribution.
Example:
arma::mat X = { {0.2, 1.7, 0.1}, {0.9, 4.0, 0.3} }; stats::dlnorm(X,1.0,1.0,false);
- Parameters
X – a matrix of input values.
mu_par – the mean parameter, a real-valued input.
sigma_par – the standard deviation parameter, a real-valued input.
log_form – return the log-density or the true form.
- Returns
a matrix of density function values corresponding to the elements of
X
.
Blaze¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>, bool To = blaze::columnMajor>
inline BlazeMat<rT, To> dlnorm(const BlazeMat<eT, To> &X, const T1 mu_par, const T2 sigma_par, const bool log_form = false)¶ Density function of the Log-Normal distribution.
Example:
stats::dlnorm(X,1.0,1.0,false);
- Parameters
X – a matrix of input values.
mu_par – the mean parameter, a real-valued input.
sigma_par – the standard deviation parameter, a real-valued input.
log_form – return the log-density or the true form.
- Returns
a matrix of density function values corresponding to the elements of
X
.
Eigen¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>, int iTr = Eigen::Dynamic, int iTc = Eigen::Dynamic>
inline EigenMat<rT, iTr, iTc> dlnorm(const EigenMat<eT, iTr, iTc> &X, const T1 mu_par, const T2 sigma_par, const bool log_form = false)¶ Density function of the Log-Normal distribution.
Example:
stats::dlnorm(X,1.0,1.0,false);
- Parameters
X – a matrix of input values.
mu_par – the mean parameter, a real-valued input.
sigma_par – the standard deviation parameter, a real-valued input.
log_form – return the log-density or the true form.
- Returns
a matrix of density function values corresponding to the elements of
X
.
Cumulative Distribution Function¶
The cumulative distribution function of the log-Normal distribution:
where \(\text{erf}(\cdot)\) denotes the Gaussian error function.
Methods for scalar input, as well as for vector/matrix input, are listed below.
Scalar Input¶
-
template<typename T1, typename T2, typename T3>
constexpr common_return_t<T1, T2, T3> plnorm(const T1 x, const T2 mu_par, const T3 sigma_par, const bool log_form = false) noexcept¶ Distribution function of the Log-Normal distribution.
Example:
stats::plnorm(2.0,1.0,2.0,false);
- Parameters
x – a real-valued input.
mu_par – the mean parameter, a real-valued input.
sigma_par – the standard deviation parameter, a real-valued input.
log_form – return the log-probability or the true form.
- Returns
the cumulative distribution function evaluated at
x
.
Vector/Matrix Input¶
STL Containers¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>>
inline std::vector<rT> plnorm(const std::vector<eT> &x, const T1 mu_par, const T2 sigma_par, const bool log_form = false)¶ Distribution function of the Log-Normal distribution.
Example:
std::vector<double> x = {0.0, 1.0, 2.0}; stats::plnorm(x,1.0,2.0,false);
- Parameters
x – a standard vector.
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
log_form – return the log-probability or the true form.
- Returns
a vector of CDF values corresponding to the elements of
x
.
Armadillo¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>>
inline ArmaMat<rT> plnorm(const ArmaMat<eT> &X, const T1 mu_par, const T2 sigma_par, const bool log_form = false)¶ Distribution function of the Log-Normal distribution.
Example:
arma::mat X = { {0.2, 1.7, 0.1}, {0.9, 4.0, 0.3} }; stats::plnorm(X,1.0,1.0,false);
- Parameters
X – a matrix of input values.
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
log_form – return the log-probability or the true form.
- Returns
a matrix of CDF values corresponding to the elements of
X
.
Blaze¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>, bool To = blaze::columnMajor>
inline BlazeMat<rT, To> plnorm(const BlazeMat<eT, To> &X, const T1 mu_par, const T2 sigma_par, const bool log_form = false)¶ Distribution function of the Log-Normal distribution.
Example:
stats::plnorm(X,1.0,1.0,false);
- Parameters
X – a matrix of input values.
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
log_form – return the log-probability or the true form.
- Returns
a matrix of CDF values corresponding to the elements of
X
.
Eigen¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>, int iTr = Eigen::Dynamic, int iTc = Eigen::Dynamic>
inline EigenMat<rT, iTr, iTc> plnorm(const EigenMat<eT, iTr, iTc> &X, const T1 mu_par, const T2 sigma_par, const bool log_form = false)¶ Distribution function of the Log-Normal distribution.
Example:
stats::plnorm(X,1.0,1.0,false);
- Parameters
X – a matrix of input values.
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
log_form – return the log-probability or the true form.
- Returns
a matrix of CDF values corresponding to the elements of
X
.
Quantile Function¶
The quantile function of the log-Normal distribution:
where \(\text{erf}^{-1}(\cdot)\) denotes the inverse Gaussian error function.
Methods for scalar input, as well as for vector/matrix input, are listed below.
Scalar Input¶
-
template<typename T1, typename T2, typename T3>
constexpr common_return_t<T1, T2, T3> qlnorm(const T1 p, const T2 mu_par, const T3 sigma_par) noexcept¶ Quantile function of the Log-Normal distribution.
Example:
stats::qlnorm(0.6,1.0,2.0);
- Parameters
p – a real-valued input.
mu_par – the mean parameter, a real-valued input.
sigma_par – the standard deviation parameter, a real-valued input.
- Returns
the quantile function evaluated at
p
.
Vector/Matrix Input¶
STL Containers¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>>
inline std::vector<rT> qlnorm(const std::vector<eT> &x, const T1 mu_par, const T2 sigma_par)¶ Quantile function of the Log-Normal distribution.
Example:
std::vector<double> x = {0.1, 0.3, 0.7}; stats::qlnorm(x,1.0,2.0);
- Parameters
x – a standard vector.
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
- Returns
a vector of quantile values corresponding to the elements of
x
.
Armadillo¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>>
inline ArmaMat<rT> qlnorm(const ArmaMat<eT> &X, const T1 mu_par, const T2 sigma_par)¶ Quantile function of the Log-Normal distribution.
Example:
arma::mat X = { {0.2, 0.7, 0.9}, {0.1, 0.8, 0.3} }; stats::qlnorm(X,1.0,1.0);
- Parameters
X – a matrix of input values.
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
- Returns
a matrix of quantile values corresponding to the elements of
X
.
Blaze¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>, bool To = blaze::columnMajor>
inline BlazeMat<rT, To> qlnorm(const BlazeMat<eT, To> &X, const T1 mu_par, const T2 sigma_par)¶ Quantile function of the Log-Normal distribution.
Example:
stats::qlnorm(X,1.0,1.0);
- Parameters
X – a matrix of input values.
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
- Returns
a matrix of quantile values corresponding to the elements of
X
.
Eigen¶
-
template<typename eT, typename T1, typename T2, typename rT = common_return_t<eT, T1, T2>, int iTr = Eigen::Dynamic, int iTc = Eigen::Dynamic>
inline EigenMat<rT, iTr, iTc> qlnorm(const EigenMat<eT, iTr, iTc> &X, const T1 mu_par, const T2 sigma_par)¶ Quantile function of the Log-Normal distribution.
Example:
stats::qlnorm(X,1.0,1.0);
- Parameters
X – a matrix of input values.
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
- Returns
a matrix of quantile values corresponding to the elements of
X
.
Random Sampling¶
Random sampling for the log-Normal distribution is achieved by simulating \(X \sim N(\mu, \sigma^2)\), then returning
Scalar Output¶
Random number engines
-
template<typename T1, typename T2>
inline common_return_t<T1, T2> rlnorm(const T1 mu_par, const T2 sigma_par, rand_engine_t &engine)¶ Random sampling function for the Log-Normal distribution.
Example:
stats::rand_engine_t engine(1776); stats::rlnorm(1.0,2.0,engine);
- Parameters
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
engine – a random engine, passed by reference.
- Returns
a pseudo-random draw from the Log-Normal distribution.
Seed values
-
template<typename T1, typename T2>
inline common_return_t<T1, T2> rlnorm(const T1 mu_par, const T2 sigma_par, const ullint_t seed_val = std::random_device{}())¶ Random sampling function for the Log-Normal distribution.
Example:
stats::rlnorm(1.0,2.0,1776);
- Parameters
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
seed_val – initialize the random engine with a non-negative integral-valued seed.
- Returns
a pseudo-random draw from the Log-Normal distribution.
Vector/Matrix Output¶
Random number engines
-
template<typename mT, typename T1, typename T2>
inline mT rlnorm(const ullint_t n, const ullint_t k, const T1 mu_par, const T2 sigma_par, rand_engine_t &engine)¶ Random matrix sampling function for the Log-Normal distribution.
Example:
stats::rand_engine_t engine(1776); // std::vector stats::rlnorm<std::vector<double>>(5,4,1.0,2.0,engine); // Armadillo matrix stats::rlnorm<arma::mat>(5,4,1.0,2.0,engine); // Blaze dynamic matrix stats::rlnorm<blaze::DynamicMatrix<double,blaze::columnMajor>>(5,4,1.0,2.0,engine); // Eigen dynamic matrix stats::rlnorm<Eigen::MatrixXd>(5,4,1.0,2.0,engine);
Note
This function requires template instantiation; acceptable output types include:
std::vector
, with element typefloat
,double
, etc., as well as Armadillo, Blaze, and Eigen dense matrices.- Parameters
n – the number of output rows
k – the number of output columns
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
engine – a random engine, passed by reference.
- Returns
a matrix of pseudo-random draws from the Log-Normal distribution.
Seed values
-
template<typename mT, typename T1, typename T2>
inline mT rlnorm(const ullint_t n, const ullint_t k, const T1 mu_par, const T2 sigma_par, const ullint_t seed_val = std::random_device{}())¶ Random matrix sampling function for the Log-Normal distribution.
Example:
// std::vector stats::rlnorm<std::vector<double>>(5,4,1.0,2.0); // Armadillo matrix stats::rlnorm<arma::mat>(5,4,1.0,2.0); // Blaze dynamic matrix stats::rlnorm<blaze::DynamicMatrix<double,blaze::columnMajor>>(5,4,1.0,2.0); // Eigen dynamic matrix stats::rlnorm<Eigen::MatrixXd>(5,4,1.0,2.0);
Note
This function requires template instantiation; acceptable output types include:
std::vector
, with element typefloat
,double
, etc., as well as Armadillo, Blaze, and Eigen dense matrices.- Parameters
n – the number of output rows
k – the number of output columns
mu_par – the location parameter, a real-valued input.
sigma_par – the scale parameter, a real-valued input.
seed_val – initialize the random engine with a non-negative integral-valued seed.
- Returns
a matrix of pseudo-random draws from the Log-Normal distribution.