fix typos in documentation

kthohr · Jun 12, 2020 · b6dd459 · b6dd459
1 parent 9b8cb67
commit b6dd459
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 21 deletions.
diff --git 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<double> 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<eT>& 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<mT,tT>& 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<eT,To>& 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
@@ -139,7 +139,7 @@ qgamma_vec(const eT* __stats_pointer_settings__ vals_in, const T1 shape_par, con
  * Example:
  * \code{.cpp}
  * std::vector<double> 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<eT>& 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<mT,tT>& 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<eT,To>& 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
@@ -139,7 +139,7 @@ qinvgamma_vec(const eT* __stats_pointer_settings__ vals_in, const T1 shape_par,
  * Example:
  * \code{.cpp}
  * std::vector<double> 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<eT>& 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<mT,tT>& 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<eT,To>& 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
@@ -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
@@ -151,7 +151,7 @@ qnorm_vec(const eT* __stats_pointer_settings__ vals_in, const T1 mu_par, const T
  * Example:
  * \code{.cpp}
  * std::vector<double> 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<eT>& 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<mT,tT>& 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<eT,To>& 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
@@ -127,7 +127,7 @@ qweibull_vec(const eT* __stats_pointer_settings__ vals_in, const T1 shape_par, c
  * Example:
  * \code{.cpp}
  * std::vector<double> 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<eT>& 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<mT,tT>& 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<eT,To>& 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
  */