Skip to content

Commit a135b0c

Browse files
authored
docs: update namespace table of contents
PR-URL: #11421 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 08b7638 commit a135b0c

File tree

1 file changed

+30
-0
lines changed
  • lib/node_modules/@stdlib/stats/strided

1 file changed

+30
-0
lines changed

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ The namespace exports the following:
9090
- <span class="signature">[`dmskmidrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dmskmidrange]</span><span class="delimiter">: </span><span class="description">calculate the mid-range of a double-precision floating-point strided array according to a mask.</span>
9191
- <span class="signature">[`dmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dmskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a double-precision floating-point strided array according to a mask.</span>
9292
- <span class="signature">[`dmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dmskrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a double-precision floating-point strided array according to a mask.</span>
93+
- <span class="signature">[`dnancount( N, x, strideX )`][@stdlib/stats/strided/dnancount]</span><span class="delimiter">: </span><span class="description">calculate the number of non-`NaN` elements in a double-precision floating-point strided array.</span>
9394
- <span class="signature">[`dnanmax( N, x, strideX )`][@stdlib/stats/strided/dnanmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a double-precision floating-point strided array, ignoring `NaN` values.</span>
9495
- <span class="signature">[`dnanmaxabs( N, x, strideX )`][@stdlib/stats/strided/dnanmaxabs]</span><span class="delimiter">: </span><span class="description">calculate the maximum absolute value of a double-precision floating-point strided array, ignoring `NaN` values.</span>
9596
- <span class="signature">[`dnanmean( N, x, strideX )`][@stdlib/stats/strided/dnanmean]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values.</span>
@@ -101,10 +102,13 @@ The namespace exports the following:
101102
- <span class="signature">[`dnanmin( N, x, strideX )`][@stdlib/stats/strided/dnanmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a double-precision floating-point strided array, ignoring `NaN` values.</span>
102103
- <span class="signature">[`dnanminabs( N, x, strideX )`][@stdlib/stats/strided/dnanminabs]</span><span class="delimiter">: </span><span class="description">calculate the minimum absolute value of a double-precision floating-point strided array, ignoring `NaN` values.</span>
103104
- <span class="signature">[`dnanmskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a double-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
105+
- <span class="signature">[`dnanmskmaxabs( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskmaxabs]</span><span class="delimiter">: </span><span class="description">calculate the maximum absolute value of a double-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
104106
- <span class="signature">[`dnanmskmidrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskmidrange]</span><span class="delimiter">: </span><span class="description">calculate the mid-range of a double-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
105107
- <span class="signature">[`dnanmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a double-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
108+
- <span class="signature">[`dnanmskminabs( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskminabs]</span><span class="delimiter">: </span><span class="description">calculate the minimum absolute value of a double-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
106109
- <span class="signature">[`dnanmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a double-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
107110
- <span class="signature">[`dnanrange( N, x, strideX )`][@stdlib/stats/strided/dnanrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a double-precision floating-point strided array, ignoring `NaN` values.</span>
111+
- <span class="signature">[`dnanrangeabs( N, \*X, strideX )`][@stdlib/stats/strided/dnanrangeabs]</span><span class="delimiter">: </span><span class="description">compute the range of absolute values of a double-precision floating-point strided array, ignoring `NaN` values.</span>
108112
- <span class="signature">[`dnanstdev( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array ignoring `NaN` values.</span>
109113
- <span class="signature">[`dnanstdevch( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdevch]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass trial mean algorithm.</span>
110114
- <span class="signature">[`dnanstdevpn( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass algorithm.</span>
@@ -117,6 +121,7 @@ The namespace exports the following:
117121
- <span class="signature">[`dnanvariancetk( N, correction, x, strideX )`][@stdlib/stats/strided/dnanvariancetk]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass textbook algorithm.</span>
118122
- <span class="signature">[`dnanvariancewd( N, correction, x, strideX )`][@stdlib/stats/strided/dnanvariancewd]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using Welford's algorithm.</span>
119123
- <span class="signature">[`dnanvarianceyc( N, correction, x, strideX )`][@stdlib/stats/strided/dnanvarianceyc]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer.</span>
124+
- <span class="signature">[`dpcorrwd( N, x, strideX, y, strideY )`][@stdlib/stats/strided/dpcorrwd]</span><span class="delimiter">: </span><span class="description">calculate the sample Pearson product-moment correlation coefficient of two double-precision floating-point strided arrays using Welford's algorithm.</span>
120125
- <span class="signature">[`drange( N, x, strideX )`][@stdlib/stats/strided/drange]</span><span class="delimiter">: </span><span class="description">calculate the range of a double-precision floating-point strided array.</span>
121126
- <span class="signature">[`drangeabs( N, x, strideX )`][@stdlib/stats/strided/drangeabs]</span><span class="delimiter">: </span><span class="description">compute the range of absolute values of a double-precision floating-point strided array.</span>
122127
- <span class="signature">[`dsem( N, correction, x, strideX )`][@stdlib/stats/strided/dsem]</span><span class="delimiter">: </span><span class="description">calculate the standard error of the mean of a double-precision floating-point strided array.</span>
@@ -175,7 +180,9 @@ The namespace exports the following:
175180
- <span class="signature">[`mskmaxabs( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/mskmaxabs]</span><span class="delimiter">: </span><span class="description">calculate the maximum absolute value of a strided array according to a mask.</span>
176181
- <span class="signature">[`mskmidrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/mskmidrange]</span><span class="delimiter">: </span><span class="description">calculate the mid-range of a strided array according to a mask.</span>
177182
- <span class="signature">[`mskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/mskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a strided array according to a mask.</span>
183+
- <span class="signature">[`mskminabs( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/mskminabs]</span><span class="delimiter">: </span><span class="description">calculate the minimum absolute value of a strided array according to a mask.</span>
178184
- <span class="signature">[`mskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/mskrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a strided array according to a mask.</span>
185+
- <span class="signature">[`nancount( N, x, strideX )`][@stdlib/stats/strided/nancount]</span><span class="delimiter">: </span><span class="description">calculate the number of non-`NaN` elements in a strided array.</span>
179186
- <span class="signature">[`nanmaxBy( N, x, strideX, clbk[, thisArg] )`][@stdlib/stats/strided/nanmax-by]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a strided array via a callback function, ignoring `NaN` values.</span>
180187
- <span class="signature">[`nanmax( N, x, strideX )`][@stdlib/stats/strided/nanmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a strided array, ignoring `NaN` values.</span>
181188
- <span class="signature">[`nanmaxabs( N, x, strideX )`][@stdlib/stats/strided/nanmaxabs]</span><span class="delimiter">: </span><span class="description">calculate the maximum absolute value of a strided array, ignoring `NaN` values.</span>
@@ -194,6 +201,7 @@ The namespace exports the following:
194201
- <span class="signature">[`nanmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/nanmskrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a strided array according to a mask, ignoring `NaN` values.</span>
195202
- <span class="signature">[`nanrangeBy( N, x, strideX, clbk[, thisArg] )`][@stdlib/stats/strided/nanrange-by]</span><span class="delimiter">: </span><span class="description">calculate the range of a strided array via a callback function, ignoring `NaN` values.</span>
196203
- <span class="signature">[`nanrange( N, x, strideX )`][@stdlib/stats/strided/nanrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a strided array, ignoring `NaN` values.</span>
204+
- <span class="signature">[`nanrangeabs( N, x, strideX )`][@stdlib/stats/strided/nanrangeabs]</span><span class="delimiter">: </span><span class="description">calculate the range of absolute values of a strided array, ignoring `NaN` values.</span>
197205
- <span class="signature">[`nanstdev( N, correction, x, strideX )`][@stdlib/stats/strided/nanstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring `NaN` values.</span>
198206
- <span class="signature">[`nanstdevch( N, correction, x, strideX )`][@stdlib/stats/strided/nanstdevch]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring `NaN` values and using a one-pass trial mean algorithm.</span>
199207
- <span class="signature">[`nanstdevpn( N, correction, x, strideX )`][@stdlib/stats/strided/nanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring `NaN` values and using a two-pass algorithm.</span>
@@ -250,8 +258,10 @@ The namespace exports the following:
250258
- <span class="signature">[`snanmin( N, x, strideX )`][@stdlib/stats/strided/snanmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a single-precision floating-point strided array, ignoring `NaN` values.</span>
251259
- <span class="signature">[`snanminabs( N, x, strideX )`][@stdlib/stats/strided/snanminabs]</span><span class="delimiter">: </span><span class="description">calculate the minimum absolute value of a single-precision floating-point strided array, ignoring `NaN` values.</span>
252260
- <span class="signature">[`snanmskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/snanmskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a single-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
261+
- <span class="signature">[`snanmskmaxabs( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/snanmskmaxabs]</span><span class="delimiter">: </span><span class="description">calculate the maximum absolute value of a single-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
253262
- <span class="signature">[`snanmskmidrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/snanmskmidrange]</span><span class="delimiter">: </span><span class="description">calculate the mid-range of a single-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
254263
- <span class="signature">[`snanmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/snanmskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a single-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
264+
- <span class="signature">[`snanmskminabs( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/snanmskminabs]</span><span class="delimiter">: </span><span class="description">calculate the minimum absolute value of a single-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
255265
- <span class="signature">[`snanmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/snanmskrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a single-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
256266
- <span class="signature">[`snanrange( N, x, strideX )`][@stdlib/stats/strided/snanrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a single-precision floating-point strided array, ignoring `NaN` values.</span>
257267
- <span class="signature">[`srange( N, x, strideX )`][@stdlib/stats/strided/srange]</span><span class="delimiter">: </span><span class="description">calculate the range of a single-precision floating-point strided array.</span>
@@ -406,6 +416,8 @@ console.log( objectKeys( ns ) );
406416

407417
[@stdlib/stats/strided/dmskrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmskrange
408418

419+
[@stdlib/stats/strided/dnancount]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnancount
420+
409421
[@stdlib/stats/strided/dnanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmax
410422

411423
[@stdlib/stats/strided/dnanmaxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmaxabs
@@ -428,14 +440,20 @@ console.log( objectKeys( ns ) );
428440

429441
[@stdlib/stats/strided/dnanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskmax
430442

443+
[@stdlib/stats/strided/dnanmskmaxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskmaxabs
444+
431445
[@stdlib/stats/strided/dnanmskmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskmidrange
432446

433447
[@stdlib/stats/strided/dnanmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskmin
434448

449+
[@stdlib/stats/strided/dnanmskminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskminabs
450+
435451
[@stdlib/stats/strided/dnanmskrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskrange
436452

437453
[@stdlib/stats/strided/dnanrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanrange
438454

455+
[@stdlib/stats/strided/dnanrangeabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanrangeabs
456+
439457
[@stdlib/stats/strided/dnanstdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanstdev
440458

441459
[@stdlib/stats/strided/dnanstdevch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanstdevch
@@ -460,6 +478,8 @@ console.log( objectKeys( ns ) );
460478

461479
[@stdlib/stats/strided/dnanvarianceyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanvarianceyc
462480

481+
[@stdlib/stats/strided/dpcorrwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dpcorrwd
482+
463483
[@stdlib/stats/strided/drange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/drange
464484

465485
[@stdlib/stats/strided/drangeabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/drangeabs
@@ -576,8 +596,12 @@ console.log( objectKeys( ns ) );
576596

577597
[@stdlib/stats/strided/mskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskmin
578598

599+
[@stdlib/stats/strided/mskminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskminabs
600+
579601
[@stdlib/stats/strided/mskrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/mskrange
580602

603+
[@stdlib/stats/strided/nancount]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nancount
604+
581605
[@stdlib/stats/strided/nanmax-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmax-by
582606

583607
[@stdlib/stats/strided/nanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmax
@@ -614,6 +638,8 @@ console.log( objectKeys( ns ) );
614638

615639
[@stdlib/stats/strided/nanrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanrange
616640

641+
[@stdlib/stats/strided/nanrangeabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanrangeabs
642+
617643
[@stdlib/stats/strided/nanstdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanstdev
618644

619645
[@stdlib/stats/strided/nanstdevch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanstdevch
@@ -726,10 +752,14 @@ console.log( objectKeys( ns ) );
726752

727753
[@stdlib/stats/strided/snanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmskmax
728754

755+
[@stdlib/stats/strided/snanmskmaxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmskmaxabs
756+
729757
[@stdlib/stats/strided/snanmskmidrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmskmidrange
730758

731759
[@stdlib/stats/strided/snanmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmskmin
732760

761+
[@stdlib/stats/strided/snanmskminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmskminabs
762+
733763
[@stdlib/stats/strided/snanmskrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmskrange
734764

735765
[@stdlib/stats/strided/snanrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanrange

0 commit comments

Comments
 (0)