From c74a7d336591b021685c45df12ce475efd28299c Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Sun, 27 Sep 2026 02:39:01 +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/README.md | 24 +++++++++++++++++++ .../@stdlib/blas/ext/base/ndarray/README.md | 9 +++++++ .../fft/base/fftpack/ndarray/README.md | 3 +++ .../base/fftpack/ndarray/float32/README.md | 7 ++++++ .../base/fftpack/ndarray/float64/README.md | 3 +++ 5 files changed, 46 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/README.md b/lib/node_modules/@stdlib/blas/ext/README.md index 03633d2f7e9c..0bc3222f2fe4 100644 --- a/lib/node_modules/@stdlib/blas/ext/README.md +++ b/lib/node_modules/@stdlib/blas/ext/README.md @@ -48,11 +48,19 @@ The namespace contains the following: - [`base`][@stdlib/blas/ext/base]: base (i.e., lower-level) extensions to basic linear algebra subprograms (BLAS). - [`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. +- [`cuany( x[, options] )`][@stdlib/blas/ext/cuany]: cumulatively test whether at least one element along one or more ndarray dimensions is truthy. +- [`cuevery( x[, options] )`][@stdlib/blas/ext/cuevery]: cumulatively test whether every element along one or more ndarray dimensions is truthy. +- [`cunone( x[, options] )`][@stdlib/blas/ext/cunone]: cumulatively test whether every element along one or more ndarray dimensions is falsy. - [`cusum( x[, initial][, options] )`][@stdlib/blas/ext/cusum]: compute the cumulative sum along one or more ndarray dimensions. +- [`fillRange( x, value[, start[, end]][, options] )`][@stdlib/blas/ext/fill-range]: fill an input ndarray with a specified value along an ndarray dimension. - [`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[, fromIndex][, 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. +- [`indexOfFalsy( x[, fromIndex][, options] )`][@stdlib/blas/ext/index-of-falsy]: return the index of the first falsy element along an ndarray dimension. +- [`indexOfNotEqual( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/index-of-not-equal]: return the first index of an element which is not equal to a specified search element along an ndarray dimension. - [`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. +- [`lastIndexOfFalsy( x[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of-falsy]: return the index of the last falsy element along an ndarray dimension. +- [`lastIndexOfTruthy( x[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of-truthy]: return the index of the last truthy element along an ndarray dimension. - [`lastIndexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of]: return the last index of a specified search element along an ndarray dimension. - [`linspace( shape, start, stop[, endpoint][, options] )`][@stdlib/blas/ext/linspace]: return a new ndarray filled with linearly spaced values over a specified interval along one or more ndarray dimensions. - [`logspace( shape, base, start, stop[, endpoint][, options] )`][@stdlib/blas/ext/logspace]: return a new ndarray filled with logarithmically spaced values over a specified interval along one or more ndarray dimensions. @@ -112,16 +120,32 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/copy-within]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/copy-within +[@stdlib/blas/ext/cuany]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/cuany + +[@stdlib/blas/ext/cuevery]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/cuevery + +[@stdlib/blas/ext/cunone]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/cunone + [@stdlib/blas/ext/cusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/cusum +[@stdlib/blas/ext/fill-range]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/fill-range + [@stdlib/blas/ext/find-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/find-index [@stdlib/blas/ext/find-last-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/find-last-index +[@stdlib/blas/ext/index-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/index-of-falsy + +[@stdlib/blas/ext/index-of-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/index-of-not-equal + [@stdlib/blas/ext/index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/index-of [@stdlib/blas/ext/join]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/join +[@stdlib/blas/ext/last-index-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/last-index-of-falsy + +[@stdlib/blas/ext/last-index-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/last-index-of-truthy + [@stdlib/blas/ext/last-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/last-index-of [@stdlib/blas/ext/linspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/linspace 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 7439090757c3..f6f8e891a1c8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -50,6 +50,7 @@ The namespace exposes the following APIs: - [`ccopyWithin( arrays )`][@stdlib/blas/ext/base/ndarray/ccopy-within]: perform an in-place copy of elements within a one-dimensional single-precision complex floating-point ndarray. - [`cdiff( arrays )`][@stdlib/blas/ext/base/ndarray/cdiff]: calculate the k-th discrete forward difference of a one-dimensional single-precision complex floating-point ndarray. - [`cfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/cfill-equal]: replace elements in a one-dimensional single-precision complex floating-point ndarray equal to a provided search element with a specified scalar constant. +- [`cfill( arrays )`][@stdlib/blas/ext/base/ndarray/cfill]: fill a one-dimensional single-precision complex floating-point ndarray with a specified scalar constant. - [`cindexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/cindex-of-falsy]: return the index of the first falsy element in a one-dimensional single-precision complex floating-point ndarray. - [`cindexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/cindex-of-truthy]: return the index of the first truthy element in a one-dimensional single-precision complex floating-point ndarray. - [`cindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/cindex-of]: return the first index of a search element in a one-dimensional single-precision complex floating-point ndarray. @@ -147,6 +148,7 @@ The namespace exposes the following APIs: - [`gcusumors( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumors]: compute the cumulative sum of a one-dimensional ndarray using ordinary recursive summation. - [`gcusumpw( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumpw]: compute the cumulative sum of a one-dimensional ndarray using pairwise summation. - [`gdiff( arrays )`][@stdlib/blas/ext/base/ndarray/gdiff]: calculate the k-th discrete forward difference of a one-dimensional ndarray. +- [`gfillBy( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfill-by]: fill a one-dimensional ndarray according to a provided callback function. - [`gfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-equal]: replace elements in a one-dimensional ndarray equal to a provided search element with a specified scalar constant. - [`gfillGreaterThanEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-greater-than-equal]: replace elements in a one-dimensional ndarray greater than or equal to a provided search element with a specified scalar constant. - [`gfillGreaterThan( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-greater-than]: replace elements in a one-dimensional ndarray greater than a provided search element with a specified scalar constant. @@ -268,6 +270,7 @@ The namespace exposes the following APIs: - [`zaxpby( arrays )`][@stdlib/blas/ext/base/ndarray/zaxpby]: multiply a one-dimensional double-precision complex floating-point ndarray by a scalar constant and add the result to a second one-dimensional double-precision complex floating-point ndarray multiplied by a scalar constant. - [`zcopyWithin( arrays )`][@stdlib/blas/ext/base/ndarray/zcopy-within]: perform an in-place copy of elements within a one-dimensional double-precision complex floating-point ndarray. - [`zdiff( arrays )`][@stdlib/blas/ext/base/ndarray/zdiff]: calculate the k-th discrete forward difference of a one-dimensional double-precision complex floating-point ndarray. +- [`zfill( arrays )`][@stdlib/blas/ext/base/ndarray/zfill]: fill a one-dimensional double-precision complex floating-point ndarray with a specified scalar constant. - [`zindexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/zindex-of-falsy]: return the index of the first falsy element in a one-dimensional double-precision complex floating-point ndarray. - [`zindexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/zindex-of-truthy]: return the index of the first truthy element in a one-dimensional double-precision complex floating-point ndarray. - [`zindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/zindex-of]: return the first index of a search element in a one-dimensional double-precision complex floating-point ndarray. @@ -338,6 +341,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/cfill-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cfill-equal +[@stdlib/blas/ext/base/ndarray/cfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cfill + [@stdlib/blas/ext/base/ndarray/cindex-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cindex-of-falsy [@stdlib/blas/ext/base/ndarray/cindex-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cindex-of-truthy @@ -532,6 +537,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/gdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gdiff +[@stdlib/blas/ext/base/ndarray/gfill-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfill-by + [@stdlib/blas/ext/base/ndarray/gfill-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfill-equal [@stdlib/blas/ext/base/ndarray/gfill-greater-than-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfill-greater-than-equal @@ -774,6 +781,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/zdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zdiff +[@stdlib/blas/ext/base/ndarray/zfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zfill + [@stdlib/blas/ext/base/ndarray/zindex-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zindex-of-falsy [@stdlib/blas/ext/base/ndarray/zindex-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zindex-of-truthy diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/README.md b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/README.md index 0d097e8e8813..7d4999a1f880 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/README.md +++ b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/README.md @@ -43,6 +43,7 @@ var o = ns;
+- [`float32`][@stdlib/fft/base/fftpack/ndarray/float32]: lower-level ndarray wrappers for single-precision floating-point FFTPACK fast Fourier transform routines. - [`float64`][@stdlib/fft/base/fftpack/ndarray/float64]: lower-level ndarray wrappers for double-precision floating-point FFTPACK fast Fourier transform routines. - [`generic`][@stdlib/fft/base/fftpack/ndarray/generic]: lower-level ndarray wrappers for generic FFTPACK fast Fourier transform routines. @@ -87,6 +88,8 @@ console.log( objectKeys( ns ) ); +[@stdlib/fft/base/fftpack/ndarray/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/float32 + [@stdlib/fft/base/fftpack/ndarray/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/float64 [@stdlib/fft/base/fftpack/ndarray/generic]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/generic diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float32/README.md b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float32/README.md index f3fe7cc1c216..85840249833c 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float32/README.md +++ b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float32/README.md @@ -43,6 +43,9 @@ var o = ns;
+- [`rfftf( arrays )`][@stdlib/fft/base/fftpack/ndarray/float32/rfftf]: compute the forward discrete Fourier transform (DFT) of a real-valued one-dimensional single-precision floating-point ndarray. +- [`rffti( arrays )`][@stdlib/fft/base/fftpack/ndarray/float32/rffti]: initialize a workspace array for performing a real-valued Fourier transform on a one-dimensional single-precision floating-point ndarray. +
@@ -84,6 +87,10 @@ console.log( objectKeys( ns ) ); +[@stdlib/fft/base/fftpack/ndarray/float32/rfftf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/float32/rfftf + +[@stdlib/fft/base/fftpack/ndarray/float32/rffti]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/float32/rffti + diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float64/README.md b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float64/README.md index a5f2ddebe933..b7aa17806f52 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float64/README.md +++ b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float64/README.md @@ -43,6 +43,7 @@ var o = ns;
+- [`rfftf( arrays )`][@stdlib/fft/base/fftpack/ndarray/float64/rfftf]: compute the forward discrete Fourier transform (DFT) of a real-valued one-dimensional double-precision floating-point ndarray. - [`rffti( arrays )`][@stdlib/fft/base/fftpack/ndarray/float64/rffti]: initialize a workspace array for performing a real-valued Fourier transform on a one-dimensional double-precision floating-point ndarray.
@@ -86,6 +87,8 @@ console.log( objectKeys( ns ) ); +[@stdlib/fft/base/fftpack/ndarray/float64/rfftf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/float64/rfftf + [@stdlib/fft/base/fftpack/ndarray/float64/rffti]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/float64/rffti