From b6dd459c10a88c7ea04693c007e9e35820c5d9ad Mon Sep 17 00:00:00 2001 From: Keith O'Hara Date: Fri, 12 Jun 2020 10:44:57 -0700 Subject: [PATCH] fix typos in documentation --- include/stats_incl/quant/qf.ipp | 8 ++++---- include/stats_incl/quant/qgamma.ipp | 8 ++++---- include/stats_incl/quant/qinvgamma.ipp | 8 ++++---- include/stats_incl/quant/qlaplace.ipp | 2 +- include/stats_incl/quant/qnorm.ipp | 8 ++++---- include/stats_incl/quant/qweibull.ipp | 8 ++++---- 6 files changed, 21 insertions(+), 21 deletions(-) diff --git a/include/stats_incl/quant/qf.ipp b/include/stats_incl/quant/qf.ipp index b66c556..c9e887f 100644 --- a/include/stats_incl/quant/qf.ipp +++ b/include/stats_incl/quant/qf.ipp @@ -149,7 +149,7 @@ qf_vec(const eT* __stats_pointer_settings__ vals_in, const T1 df1_par, const T2 * Example: * \code{.cpp} * std::vector x = {0.3, 0.5, 0.9}; - * stats::qf(x,3.0,2.0,false); + * stats::qf(x,3.0,2.0); * \endcode */ @@ -176,7 +176,7 @@ qf(const std::vector& x, const T1 df1_par, const T2 df2_par) * \code{.cpp} * arma::mat X = { {0.2, 0.7, 0.1}, * {0.9, 0.3, 0.87} }; - * stats::qf(X,3.0,2.0,false); + * stats::qf(X,3.0,2.0); * \endcode */ @@ -209,7 +209,7 @@ qf(const ArmaGen& X, const T1 df1_par, const T2 df2_par) * * Example: * \code{.cpp} - * stats::qf(X,3.0,2.0,false); + * stats::qf(X,3.0,2.0); * \endcode */ @@ -234,7 +234,7 @@ qf(const BlazeMat& X, const T1 df1_par, const T2 df2_par) * * Example: * \code{.cpp} - * stats::qf(X,3.0,2.0,false); + * stats::qf(X,3.0,2.0); * \endcode */ diff --git a/include/stats_incl/quant/qgamma.ipp b/include/stats_incl/quant/qgamma.ipp index 91511fa..b212a63 100644 --- a/include/stats_incl/quant/qgamma.ipp +++ b/include/stats_incl/quant/qgamma.ipp @@ -139,7 +139,7 @@ qgamma_vec(const eT* __stats_pointer_settings__ vals_in, const T1 shape_par, con * Example: * \code{.cpp} * std::vector x = {0.3, 0.5, 0.9}; - * stats::qgamma(x,3.0,2.0,false); + * stats::qgamma(x,3.0,2.0); * \endcode */ @@ -166,7 +166,7 @@ qgamma(const std::vector& x, const T1 shape_par, const T2 scale_par) * \code{.cpp} * arma::mat X = { {0.2, 0.7, 0.1}, * {0.9, 0.3, 0.87} }; - * stats::qgamma(X,3.0,2.0,false); + * stats::qgamma(X,3.0,2.0); * \endcode */ @@ -199,7 +199,7 @@ qgamma(const ArmaGen& X, const T1 shape_par, const T2 scale_par) * * Example: * \code{.cpp} - * stats::qgamma(X,3.0,2.0,false); + * stats::qgamma(X,3.0,2.0); * \endcode */ @@ -224,7 +224,7 @@ qgamma(const BlazeMat& X, const T1 shape_par, const T2 scale_par) * * Example: * \code{.cpp} - * stats::qgamma(X,3.0,2.0,false); + * stats::qgamma(X,3.0,2.0); * \endcode */ diff --git a/include/stats_incl/quant/qinvgamma.ipp b/include/stats_incl/quant/qinvgamma.ipp index efb1670..97e5ce1 100644 --- a/include/stats_incl/quant/qinvgamma.ipp +++ b/include/stats_incl/quant/qinvgamma.ipp @@ -139,7 +139,7 @@ qinvgamma_vec(const eT* __stats_pointer_settings__ vals_in, const T1 shape_par, * Example: * \code{.cpp} * std::vector x = {0.3, 0.5, 0.9}; - * stats::qinvgamma(x,3.0,2.0,false); + * stats::qinvgamma(x,3.0,2.0); * \endcode */ @@ -166,7 +166,7 @@ qinvgamma(const std::vector& x, const T1 shape_par, const T2 rate_par) * \code{.cpp} * arma::mat X = { {0.2, 0.7, 0.1}, * {0.9, 0.3, 0.87} }; - * stats::qinvgamma(X,3.0,2.0,false); + * stats::qinvgamma(X,3.0,2.0); * \endcode */ @@ -199,7 +199,7 @@ qinvgamma(const ArmaGen& X, const T1 shape_par, const T2 rate_par) * * Example: * \code{.cpp} - * stats::qinvgamma(X,3.0,2.0,false); + * stats::qinvgamma(X,3.0,2.0); * \endcode */ @@ -224,7 +224,7 @@ qinvgamma(const BlazeMat& X, const T1 shape_par, const T2 rate_par) * * Example: * \code{.cpp} - * stats::qinvgamma(X,3.0,2.0,false); + * stats::qinvgamma(X,3.0,2.0); * \endcode */ diff --git a/include/stats_incl/quant/qlaplace.ipp b/include/stats_incl/quant/qlaplace.ipp index 09451a9..791cea9 100644 --- a/include/stats_incl/quant/qlaplace.ipp +++ b/include/stats_incl/quant/qlaplace.ipp @@ -85,7 +85,7 @@ noexcept * @param mu_par the location parameter, a real-valued input. * @param sigma_par the scale parameter, a real-valued input. * - * @return the density function evaluated at \c p. + * @return the quantile function evaluated at \c p. * * Example: * \code{.cpp} stats::qlaplace(0.7,1.0,2.0); \endcode diff --git a/include/stats_incl/quant/qnorm.ipp b/include/stats_incl/quant/qnorm.ipp index d1b350a..518110f 100644 --- a/include/stats_incl/quant/qnorm.ipp +++ b/include/stats_incl/quant/qnorm.ipp @@ -151,7 +151,7 @@ qnorm_vec(const eT* __stats_pointer_settings__ vals_in, const T1 mu_par, const T * Example: * \code{.cpp} * std::vector x = {0.1, 0.3, 0.7}; - * stats::qnorm(x,1.0,2.0,false); + * stats::qnorm(x,1.0,2.0); * \endcode */ @@ -178,7 +178,7 @@ qnorm(const std::vector& x, const T1 mu_par, const T2 sigma_par) * \code{.cpp} * arma::mat X = { {0.2, 0.7, 0.9}, * {0.1, 0.8, 0.3} }; - * stats::qnorm(X,1.0,1.0,false); + * stats::qnorm(X,1.0,1.0); * \endcode */ @@ -211,7 +211,7 @@ qnorm(const ArmaGen& X, const T1 mu_par, const T2 sigma_par) * * Example: * \code{.cpp} - * stats::qnorm(X,1.0,1.0,false); + * stats::qnorm(X,1.0,1.0); * \endcode */ @@ -236,7 +236,7 @@ qnorm(const BlazeMat& X, const T1 mu_par, const T2 sigma_par) * * Example: * \code{.cpp} - * stats::qnorm(X,1.0,1.0,false); + * stats::qnorm(X,1.0,1.0); * \endcode */ diff --git a/include/stats_incl/quant/qweibull.ipp b/include/stats_incl/quant/qweibull.ipp index 7034c1d..d815ab3 100644 --- a/include/stats_incl/quant/qweibull.ipp +++ b/include/stats_incl/quant/qweibull.ipp @@ -127,7 +127,7 @@ qweibull_vec(const eT* __stats_pointer_settings__ vals_in, const T1 shape_par, c * Example: * \code{.cpp} * std::vector x = {0.3, 0.5, 0.9}; - * stats::qweibull(x,3.0,2.0,false); + * stats::qweibull(x,3.0,2.0); * \endcode */ @@ -154,7 +154,7 @@ qweibull(const std::vector& x, const T1 shape_par, const T2 scale_par) * \code{.cpp} * arma::mat X = { {0.2, 0.7, 0.1}, * {0.9, 0.3, 0.87} }; - * stats::qweibull(X,3.0,2.0,false); + * stats::qweibull(X,3.0,2.0); * \endcode */ @@ -187,7 +187,7 @@ qweibull(const ArmaGen& X, const T1 shape_par, const T2 scale_par) * * Example: * \code{.cpp} - * stats::qweibull(X,3.0,2.0,false); + * stats::qweibull(X,3.0,2.0); * \endcode */ @@ -212,7 +212,7 @@ qweibull(const BlazeMat& X, const T1 shape_par, const T2 scale_par) * * Example: * \code{.cpp} - * stats::qweibull(X,3.0,2.0,false); + * stats::qweibull(X,3.0,2.0); * \endcode */