From d70b6ef31e23c747202ea68fb15ca7a169addbd0 Mon Sep 17 00:00:00 2001
From: Planeshifter <1913638+Planeshifter@users.noreply.github.com>
Date: Wed, 26 Aug 2026 02:48:12 +0000
Subject: [PATCH] docs: update namespace table of contents
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
---
.../@stdlib/_tools/eslint/rules/README.md | 3 +++
lib/node_modules/@stdlib/blas/ext/README.md | 2 +-
.../@stdlib/blas/ext/base/ndarray/README.md | 21 +++++++++++++++++++
.../fft/base/fftpack/float32/README.md | 3 +++
.../base/fftpack/ndarray/generic/README.md | 6 ++++++
5 files changed, 34 insertions(+), 1 deletion(-)
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md
index 4c3c3221c77d..985663b871e8 100644
--- a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md
+++ b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md
@@ -86,6 +86,7 @@ var eslint = rules;
- [`no-self-require`][@stdlib/_tools/eslint/rules/no-self-require]: ESLint rule enforcing that modules do not require themselves.
- [`no-single-property-require`][@stdlib/_tools/eslint/rules/no-single-property-require]: ESLint rule disallowing requiring an entire module when only a single property of the module is used.
- [`no-unassigned-require`][@stdlib/_tools/eslint/rules/no-unassigned-require]: ESLint rule forbidding unassigned require statements.
+- [`no-unnecessary-format`][@stdlib/_tools/eslint/rules/no-unnecessary-format]: ESLint rule disallowing format calls that do not perform string interpolation.
- [`no-unnecessary-nested-functions`][@stdlib/_tools/eslint/rules/no-unnecessary-nested-functions]: ESLint rule to prevent unnecessary function nesting when inner functions don't depend on outer scope variables.
- [`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.
@@ -448,6 +449,8 @@ console.log( getKeys( rules ) );
[@stdlib/_tools/eslint/rules/no-unassigned-require]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-unassigned-require
+[@stdlib/_tools/eslint/rules/no-unnecessary-format]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-unnecessary-format
+
[@stdlib/_tools/eslint/rules/no-unnecessary-nested-functions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-unnecessary-nested-functions
[@stdlib/_tools/eslint/rules/repl-namespace-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/repl-namespace-order
diff --git a/lib/node_modules/@stdlib/blas/ext/README.md b/lib/node_modules/@stdlib/blas/ext/README.md
index 4ad1cd8d99ae..13568f31d55e 100644
--- a/lib/node_modules/@stdlib/blas/ext/README.md
+++ b/lib/node_modules/@stdlib/blas/ext/README.md
@@ -49,7 +49,7 @@ The namespace contains the following:
- [`circshift( x, k[, options] )`][@stdlib/blas/ext/circshift]: circularly shift the elements of an input ndarray by a specified number of positions along one or more ndarray dimensions.
- [`copyWithin( x, target, start[, end][, options] )`][@stdlib/blas/ext/copy-within]: perform an in-place copy of elements within an ndarray along an ndarray dimension.
- [`cusum( x[, initial][, options] )`][@stdlib/blas/ext/cusum]: compute the cumulative sum along one or more ndarray dimensions.
-- [`findIndex( x[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-index]: return the index of the first element along an ndarray dimension which passes a test implemented by a predicate function.
+- [`findIndex( x[, fromIndex][, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-index]: return the index of the first element along an ndarray dimension which passes a test implemented by a predicate function.
- [`findLastIndex( x[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-last-index]: return the index of the last element along an ndarray dimension which passes a test implemented by a predicate function.
- [`indexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/index-of]: return the first index of a specified search element along an ndarray dimension.
- [`join( x[, options] )`][@stdlib/blas/ext/join]: return an ndarray created by joining elements using a separator along one or more ndarray dimensions.
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md
index cc617b71e803..3c705d115ed4 100644
--- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md
+++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md
@@ -71,6 +71,8 @@ The namespace exposes the following APIs:
- [`daxpby( arrays )`][@stdlib/blas/ext/base/ndarray/daxpby]: multiply a one-dimensional double-precision floating-point ndarray by a scalar constant and add the result to a second one-dimensional double-precision floating-point ndarray multiplied by a scalar constant.
- [`dcircshift( arrays )`][@stdlib/blas/ext/base/ndarray/dcircshift]: circularly shift the elements of a one-dimensional double-precision floating-point ndarray by a specified number of positions.
- [`dcopyWithin( arrays )`][@stdlib/blas/ext/base/ndarray/dcopy-within]: perform an in-place copy of elements within a one-dimensional double-precision floating-point ndarray.
+- [`dcuany( arrays )`][@stdlib/blas/ext/base/ndarray/dcuany]: cumulatively test whether at least one element in a one-dimensional double-precision floating-point ndarray is truthy.
+- [`dcuevery( arrays )`][@stdlib/blas/ext/base/ndarray/dcuevery]: cumulatively test whether every element in a one-dimensional double-precision floating-point ndarray is truthy.
- [`dcunone( arrays )`][@stdlib/blas/ext/base/ndarray/dcunone]: cumulatively test whether every element in a one-dimensional double-precision floating-point ndarray is falsy.
- [`dcusum( arrays )`][@stdlib/blas/ext/base/ndarray/dcusum]: compute the cumulative sum of a one-dimensional double-precision floating-point ndarray.
- [`dcusumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/dcusumkbn]: compute the cumulative sum of a one-dimensional double-precision floating-point ndarray using an improved Kahan–Babuška algorithm.
@@ -127,6 +129,8 @@ The namespace exposes the following APIs:
- [`gaxpby( arrays )`][@stdlib/blas/ext/base/ndarray/gaxpby]: multiply a one-dimensional ndarray by a scalar constant and add the result to a second one-dimensional ndarray multiplied by a scalar constant.
- [`gcircshift( arrays )`][@stdlib/blas/ext/base/ndarray/gcircshift]: circularly shift the elements of a one-dimensional ndarray by a specified number of positions.
- [`gcopyWithin( arrays )`][@stdlib/blas/ext/base/ndarray/gcopy-within]: perform an in-place copy of elements within a one-dimensional ndarray.
+- [`gcuany( arrays )`][@stdlib/blas/ext/base/ndarray/gcuany]: cumulatively test whether at least one element in a one-dimensional ndarray is truthy.
+- [`gcuevery( arrays )`][@stdlib/blas/ext/base/ndarray/gcuevery]: cumulatively test whether every element in a one-dimensional ndarray is truthy.
- [`gcunone( arrays )`][@stdlib/blas/ext/base/ndarray/gcunone]: cumulatively test whether every element in a one-dimensional ndarray is falsy.
- [`gcusum( arrays )`][@stdlib/blas/ext/base/ndarray/gcusum]: compute the cumulative sum of a one-dimensional ndarray.
- [`gcusumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumkbn]: compute the cumulative sum of a one-dimensional ndarray using an improved Kahan–Babuška algorithm.
@@ -173,6 +177,7 @@ The namespace exposes the following APIs:
- [`gtriu( arrays )`][@stdlib/blas/ext/base/ndarray/gtriu]: copy the upper triangular part of a matrix `A` to another matrix `B`.
- [`gtriu2tril( arrays )`][@stdlib/blas/ext/base/ndarray/gtriu2tril]: reflect the upper triangular part of a matrix `A` into the lower triangular part of another matrix `B`.
- [`gunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/gunitspace]: fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.
+- [`gwxpy( arrays )`][@stdlib/blas/ext/base/ndarray/gwxpy]: add elements of a one-dimensional ndarray to the corresponding elements of a second one-dimensional ndarray and assign the results to elements in a third one-dimensional ndarray.
- [`gwxsa( arrays )`][@stdlib/blas/ext/base/ndarray/gwxsa]: subtract a scalar constant from each element in an input one-dimensional ndarray and assign the results to elements in a one-dimensional output ndarray.
- [`gxdy( arrays )`][@stdlib/blas/ext/base/ndarray/gxdy]: divide elements of a one-dimensional ndarray by the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray.
- [`gxmy( arrays )`][@stdlib/blas/ext/base/ndarray/gxmy]: multiply elements of a one-dimensional ndarray by the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray.
@@ -185,6 +190,8 @@ The namespace exposes the following APIs:
- [`saxpby( arrays )`][@stdlib/blas/ext/base/ndarray/saxpby]: multiply a one-dimensional single-precision floating-point ndarray by a scalar constant and add the result to a second one-dimensional single-precision floating-point ndarray multiplied by a scalar constant.
- [`scircshift( arrays )`][@stdlib/blas/ext/base/ndarray/scircshift]: circularly shift the elements of a one-dimensional single-precision floating-point ndarray by a specified number of positions.
- [`scopyWithin( arrays )`][@stdlib/blas/ext/base/ndarray/scopy-within]: perform an in-place copy of elements within a one-dimensional single-precision floating-point ndarray.
+- [`scuany( arrays )`][@stdlib/blas/ext/base/ndarray/scuany]: cumulatively test whether at least one element in a one-dimensional single-precision floating-point ndarray is truthy.
+- [`scuevery( arrays )`][@stdlib/blas/ext/base/ndarray/scuevery]: cumulatively test whether every element in a one-dimensional single-precision floating-point ndarray is truthy.
- [`scunone( arrays )`][@stdlib/blas/ext/base/ndarray/scunone]: cumulatively test whether every element in a one-dimensional single-precision floating-point ndarray is falsy.
- [`scusum( arrays )`][@stdlib/blas/ext/base/ndarray/scusum]: compute the cumulative sum of a one-dimensional single-precision floating-point ndarray.
- [`scusumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/scusumkbn]: compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm.
@@ -345,6 +352,10 @@ console.log( objectKeys( ns ) );
[@stdlib/blas/ext/base/ndarray/dcopy-within]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dcopy-within
+[@stdlib/blas/ext/base/ndarray/dcuany]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dcuany
+
+[@stdlib/blas/ext/base/ndarray/dcuevery]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dcuevery
+
[@stdlib/blas/ext/base/ndarray/dcunone]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dcunone
[@stdlib/blas/ext/base/ndarray/dcusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dcusum
@@ -457,6 +468,10 @@ console.log( objectKeys( ns ) );
[@stdlib/blas/ext/base/ndarray/gcopy-within]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcopy-within
+[@stdlib/blas/ext/base/ndarray/gcuany]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcuany
+
+[@stdlib/blas/ext/base/ndarray/gcuevery]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcuevery
+
[@stdlib/blas/ext/base/ndarray/gcunone]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcunone
[@stdlib/blas/ext/base/ndarray/gcusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcusum
@@ -549,6 +564,8 @@ console.log( objectKeys( ns ) );
[@stdlib/blas/ext/base/ndarray/gunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gunitspace
+[@stdlib/blas/ext/base/ndarray/gwxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gwxpy
+
[@stdlib/blas/ext/base/ndarray/gwxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gwxsa
[@stdlib/blas/ext/base/ndarray/gxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gxdy
@@ -573,6 +590,10 @@ console.log( objectKeys( ns ) );
[@stdlib/blas/ext/base/ndarray/scopy-within]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/scopy-within
+[@stdlib/blas/ext/base/ndarray/scuany]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/scuany
+
+[@stdlib/blas/ext/base/ndarray/scuevery]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/scuevery
+
[@stdlib/blas/ext/base/ndarray/scunone]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/scunone
[@stdlib/blas/ext/base/ndarray/scusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/scusum
diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/float32/README.md b/lib/node_modules/@stdlib/fft/base/fftpack/float32/README.md
index b8ff64e3c773..7634cab65bc4 100644
--- a/lib/node_modules/@stdlib/fft/base/fftpack/float32/README.md
+++ b/lib/node_modules/@stdlib/fft/base/fftpack/float32/README.md
@@ -44,6 +44,7 @@ var o = ns;
- [`decompose( N, M, initial, si, oi, out, so, oo )`][@stdlib/fft/base/fftpack/float32/decompose]: factorize a sequence length into a product of integers and store the results in a single-precision floating-point array.
+- [`rffti( N, workspace, strideW, offsetW )`][@stdlib/fft/base/fftpack/float32/rffti]: initialize a single-precision floating-point workspace array for performing a real-valued Fourier transform.
@@ -88,6 +89,8 @@ console.log( objectKeys( ns ) );
[@stdlib/fft/base/fftpack/float32/decompose]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/float32/decompose
+[@stdlib/fft/base/fftpack/float32/rffti]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/float32/rffti
+
diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/generic/README.md b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/generic/README.md
index 129385305aa2..ad82dfcdfae9 100644
--- a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/generic/README.md
+++ b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/generic/README.md
@@ -44,7 +44,9 @@ var o = ns;
- [`cffti( arrays )`][@stdlib/fft/base/fftpack/ndarray/generic/cffti]: initialize a workspace array for performing a complex-valued Fourier transform on a one-dimensional ndarray.
+- [`cosqi( arrays )`][@stdlib/fft/base/fftpack/ndarray/generic/cosqi]: initialize a workspace array for performing a quarter-wave cosine transform on a one-dimensional ndarray.
- [`rffti( arrays )`][@stdlib/fft/base/fftpack/ndarray/generic/rffti]: initialize a workspace array for performing a real-valued Fourier transform on a one-dimensional ndarray.
+- [`sinqi( arrays )`][@stdlib/fft/base/fftpack/ndarray/generic/sinqi]: initialize a workspace array for performing a quarter-wave sine transform on a one-dimensional ndarray.
@@ -89,8 +91,12 @@ console.log( objectKeys( ns ) );
[@stdlib/fft/base/fftpack/ndarray/generic/cffti]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/generic/cffti
+[@stdlib/fft/base/fftpack/ndarray/generic/cosqi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/generic/cosqi
+
[@stdlib/fft/base/fftpack/ndarray/generic/rffti]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/generic/rffti
+[@stdlib/fft/base/fftpack/ndarray/generic/sinqi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/generic/sinqi
+