From a6c37e090b0ba22145f10d3df906d1e157b8fe7f Mon Sep 17 00:00:00 2001
From: Planeshifter <1913638+Planeshifter@users.noreply.github.com>
Date: Sun, 9 Feb 2025 02:37:47 +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/blas/ext/base/README.md | 2 +-
lib/node_modules/@stdlib/math/base/ops/README.md | 9 ---------
lib/node_modules/@stdlib/stats/base/README.md | 8 ++++----
3 files changed, 5 insertions(+), 14 deletions(-)
diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md
index 26a1bb194405..442133cbc559 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/README.md
+++ b/lib/node_modules/@stdlib/blas/ext/base/README.md
@@ -113,7 +113,7 @@ var ns = extblas;
- [`gsort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2hp]: simultaneously sort two strided arrays based on the sort order of the first array using heapsort.
- [`gsort2ins( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2ins]: simultaneously sort two strided arrays based on the sort order of the first array using insertion sort.
- [`gsort2sh( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2sh]: simultaneously sort two strided arrays based on the sort order of the first array using Shellsort.
-- [`gsorthp( N, order, x, stride )`][@stdlib/blas/ext/base/gsorthp]: sort a strided array using heapsort.
+- [`gsorthp( N, order, x, strideX )`][@stdlib/blas/ext/base/gsorthp]: sort a strided array using heapsort.
- [`gsortins( N, order, x, stride )`][@stdlib/blas/ext/base/gsortins]: sort a strided array using insertion sort.
- [`gsortsh( N, order, x, stride )`][@stdlib/blas/ext/base/gsortsh]: sort a strided array using Shellsort.
- [`gsum( N, x, strideX )`][@stdlib/blas/ext/base/gsum]: calculate the sum of strided array elements.
diff --git a/lib/node_modules/@stdlib/math/base/ops/README.md b/lib/node_modules/@stdlib/math/base/ops/README.md
index 0a0712e59989..d87c99ea50fa 100644
--- a/lib/node_modules/@stdlib/math/base/ops/README.md
+++ b/lib/node_modules/@stdlib/math/base/ops/README.md
@@ -45,9 +45,6 @@ The namespace contains the following functions:
-- [`add( x, y )`][@stdlib/number/float64/base/add]: compute the sum of two double-precision floating-point numbers.
-- [`add3( x, y, z )`][@stdlib/number/float64/base/add3]: compute the sum of three double-precision floating-point numbers.
-- [`add4( x, y, z, w )`][@stdlib/number/float64/base/add4]: compute the sum of four double-precision floating-point numbers.
- [`add5( x, y, z, w, u )`][@stdlib/math/base/ops/add5]: compute the sum of five double-precision floating-point numbers.
- [`addf( x, y )`][@stdlib/math/base/ops/addf]: compute the sum of two single-precision floating-point numbers.
- [`cdiv( z1, z2 )`][@stdlib/math/base/ops/cdiv]: divide two double-precision complex floating-point numbers.
@@ -136,12 +133,6 @@ console.log( ns.imuldw( 0x80000000|0, 0x40000000|0 ) );
-[@stdlib/number/float64/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/add
-
-[@stdlib/number/float64/base/add3]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/add3
-
-[@stdlib/number/float64/base/add4]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/add4
-
[@stdlib/math/base/ops/add5]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/add5
[@stdlib/math/base/ops/addf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/addf
diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md
index df6bba368d22..91bbe8a7c7a3 100644
--- a/lib/node_modules/@stdlib/stats/base/README.md
+++ b/lib/node_modules/@stdlib/stats/base/README.md
@@ -126,7 +126,7 @@ The namespace contains the following statistical functions:
- [`dsnanmean( N, x, stride )`][@stdlib/stats/base/dsnanmean]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values, using extended accumulation, and returning an extended precision result.
- [`dsnanmeanors( N, x, stride )`][@stdlib/stats/base/dsnanmeanors]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values, using ordinary recursive summation with extended accumulation, and returning an extended precision result.
- [`dsnanmeanpn( N, x, stride )`][@stdlib/stats/base/dsnanmeanpn]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values, using a two-pass error correction algorithm with extended accumulation, and returning an extended precision result.
-- [`dsnanmeanwd( N, x, stride )`][@stdlib/stats/base/dsnanmeanwd]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values, using Welford's algorithm with extended accumulation, and returning an extended precision result.
+- [`dsnanmeanwd( N, x, strideX )`][@stdlib/stats/base/dsnanmeanwd]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values, using Welford's algorithm with extended accumulation, and returning an extended precision result.
- [`dstdev( N, correction, x, stride )`][@stdlib/stats/base/dstdev]: calculate the standard deviation of a double-precision floating-point strided array.
- [`dstdevch( N, correction, x, strideX )`][@stdlib/stats/base/dstdevch]: calculate the standard deviation of a double-precision floating-point strided array using a one-pass trial mean algorithm.
- [`dstdevpn( N, correction, x, stride )`][@stdlib/stats/base/dstdevpn]: calculate the standard deviation of a double-precision floating-point strided array using a two-pass algorithm.
@@ -146,7 +146,7 @@ The namespace contains the following statistical functions:
- [`dvarmtk( N, mean, correction, x, strideX )`][@stdlib/stats/base/dvarmtk]: calculate the variance of a double-precision floating-point strided array provided a known mean and using a one-pass textbook algorithm.
- [`maxBy( N, x, stride, clbk[, thisArg] )`][@stdlib/stats/base/max-by]: calculate the maximum value of a strided array via a callback function.
- [`max( N, x, strideX )`][@stdlib/stats/base/max]: calculate the maximum value of a strided array.
-- [`maxabs( N, x, stride )`][@stdlib/stats/base/maxabs]: calculate the maximum absolute value of a strided array.
+- [`maxabs( N, x, strideX )`][@stdlib/stats/base/maxabs]: calculate the maximum absolute value of a strided array.
- [`maxsorted( N, x, stride )`][@stdlib/stats/base/maxsorted]: calculate the maximum value of a sorted strided array.
- [`mean( N, x, stride )`][@stdlib/stats/base/mean]: calculate the arithmetic mean of a strided array.
- [`meankbn( N, x, stride )`][@stdlib/stats/base/meankbn]: calculate the arithmetic mean of a strided array using an improved Kahan–Babuška algorithm.
@@ -158,7 +158,7 @@ The namespace contains the following statistical functions:
- [`mediansorted( N, x, stride )`][@stdlib/stats/base/mediansorted]: calculate the median value of a sorted strided array.
- [`minBy( N, x, stride, clbk[, thisArg] )`][@stdlib/stats/base/min-by]: calculate the minimum value of a strided array via a callback function.
- [`min( N, x, strideX )`][@stdlib/stats/base/min]: calculate the minimum value of a strided array.
-- [`minabs( N, x, stride )`][@stdlib/stats/base/minabs]: calculate the minimum absolute value of a strided array.
+- [`minabs( N, x, strideX )`][@stdlib/stats/base/minabs]: calculate the minimum absolute value of a strided array.
- [`minsorted( N, x, stride )`][@stdlib/stats/base/minsorted]: calculate the minimum value of a sorted strided array.
- [`mskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/mskmax]: calculate the maximum value of a strided array according to a mask.
- [`mskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/mskmin]: calculate the minimum value of a strided array according to a mask.
@@ -196,7 +196,7 @@ The namespace contains the following statistical functions:
- [`scumaxabs( N, x, strideX, y, strideY )`][@stdlib/stats/base/scumaxabs]: calculate the cumulative maximum absolute value of single-precision floating-point strided array elements.
- [`scumin( N, x, strideX, y, strideY )`][@stdlib/stats/base/scumin]: calculate the cumulative minimum of single-precision floating-point strided array elements.
- [`scuminabs( N, x, strideX, y, strideY )`][@stdlib/stats/base/scuminabs]: calculate the cumulative minimum absolute value of single-precision floating-point strided array elements.
-- [`sdsmean( N, x, stride )`][@stdlib/stats/base/sdsmean]: calculate the arithmetic mean of a single-precision floating-point strided array using extended accumulation.
+- [`sdsmean( N, x, strideX )`][@stdlib/stats/base/sdsmean]: calculate the arithmetic mean of a single-precision floating-point strided array using extended accumulation.
- [`sdsmeanors( N, x, strideX )`][@stdlib/stats/base/sdsmeanors]: calculate the arithmetic mean of a single-precision floating-point strided array using ordinary recursive summation with extended accumulation.
- [`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.