From 456e20195427c8fa0cb76d5345279b292e2bf583 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Mon, 9 Jun 2025 02:50:54 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/number/uint32/base/README.md | 12 ++++++++++++ lib/node_modules/@stdlib/stats/base/README.md | 11 +---------- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/number/uint32/base/README.md b/lib/node_modules/@stdlib/number/uint32/base/README.md index 43c0f8e78280..ef023819453f 100644 --- a/lib/node_modules/@stdlib/number/uint32/base/README.md +++ b/lib/node_modules/@stdlib/number/uint32/base/README.md @@ -43,9 +43,13 @@ var o = ns;
+- [`add( x, y )`][@stdlib/number/uint32/base/add]: compute the sum of two unsigned 32-bit integers. - [`fromBinaryStringUint32( bstr )`][@stdlib/number/uint32/base/from-binary-string]: create an unsigned 32-bit integer from a literal bit representation. +- [`mul( x, y )`][@stdlib/number/uint32/base/mul]: multiply two unsigned 32-bit integers. +- [`muldw( a, b )`][@stdlib/number/uint32/base/muldw]: compute the double word product of two unsigned 32-bit integers. - [`rotl32( x, shift )`][@stdlib/number/uint32/base/rotl]: bitwise rotation to the left. - [`rotr32( x, shift )`][@stdlib/number/uint32/base/rotr]: bitwise rotation to the right. +- [`sub( x, y )`][@stdlib/number/uint32/base/sub]: subtract two unsigned 32-bit integers. - [`toBinaryStringUint32( x )`][@stdlib/number/uint32/base/to-binary-string]: return a string giving the literal bit representation of an unsigned 32-bit integer. - [`uint32ToInt32( x )`][@stdlib/number/uint32/base/to-int32]: convert an unsigned 32-bit integer to a signed 32-bit integer. @@ -90,12 +94,20 @@ console.log( objectKeys( ns ) ); +[@stdlib/number/uint32/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/add + [@stdlib/number/uint32/base/from-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/from-binary-string +[@stdlib/number/uint32/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/mul + +[@stdlib/number/uint32/base/muldw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/muldw + [@stdlib/number/uint32/base/rotl]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/rotl [@stdlib/number/uint32/base/rotr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/rotr +[@stdlib/number/uint32/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/sub + [@stdlib/number/uint32/base/to-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/to-binary-string [@stdlib/number/uint32/base/to-int32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/to-int32 diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md index dd6f3722f835..d8c1728d79eb 100644 --- a/lib/node_modules/@stdlib/stats/base/README.md +++ b/lib/node_modules/@stdlib/stats/base/README.md @@ -118,12 +118,10 @@ The namespace contains the following statistical functions: - [`range( N, x, strideX )`][@stdlib/stats/base/range]: calculate the range of a strided array. - [`sdsnanmean( N, x, stride )`][@stdlib/stats/base/sdsnanmean]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using extended accumulation. - [`sdsnanmeanors( N, x, stride )`][@stdlib/stats/base/sdsnanmeanors]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation with extended accumulation. -- [`smean( N, x, strideX )`][@stdlib/stats/strided/smean]: calculate the arithmetic mean of a single-precision floating-point strided array. - [`smeankbn( N, x, stride )`][@stdlib/stats/base/smeankbn]: calculate the arithmetic mean of a single-precision floating-point strided array using an improved Kahan–Babuška algorithm. - [`smeankbn2( N, x, stride )`][@stdlib/stats/base/smeankbn2]: calculate the arithmetic mean of a single-precision floating-point strided array using a second-order iterative Kahan–Babuška algorithm. - [`smeanlipw( N, x, stride )`][@stdlib/stats/base/smeanlipw]: calculate the arithmetic mean of a single-precision floating-point strided array using a one-pass trial mean algorithm with pairwise summation. - [`smeanors( N, x, stride )`][@stdlib/stats/base/smeanors]: calculate the arithmetic mean of a single-precision floating-point strided array using ordinary recursive summation. -- [`smeanpn( N, x, strideX )`][@stdlib/stats/strided/smeanpn]: calculate the arithmetic mean of a single-precision floating-point strided array using a two-pass error correction algorithm. - [`snanmean( N, x, stride )`][@stdlib/stats/base/snanmean]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values. - [`snanstdev( N, correction, x, stride )`][@stdlib/stats/base/snanstdev]: calculate the standard deviation of a single-precision floating-point strided array ignoring `NaN` values. - [`snanstdevch( N, correction, x, stride )`][@stdlib/stats/base/snanstdevch]: calculate the standard deviation of a single-precision floating-point strided array ignoring `NaN` values and using a one-pass trial mean algorithm. @@ -137,7 +135,6 @@ The namespace contains the following statistical functions: - [`snanvariancetk( N, correction, x, stride )`][@stdlib/stats/base/snanvariancetk]: calculate the variance of a single-precision floating-point strided array ignoring `NaN` values and using a one-pass textbook algorithm. - [`snanvariancewd( N, correction, x, stride )`][@stdlib/stats/base/snanvariancewd]: calculate the variance of a single-precision floating-point strided array ignoring `NaN` values and using Welford's algorithm. - [`snanvarianceyc( N, correction, x, stride )`][@stdlib/stats/base/snanvarianceyc]: calculate the variance of a single-precision floating-point strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer. -- [`sstdev( N, correction, x, strideX )`][@stdlib/stats/strided/sstdev]: calculate the standard deviation of a single-precision floating-point strided array. - [`sstdevwd( N, correction, x, stride )`][@stdlib/stats/base/sstdevwd]: calculate the standard deviation of a single-precision floating-point strided array using Welford's algorithm. - [`stdev( N, correction, x, stride )`][@stdlib/stats/base/stdev]: calculate the standard deviation of a strided array. - [`stdevch( N, correction, x, stride )`][@stdlib/stats/base/stdevch]: calculate the standard deviation of a strided array using a one-pass trial mean algorithm. @@ -146,7 +143,7 @@ The namespace contains the following statistical functions: - [`stdevwd( N, correction, x, stride )`][@stdlib/stats/base/stdevwd]: calculate the standard deviation of a strided array using Welford's algorithm. - [`stdevyc( N, correction, x, stride )`][@stdlib/stats/base/stdevyc]: calculate the standard deviation of a strided array using a one-pass algorithm proposed by Youngs and Cramer. - [`svariance( N, correction, x, stride )`][@stdlib/stats/base/svariance]: calculate the variance of a single-precision floating-point strided array. -- [`svariancewd( N, correction, x, stride )`][@stdlib/stats/base/svariancewd]: calculate the variance of a single-precision floating-point strided array using Welford's algorithm. +- [`svariancewd( N, correction, x, strideX )`][@stdlib/stats/base/svariancewd]: calculate the variance of a single-precision floating-point strided array using Welford's algorithm. - [`variance( N, correction, x, stride )`][@stdlib/stats/base/variance]: calculate the variance of a strided array. - [`variancech( N, correction, x, stride )`][@stdlib/stats/base/variancech]: calculate the variance of a strided array using a one-pass trial mean algorithm. - [`variancepn( N, correction, x, stride )`][@stdlib/stats/base/variancepn]: calculate the variance of a strided array using a two-pass algorithm. @@ -325,8 +322,6 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/sdsnanmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/sdsnanmeanors -[@stdlib/stats/strided/smean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/smean - [@stdlib/stats/base/smeankbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/smeankbn [@stdlib/stats/base/smeankbn2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/smeankbn2 @@ -335,8 +330,6 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/smeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/smeanors -[@stdlib/stats/strided/smeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/smeanpn - [@stdlib/stats/base/snanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanmean [@stdlib/stats/base/snanstdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanstdev @@ -363,8 +356,6 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/snanvarianceyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanvarianceyc -[@stdlib/stats/strided/sstdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/sstdev - [@stdlib/stats/base/sstdevwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/sstdevwd [@stdlib/stats/base/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/stdev