Skip to content

Commit b6dd459

Browse files
committed
fix typos in documentation
1 parent 9b8cb67 commit b6dd459

File tree

6 files changed

+21
-21
lines changed

6 files changed

+21
-21
lines changed

include/stats_incl/quant/qf.ipp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ qf_vec(const eT* __stats_pointer_settings__ vals_in, const T1 df1_par, const T2
149149
* Example:
150150
* \code{.cpp}
151151
* std::vector<double> x = {0.3, 0.5, 0.9};
152-
* stats::qf(x,3.0,2.0,false);
152+
* stats::qf(x,3.0,2.0);
153153
* \endcode
154154
*/
155155

@@ -176,7 +176,7 @@ qf(const std::vector<eT>& x, const T1 df1_par, const T2 df2_par)
176176
* \code{.cpp}
177177
* arma::mat X = { {0.2, 0.7, 0.1},
178178
* {0.9, 0.3, 0.87} };
179-
* stats::qf(X,3.0,2.0,false);
179+
* stats::qf(X,3.0,2.0);
180180
* \endcode
181181
*/
182182

@@ -209,7 +209,7 @@ qf(const ArmaGen<mT,tT>& X, const T1 df1_par, const T2 df2_par)
209209
*
210210
* Example:
211211
* \code{.cpp}
212-
* stats::qf(X,3.0,2.0,false);
212+
* stats::qf(X,3.0,2.0);
213213
* \endcode
214214
*/
215215

@@ -234,7 +234,7 @@ qf(const BlazeMat<eT,To>& X, const T1 df1_par, const T2 df2_par)
234234
*
235235
* Example:
236236
* \code{.cpp}
237-
* stats::qf(X,3.0,2.0,false);
237+
* stats::qf(X,3.0,2.0);
238238
* \endcode
239239
*/
240240

include/stats_incl/quant/qgamma.ipp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ qgamma_vec(const eT* __stats_pointer_settings__ vals_in, const T1 shape_par, con
139139
* Example:
140140
* \code{.cpp}
141141
* std::vector<double> x = {0.3, 0.5, 0.9};
142-
* stats::qgamma(x,3.0,2.0,false);
142+
* stats::qgamma(x,3.0,2.0);
143143
* \endcode
144144
*/
145145

@@ -166,7 +166,7 @@ qgamma(const std::vector<eT>& x, const T1 shape_par, const T2 scale_par)
166166
* \code{.cpp}
167167
* arma::mat X = { {0.2, 0.7, 0.1},
168168
* {0.9, 0.3, 0.87} };
169-
* stats::qgamma(X,3.0,2.0,false);
169+
* stats::qgamma(X,3.0,2.0);
170170
* \endcode
171171
*/
172172

@@ -199,7 +199,7 @@ qgamma(const ArmaGen<mT,tT>& X, const T1 shape_par, const T2 scale_par)
199199
*
200200
* Example:
201201
* \code{.cpp}
202-
* stats::qgamma(X,3.0,2.0,false);
202+
* stats::qgamma(X,3.0,2.0);
203203
* \endcode
204204
*/
205205

@@ -224,7 +224,7 @@ qgamma(const BlazeMat<eT,To>& X, const T1 shape_par, const T2 scale_par)
224224
*
225225
* Example:
226226
* \code{.cpp}
227-
* stats::qgamma(X,3.0,2.0,false);
227+
* stats::qgamma(X,3.0,2.0);
228228
* \endcode
229229
*/
230230

include/stats_incl/quant/qinvgamma.ipp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ qinvgamma_vec(const eT* __stats_pointer_settings__ vals_in, const T1 shape_par,
139139
* Example:
140140
* \code{.cpp}
141141
* std::vector<double> x = {0.3, 0.5, 0.9};
142-
* stats::qinvgamma(x,3.0,2.0,false);
142+
* stats::qinvgamma(x,3.0,2.0);
143143
* \endcode
144144
*/
145145

@@ -166,7 +166,7 @@ qinvgamma(const std::vector<eT>& x, const T1 shape_par, const T2 rate_par)
166166
* \code{.cpp}
167167
* arma::mat X = { {0.2, 0.7, 0.1},
168168
* {0.9, 0.3, 0.87} };
169-
* stats::qinvgamma(X,3.0,2.0,false);
169+
* stats::qinvgamma(X,3.0,2.0);
170170
* \endcode
171171
*/
172172

@@ -199,7 +199,7 @@ qinvgamma(const ArmaGen<mT,tT>& X, const T1 shape_par, const T2 rate_par)
199199
*
200200
* Example:
201201
* \code{.cpp}
202-
* stats::qinvgamma(X,3.0,2.0,false);
202+
* stats::qinvgamma(X,3.0,2.0);
203203
* \endcode
204204
*/
205205

@@ -224,7 +224,7 @@ qinvgamma(const BlazeMat<eT,To>& X, const T1 shape_par, const T2 rate_par)
224224
*
225225
* Example:
226226
* \code{.cpp}
227-
* stats::qinvgamma(X,3.0,2.0,false);
227+
* stats::qinvgamma(X,3.0,2.0);
228228
* \endcode
229229
*/
230230

include/stats_incl/quant/qlaplace.ipp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ noexcept
8585
* @param mu_par the location parameter, a real-valued input.
8686
* @param sigma_par the scale parameter, a real-valued input.
8787
*
88-
* @return the density function evaluated at \c p.
88+
* @return the quantile function evaluated at \c p.
8989
*
9090
* Example:
9191
* \code{.cpp} stats::qlaplace(0.7,1.0,2.0); \endcode

include/stats_incl/quant/qnorm.ipp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ qnorm_vec(const eT* __stats_pointer_settings__ vals_in, const T1 mu_par, const T
151151
* Example:
152152
* \code{.cpp}
153153
* std::vector<double> x = {0.1, 0.3, 0.7};
154-
* stats::qnorm(x,1.0,2.0,false);
154+
* stats::qnorm(x,1.0,2.0);
155155
* \endcode
156156
*/
157157

@@ -178,7 +178,7 @@ qnorm(const std::vector<eT>& x, const T1 mu_par, const T2 sigma_par)
178178
* \code{.cpp}
179179
* arma::mat X = { {0.2, 0.7, 0.9},
180180
* {0.1, 0.8, 0.3} };
181-
* stats::qnorm(X,1.0,1.0,false);
181+
* stats::qnorm(X,1.0,1.0);
182182
* \endcode
183183
*/
184184

@@ -211,7 +211,7 @@ qnorm(const ArmaGen<mT,tT>& X, const T1 mu_par, const T2 sigma_par)
211211
*
212212
* Example:
213213
* \code{.cpp}
214-
* stats::qnorm(X,1.0,1.0,false);
214+
* stats::qnorm(X,1.0,1.0);
215215
* \endcode
216216
*/
217217

@@ -236,7 +236,7 @@ qnorm(const BlazeMat<eT,To>& X, const T1 mu_par, const T2 sigma_par)
236236
*
237237
* Example:
238238
* \code{.cpp}
239-
* stats::qnorm(X,1.0,1.0,false);
239+
* stats::qnorm(X,1.0,1.0);
240240
* \endcode
241241
*/
242242

include/stats_incl/quant/qweibull.ipp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ qweibull_vec(const eT* __stats_pointer_settings__ vals_in, const T1 shape_par, c
127127
* Example:
128128
* \code{.cpp}
129129
* std::vector<double> x = {0.3, 0.5, 0.9};
130-
* stats::qweibull(x,3.0,2.0,false);
130+
* stats::qweibull(x,3.0,2.0);
131131
* \endcode
132132
*/
133133

@@ -154,7 +154,7 @@ qweibull(const std::vector<eT>& x, const T1 shape_par, const T2 scale_par)
154154
* \code{.cpp}
155155
* arma::mat X = { {0.2, 0.7, 0.1},
156156
* {0.9, 0.3, 0.87} };
157-
* stats::qweibull(X,3.0,2.0,false);
157+
* stats::qweibull(X,3.0,2.0);
158158
* \endcode
159159
*/
160160

@@ -187,7 +187,7 @@ qweibull(const ArmaGen<mT,tT>& X, const T1 shape_par, const T2 scale_par)
187187
*
188188
* Example:
189189
* \code{.cpp}
190-
* stats::qweibull(X,3.0,2.0,false);
190+
* stats::qweibull(X,3.0,2.0);
191191
* \endcode
192192
*/
193193

@@ -212,7 +212,7 @@ qweibull(const BlazeMat<eT,To>& X, const T1 shape_par, const T2 scale_par)
212212
*
213213
* Example:
214214
* \code{.cpp}
215-
* stats::qweibull(X,3.0,2.0,false);
215+
* stats::qweibull(X,3.0,2.0);
216216
* \endcode
217217
*/
218218

0 commit comments

Comments
 (0)