Skip to content

Commit afbe56b

Browse files
authored
docs: update namespace table of contents
PR-URL: #5387 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 29a7783 commit afbe56b

File tree

3 files changed

+6
-9
lines changed

3 files changed

+6
-9
lines changed

lib/node_modules/@stdlib/_tools/eslint/rules/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ var eslint = rules;
8181
- <span class="signature">[`repl-namespace-order`][@stdlib/_tools/eslint/rules/repl-namespace-order]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that packages are added to a REPL namespace object in alphabetical order according to alias (namespace key).</span>
8282
- <span class="signature">[`require-file-extensions`][@stdlib/_tools/eslint/rules/require-file-extensions]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that `require()` calls of files end with a whitelisted file extension.</span>
8383
- <span class="signature">[`require-globals`][@stdlib/_tools/eslint/rules/require-globals]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that specified global variables are explicitly required.</span>
84+
- <span class="signature">[`require-last-path-relative`][@stdlib/_tools/eslint/rules/require-last-path-relative]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that the last `require` statement is a relative path.</span>
8485
- <span class="signature">[`require-leading-slash`][@stdlib/_tools/eslint/rules/require-leading-slash]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing `require()` calls of relative paths which do not begin with a leading `./`.</span>
8586
- <span class="signature">[`require-order`][@stdlib/_tools/eslint/rules/require-order]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing a specified order of `require()` calls.</span>
8687
- <span class="signature">[`require-spaces`][@stdlib/_tools/eslint/rules/require-spaces]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing spaces in `require()` statements.</span>
@@ -427,6 +428,8 @@ console.log( getKeys( rules ) );
427428

428429
[@stdlib/_tools/eslint/rules/require-globals]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-globals
429430

431+
[@stdlib/_tools/eslint/rules/require-last-path-relative]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-last-path-relative
432+
430433
[@stdlib/_tools/eslint/rules/require-leading-slash]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-leading-slash
431434

432435
[@stdlib/_tools/eslint/rules/require-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-order

lib/node_modules/@stdlib/math/base/ops/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ The namespace contains the following functions:
5050
- <span class="signature">[`cnegf( z )`][@stdlib/math/base/ops/cnegf]</span><span class="delimiter">: </span><span class="description">negate a single-precision complex floating-point number.</span>
5151
- <span class="signature">[`csub( z1, z2 )`][@stdlib/math/base/ops/csub]</span><span class="delimiter">: </span><span class="description">subtract two double-precision complex floating-point numbers.</span>
5252
- <span class="signature">[`csubf( z1, z2 )`][@stdlib/math/base/ops/csubf]</span><span class="delimiter">: </span><span class="description">subtract two single-precision complex floating-point numbers.</span>
53-
- <span class="signature">[`divf( x, y )`][@stdlib/number/float32/base/div]</span><span class="delimiter">: </span><span class="description">divide two single-precision floating-point numbers.</span>
5453
- <span class="signature">[`imul( a, b )`][@stdlib/math/base/ops/imul]</span><span class="delimiter">: </span><span class="description">perform C-like multiplication of two signed 32-bit integers.</span>
5554
- <span class="signature">[`imuldw( a, b )`][@stdlib/math/base/ops/imuldw]</span><span class="delimiter">: </span><span class="description">compute the double word product of two signed 32-bit integers.</span>
5655
- <span class="signature">[`mulf( x, y )`][@stdlib/math/base/ops/mulf]</span><span class="delimiter">: </span><span class="description">multiply two single-precision floating-point numbers.</span>
@@ -138,8 +137,6 @@ console.log( ns.imuldw( 0x80000000|0, 0x40000000|0 ) );
138137

139138
[@stdlib/math/base/ops/csubf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/csubf
140139

141-
[@stdlib/number/float32/base/div]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/div
142-
143140
[@stdlib/math/base/ops/imul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/imul
144141

145142
[@stdlib/math/base/ops/imuldw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/imuldw

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

+3-6
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ The namespace contains the following statistical functions:
7171
- <span class="signature">[`dmskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a double-precision floating-point strided array according to a mask.</span>
7272
- <span class="signature">[`dmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/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>
7373
- <span class="signature">[`dmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/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>
74-
- <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>
7574
- <span class="signature">[`dnanmeanors( N, x, strideX )`][@stdlib/stats/base/dnanmeanors]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation.</span>
7675
- <span class="signature">[`dnanmeanpn( N, x, strideX )`][@stdlib/stats/base/dnanmeanpn]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm.</span>
7776
- <span class="signature">[`dnanmeanpw( N, x, strideX )`][@stdlib/stats/base/dnanmeanpw]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using pairwise summation.</span>
@@ -90,10 +89,10 @@ The namespace contains the following statistical functions:
9089
- <span class="signature">[`dnanstdevyc( N, correction, x, stride )`][@stdlib/stats/base/dnanstdevyc]</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 algorithm proposed by Youngs and Cramer.</span>
9190
- <span class="signature">[`dnanvariance( N, correction, x, stride )`][@stdlib/stats/base/dnanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring `NaN` values.</span>
9291
- <span class="signature">[`dnanvariancech( N, correction, x, stride )`][@stdlib/stats/base/dnanvariancech]</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 trial mean algorithm.</span>
93-
- <span class="signature">[`dnanvariancepn( N, correction, x, stride )`][@stdlib/stats/base/dnanvariancepn]</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 two-pass algorithm.</span>
92+
- <span class="signature">[`dnanvariancepn( N, correction, x, strideX )`][@stdlib/stats/base/dnanvariancepn]</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 two-pass algorithm.</span>
9493
- <span class="signature">[`dnanvariancetk( N, correction, x, strideX )`][@stdlib/stats/base/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>
95-
- <span class="signature">[`dnanvariancewd( N, correction, x, stride )`][@stdlib/stats/base/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>
96-
- <span class="signature">[`dnanvarianceyc( N, correction, x, stride )`][@stdlib/stats/base/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>
94+
- <span class="signature">[`dnanvariancewd( N, correction, x, strideX )`][@stdlib/stats/base/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>
95+
- <span class="signature">[`dnanvarianceyc( N, correction, x, strideX )`][@stdlib/stats/base/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>
9796
- <span class="signature">[`drange( N, x, strideX )`][@stdlib/stats/base/drange]</span><span class="delimiter">: </span><span class="description">calculate the range of a double-precision floating-point strided array.</span>
9897
- <span class="signature">[`dsem( N, correction, x, stride )`][@stdlib/stats/base/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>
9998
- <span class="signature">[`dsemch( N, correction, x, strideX )`][@stdlib/stats/base/dsemch]</span><span class="delimiter">: </span><span class="description">calculate the standard error of the mean of a double-precision floating-point strided array using a one-pass trial mean algorithm.</span>
@@ -331,8 +330,6 @@ console.log( objectKeys( ns ) );
331330

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

334-
[@stdlib/stats/strided/dnanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmean
335-
336333
[@stdlib/stats/base/dnanmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmeanors
337334

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

0 commit comments

Comments
 (0)