Skip to content

Commit ec0d83c

Browse files
authored
docs: update namespace table of contents
PR-URL: #10003 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 75a4928 commit ec0d83c

2 files changed

Lines changed: 81 additions & 0 deletions

File tree

lib/node_modules/@stdlib/stats/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,15 +117,38 @@ Other statistical functions included are:
117117
- <span class="signature">[`maxBy( x[, options], clbk[, thisArg] )`][@stdlib/stats/max-by]</span><span class="delimiter">: </span><span class="description">compute the maximum value along one or more ndarray dimensions according to a callback function.</span>
118118
- <span class="signature">[`max( x[, options] )`][@stdlib/stats/max]</span><span class="delimiter">: </span><span class="description">compute the maximum value along one or more ndarray dimensions.</span>
119119
- <span class="signature">[`maxabs( x[, options] )`][@stdlib/stats/maxabs]</span><span class="delimiter">: </span><span class="description">compute the maximum absolute value along one or more ndarray dimensions.</span>
120+
- <span class="signature">[`maxsorted( x[, options] )`][@stdlib/stats/maxsorted]</span><span class="delimiter">: </span><span class="description">compute the maximum value along one or more sorted ndarray dimensions.</span>
120121
- <span class="signature">[`mean( x[, options] )`][@stdlib/stats/mean]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions.</span>
122+
- <span class="signature">[`meankbn( x[, options] )`][@stdlib/stats/meankbn]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions using an improved Kahan–Babuška algorithm.</span>
123+
- <span class="signature">[`meankbn2( x[, options] )`][@stdlib/stats/meankbn2]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions using a second-order iterative Kahan–Babuška algorithm.</span>
124+
- <span class="signature">[`meanors( x[, options] )`][@stdlib/stats/meanors]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions using ordinary recursive summation.</span>
125+
- <span class="signature">[`meanpn( x[, options] )`][@stdlib/stats/meanpn]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions using a two-pass error correction algorithm.</span>
126+
- <span class="signature">[`meanpw( x[, options] )`][@stdlib/stats/meanpw]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions using pairwise summation.</span>
127+
- <span class="signature">[`meanwd( x[, options] )`][@stdlib/stats/meanwd]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions using Welford's algorithm.</span>
128+
- <span class="signature">[`mediansorted( x[, options] )`][@stdlib/stats/mediansorted]</span><span class="delimiter">: </span><span class="description">compute the median value along one or more sorted ndarray dimensions.</span>
129+
- <span class="signature">[`midrangeBy( x[, options], clbk[, thisArg] )`][@stdlib/stats/midrange-by]</span><span class="delimiter">: </span><span class="description">compute the mid-range along one or more ndarray dimensions according to a callback function.</span>
130+
- <span class="signature">[`midrange( x[, options] )`][@stdlib/stats/midrange]</span><span class="delimiter">: </span><span class="description">compute the mid-range along one or more ndarray dimensions.</span>
121131
- <span class="signature">[`minBy( x[, options], clbk[, thisArg] )`][@stdlib/stats/min-by]</span><span class="delimiter">: </span><span class="description">compute the minimum value along one or more ndarray dimensions according to a callback function.</span>
122132
- <span class="signature">[`min( x[, options] )`][@stdlib/stats/min]</span><span class="delimiter">: </span><span class="description">compute the minimum value along one or more ndarray dimensions.</span>
123133
- <span class="signature">[`minabs( x[, options] )`][@stdlib/stats/minabs]</span><span class="delimiter">: </span><span class="description">compute the minimum absolute value along one or more ndarray dimensions.</span>
134+
- <span class="signature">[`minsorted( x[, options] )`][@stdlib/stats/minsorted]</span><span class="delimiter">: </span><span class="description">compute the minimum value along one or more sorted ndarray dimensions.</span>
135+
- <span class="signature">[`nanmaxBy( x[, options], clbk[, thisArg] )`][@stdlib/stats/nanmax-by]</span><span class="delimiter">: </span><span class="description">compute the maximum value along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.</span>
124136
- <span class="signature">[`nanmax( x[, options] )`][@stdlib/stats/nanmax]</span><span class="delimiter">: </span><span class="description">compute the maximum value along one or more ndarray dimensions, ignoring `NaN` values.</span>
137+
- <span class="signature">[`nanmaxabs( x[, options] )`][@stdlib/stats/nanmaxabs]</span><span class="delimiter">: </span><span class="description">compute the maximum absolute value along one or more ndarray dimensions, ignoring `NaN` values.</span>
125138
- <span class="signature">[`nanmean( x[, options] )`][@stdlib/stats/nanmean]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions, ignoring `NaN` values.</span>
139+
- <span class="signature">[`nanmeanors( x[, options] )`][@stdlib/stats/nanmeanors]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions, ignoring `NaN` values and using ordinary recursive summation.</span>
140+
- <span class="signature">[`nanmeanpn( x[, options] )`][@stdlib/stats/nanmeanpn]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions, ignoring `NaN` values and using a two-pass error correction algorithm.</span>
141+
- <span class="signature">[`nanmeanwd( x[, options] )`][@stdlib/stats/nanmeanwd]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean along one or more ndarray dimensions, ignoring `NaN` values and using Welford's algorithm.</span>
142+
- <span class="signature">[`nanmidrangeBy( x[, options], clbk[, thisArg] )`][@stdlib/stats/nanmidrange-by]</span><span class="delimiter">: </span><span class="description">compute the **mid-range** along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.</span>
143+
- <span class="signature">[`nanminBy( x[, options], clbk[, thisArg] )`][@stdlib/stats/nanmin-by]</span><span class="delimiter">: </span><span class="description">compute the minimum value along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.</span>
126144
- <span class="signature">[`nanmin( x[, options] )`][@stdlib/stats/nanmin]</span><span class="delimiter">: </span><span class="description">compute the minimum value along one or more ndarray dimensions, ignoring `NaN` values.</span>
145+
- <span class="signature">[`nanminabs( x[, options] )`][@stdlib/stats/nanminabs]</span><span class="delimiter">: </span><span class="description">compute the minimum absolute value along one or more ndarray dimensions, ignoring `NaN` values.</span>
146+
- <span class="signature">[`nanrangeBy( x[, options], clbk[, thisArg] )`][@stdlib/stats/nanrange-by]</span><span class="delimiter">: </span><span class="description">compute the **range** along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.</span>
147+
- <span class="signature">[`nanrange( x[, options] )`][@stdlib/stats/nanrange]</span><span class="delimiter">: </span><span class="description">compute the range along one or more ndarray dimensions, ignoring `NaN` values.</span>
127148
- <span class="signature">[`padjust( pvals, method[, comparisons] )`][@stdlib/stats/padjust]</span><span class="delimiter">: </span><span class="description">adjust supplied p-values for multiple comparisons.</span>
149+
- <span class="signature">[`rangeBy( x[, options], clbk[, thisArg] )`][@stdlib/stats/range-by]</span><span class="delimiter">: </span><span class="description">compute the **range** along one or more ndarray dimensions according to a callback function.</span>
128150
- <span class="signature">[`range( x[, options] )`][@stdlib/stats/range]</span><span class="delimiter">: </span><span class="description">compute the range along one or more ndarray dimensions.</span>
151+
- <span class="signature">[`rangeabs( x[, options] )`][@stdlib/stats/rangeabs]</span><span class="delimiter">: </span><span class="description">compute the range of absolute values along one or more ndarray dimensions.</span>
129152
- <span class="signature">[`ranks( arr[, opts] )`][@stdlib/stats/ranks]</span><span class="delimiter">: </span><span class="description">compute ranks for values of an array-like object.</span>
130153

131154
</div>
@@ -183,24 +206,70 @@ console.log( objectKeys( statistics ) );
183206

184207
[@stdlib/stats/maxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/maxabs
185208

209+
[@stdlib/stats/maxsorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/maxsorted
210+
186211
[@stdlib/stats/mean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/mean
187212

213+
[@stdlib/stats/meankbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/meankbn
214+
215+
[@stdlib/stats/meankbn2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/meankbn2
216+
217+
[@stdlib/stats/meanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/meanors
218+
219+
[@stdlib/stats/meanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/meanpn
220+
221+
[@stdlib/stats/meanpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/meanpw
222+
223+
[@stdlib/stats/meanwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/meanwd
224+
225+
[@stdlib/stats/mediansorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/mediansorted
226+
227+
[@stdlib/stats/midrange-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/midrange-by
228+
229+
[@stdlib/stats/midrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/midrange
230+
188231
[@stdlib/stats/min-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/min-by
189232

190233
[@stdlib/stats/min]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/min
191234

192235
[@stdlib/stats/minabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/minabs
193236

237+
[@stdlib/stats/minsorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/minsorted
238+
239+
[@stdlib/stats/nanmax-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmax-by
240+
194241
[@stdlib/stats/nanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmax
195242

243+
[@stdlib/stats/nanmaxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmaxabs
244+
196245
[@stdlib/stats/nanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmean
197246

247+
[@stdlib/stats/nanmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmeanors
248+
249+
[@stdlib/stats/nanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmeanpn
250+
251+
[@stdlib/stats/nanmeanwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmeanwd
252+
253+
[@stdlib/stats/nanmidrange-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmidrange-by
254+
255+
[@stdlib/stats/nanmin-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmin-by
256+
198257
[@stdlib/stats/nanmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanmin
199258

259+
[@stdlib/stats/nanminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanminabs
260+
261+
[@stdlib/stats/nanrange-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanrange-by
262+
263+
[@stdlib/stats/nanrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/nanrange
264+
200265
[@stdlib/stats/padjust]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/padjust
201266

267+
[@stdlib/stats/range-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/range-by
268+
202269
[@stdlib/stats/range]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/range
203270

271+
[@stdlib/stats/rangeabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/rangeabs
272+
204273
[@stdlib/stats/ranks]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/ranks
205274

206275
[@stdlib/stats/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base

lib/node_modules/@stdlib/stats/base/ndarray/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,9 @@ The namespace exposes the following APIs:
9494
- <span class="signature">[`dstdev( arrays )`][@stdlib/stats/base/ndarray/dstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional double-precision floating-point ndarray.</span>
9595
- <span class="signature">[`dstdevch( arrays )`][@stdlib/stats/base/ndarray/dstdevch]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass trial mean algorithm.</span>
9696
- <span class="signature">[`dstdevpn( arrays )`][@stdlib/stats/base/ndarray/dstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using a two-pass algorithm.</span>
97+
- <span class="signature">[`dstdevtk( arrays )`][@stdlib/stats/base/ndarray/dstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass textbook algorithm.</span>
9798
- <span class="signature">[`dstdevwd( arrays )`][@stdlib/stats/base/ndarray/dstdevwd]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using Welford's algorithm.</span>
99+
- <span class="signature">[`dstdevyc( arrays )`][@stdlib/stats/base/ndarray/dstdevyc]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer.</span>
98100
- <span class="signature">[`dztest( arrays )`][@stdlib/stats/base/ndarray/dztest]</span><span class="delimiter">: </span><span class="description">compute a one-sample Z-test for a one-dimensional double-precision floating-point ndarray.</span>
99101
- <span class="signature">[`dztest2( arrays )`][@stdlib/stats/base/ndarray/dztest2]</span><span class="delimiter">: </span><span class="description">compute a two-sample Z-test for two one-dimensional double-precision floating-point ndarrays.</span>
100102
- <span class="signature">[`maxBy( arrays, clbk[, thisArg ] )`][@stdlib/stats/base/ndarray/max-by]</span><span class="delimiter">: </span><span class="description">compute the maximum value of a one-dimensional ndarray via a callback function.</span>
@@ -189,7 +191,9 @@ The namespace exposes the following APIs:
189191
- <span class="signature">[`sstdev( arrays )`][@stdlib/stats/base/ndarray/sstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional single-precision floating-point ndarray.</span>
190192
- <span class="signature">[`sstdevch( arrays )`][@stdlib/stats/base/ndarray/sstdevch]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm.</span>
191193
- <span class="signature">[`sstdevpn( arrays )`][@stdlib/stats/base/ndarray/sstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional single-precision floating-point ndarray using a two-pass algorithm.</span>
194+
- <span class="signature">[`sstdevtk( arrays )`][@stdlib/stats/base/ndarray/sstdevtk]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional single-precision floating-point ndarray using a one-pass textbook algorithm.</span>
192195
- <span class="signature">[`sstdevwd( arrays )`][@stdlib/stats/base/ndarray/sstdevwd]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional single-precision floating-point ndarray using Welford's algorithm.</span>
196+
- <span class="signature">[`sstdevyc( arrays )`][@stdlib/stats/base/ndarray/sstdevyc]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional single-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer.</span>
193197
- <span class="signature">[`stdev( arrays )`][@stdlib/stats/base/ndarray/stdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional ndarray.</span>
194198
- <span class="signature">[`stdevch( arrays )`][@stdlib/stats/base/ndarray/stdevch]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional ndarray using a one-pass trial mean algorithm.</span>
195199
- <span class="signature">[`stdevpn( arrays )`][@stdlib/stats/base/ndarray/stdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional ndarray using a two-pass algorithm.</span>
@@ -343,8 +347,12 @@ console.log( objectKeys( ns ) );
343347

344348
[@stdlib/stats/base/ndarray/dstdevpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dstdevpn
345349

350+
[@stdlib/stats/base/ndarray/dstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dstdevtk
351+
346352
[@stdlib/stats/base/ndarray/dstdevwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dstdevwd
347353

354+
[@stdlib/stats/base/ndarray/dstdevyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dstdevyc
355+
348356
[@stdlib/stats/base/ndarray/dztest]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dztest
349357

350358
[@stdlib/stats/base/ndarray/dztest2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dztest2
@@ -533,8 +541,12 @@ console.log( objectKeys( ns ) );
533541

534542
[@stdlib/stats/base/ndarray/sstdevpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/sstdevpn
535543

544+
[@stdlib/stats/base/ndarray/sstdevtk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/sstdevtk
545+
536546
[@stdlib/stats/base/ndarray/sstdevwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/sstdevwd
537547

548+
[@stdlib/stats/base/ndarray/sstdevyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/sstdevyc
549+
538550
[@stdlib/stats/base/ndarray/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/stdev
539551

540552
[@stdlib/stats/base/ndarray/stdevch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/stdevch

0 commit comments

Comments
 (0)