From 13d5579a79e92d864243370689224a039ac96da3 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Sun, 23 Feb 2025 02:39:41 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- lib/node_modules/@stdlib/_tools/eslint/rules/README.md | 3 +++ lib/node_modules/@stdlib/math/base/ops/README.md | 3 --- lib/node_modules/@stdlib/stats/base/README.md | 9 +++------ 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md index 0a24d3fb80c7..7ed4913f92c4 100644 --- a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md +++ b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md @@ -81,6 +81,7 @@ var eslint = rules; - [`repl-namespace-order`][@stdlib/_tools/eslint/rules/repl-namespace-order]: ESLint rule to enforce that packages are added to a REPL namespace object in alphabetical order according to alias (namespace key). - [`require-file-extensions`][@stdlib/_tools/eslint/rules/require-file-extensions]: ESLint rule enforcing that `require()` calls of files end with a whitelisted file extension. - [`require-globals`][@stdlib/_tools/eslint/rules/require-globals]: ESLint rule enforcing that specified global variables are explicitly required. +- [`require-last-path-relative`][@stdlib/_tools/eslint/rules/require-last-path-relative]: ESLint rule enforcing that the last `require` statement is a relative path. - [`require-leading-slash`][@stdlib/_tools/eslint/rules/require-leading-slash]: ESLint rule disallowing `require()` calls of relative paths which do not begin with a leading `./`. - [`require-order`][@stdlib/_tools/eslint/rules/require-order]: ESLint rule enforcing a specified order of `require()` calls. - [`require-spaces`][@stdlib/_tools/eslint/rules/require-spaces]: ESLint rule enforcing spaces in `require()` statements. @@ -427,6 +428,8 @@ console.log( getKeys( rules ) ); [@stdlib/_tools/eslint/rules/require-globals]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-globals +[@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 + [@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 [@stdlib/_tools/eslint/rules/require-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-order diff --git a/lib/node_modules/@stdlib/math/base/ops/README.md b/lib/node_modules/@stdlib/math/base/ops/README.md index f7cadc9c6ce9..29ca3f4156a6 100644 --- a/lib/node_modules/@stdlib/math/base/ops/README.md +++ b/lib/node_modules/@stdlib/math/base/ops/README.md @@ -50,7 +50,6 @@ The namespace contains the following functions: - [`cnegf( z )`][@stdlib/math/base/ops/cnegf]: negate a single-precision complex floating-point number. - [`csub( z1, z2 )`][@stdlib/math/base/ops/csub]: subtract two double-precision complex floating-point numbers. - [`csubf( z1, z2 )`][@stdlib/math/base/ops/csubf]: subtract two single-precision complex floating-point numbers. -- [`divf( x, y )`][@stdlib/number/float32/base/div]: divide two single-precision floating-point numbers. - [`imul( a, b )`][@stdlib/math/base/ops/imul]: perform C-like multiplication of two signed 32-bit integers. - [`imuldw( a, b )`][@stdlib/math/base/ops/imuldw]: compute the double word product of two signed 32-bit integers. - [`mulf( x, y )`][@stdlib/math/base/ops/mulf]: multiply two single-precision floating-point numbers. @@ -138,8 +137,6 @@ console.log( ns.imuldw( 0x80000000|0, 0x40000000|0 ) ); [@stdlib/math/base/ops/csubf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/csubf -[@stdlib/number/float32/base/div]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/div - [@stdlib/math/base/ops/imul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/imul [@stdlib/math/base/ops/imuldw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/imuldw diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md index fe1156f7e186..bb51f7f2ac3c 100644 --- a/lib/node_modules/@stdlib/stats/base/README.md +++ b/lib/node_modules/@stdlib/stats/base/README.md @@ -71,7 +71,6 @@ The namespace contains the following statistical functions: - [`dmskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskmax]: calculate the maximum value of a double-precision floating-point strided array according to a mask. - [`dmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskmin]: calculate the minimum value of a double-precision floating-point strided array according to a mask. - [`dmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskrange]: calculate the range of a double-precision floating-point strided array according to a mask. -- [`dnanmean( N, x, strideX )`][@stdlib/stats/strided/dnanmean]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values. - [`dnanmeanors( N, x, strideX )`][@stdlib/stats/base/dnanmeanors]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation. - [`dnanmeanpn( N, x, strideX )`][@stdlib/stats/base/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. - [`dnanmeanpw( N, x, strideX )`][@stdlib/stats/base/dnanmeanpw]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using pairwise summation. @@ -90,10 +89,10 @@ The namespace contains the following statistical functions: - [`dnanstdevyc( N, correction, x, stride )`][@stdlib/stats/base/dnanstdevyc]: 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. - [`dnanvariance( N, correction, x, stride )`][@stdlib/stats/base/dnanvariance]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values. - [`dnanvariancech( N, correction, x, stride )`][@stdlib/stats/base/dnanvariancech]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass trial mean algorithm. -- [`dnanvariancepn( N, correction, x, stride )`][@stdlib/stats/base/dnanvariancepn]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using a two-pass algorithm. +- [`dnanvariancepn( N, correction, x, strideX )`][@stdlib/stats/base/dnanvariancepn]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using a two-pass algorithm. - [`dnanvariancetk( N, correction, x, strideX )`][@stdlib/stats/base/dnanvariancetk]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass textbook algorithm. -- [`dnanvariancewd( N, correction, x, stride )`][@stdlib/stats/base/dnanvariancewd]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using Welford's algorithm. -- [`dnanvarianceyc( N, correction, x, stride )`][@stdlib/stats/base/dnanvarianceyc]: 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. +- [`dnanvariancewd( N, correction, x, strideX )`][@stdlib/stats/base/dnanvariancewd]: calculate the variance of a double-precision floating-point strided array ignoring `NaN` values and using Welford's algorithm. +- [`dnanvarianceyc( N, correction, x, strideX )`][@stdlib/stats/base/dnanvarianceyc]: 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. - [`drange( N, x, strideX )`][@stdlib/stats/base/drange]: calculate the range of a double-precision floating-point strided array. - [`dsem( N, correction, x, stride )`][@stdlib/stats/base/dsem]: calculate the standard error of the mean of a double-precision floating-point strided array. - [`dsemch( N, correction, x, strideX )`][@stdlib/stats/base/dsemch]: calculate the standard error of the mean of a double-precision floating-point strided array using a one-pass trial mean algorithm. @@ -331,8 +330,6 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/dmskrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dmskrange -[@stdlib/stats/strided/dnanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmean - [@stdlib/stats/base/dnanmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmeanors [@stdlib/stats/base/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmeanpn