From 11aecdca5d4504b5449609c2655e42761b193402 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Mon, 17 Aug 2026 02:44:56 +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 | 3 +++ .../@stdlib/blas/ext/base/ndarray/README.md | 27 +++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/README.md b/lib/node_modules/@stdlib/blas/ext/README.md index 5c614d809a46..4ad1cd8d99ae 100644 --- a/lib/node_modules/@stdlib/blas/ext/README.md +++ b/lib/node_modules/@stdlib/blas/ext/README.md @@ -55,6 +55,7 @@ The namespace contains the following: - [`join( x[, options] )`][@stdlib/blas/ext/join]: return an ndarray created by joining elements using a separator along one or more ndarray dimensions. - [`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. - [`oneTo( shape[, options] )`][@stdlib/blas/ext/one-to]: return a new ndarray filled with linearly spaced numeric elements which increment by `1` starting from one along one or more ndarray dimensions. - [`sort( x[, sortOrder][, options] )`][@stdlib/blas/ext/sort]: sort an input ndarray along one or more ndarray dimensions. - [`sorthp( x[, sortOrder][, options] )`][@stdlib/blas/ext/sorthp]: sort an input ndarray along one or more ndarray dimensions using heapsort. @@ -125,6 +126,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/linspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/linspace +[@stdlib/blas/ext/logspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/logspace + [@stdlib/blas/ext/one-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/one-to [@stdlib/blas/ext/sort]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/sort 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 41766748d318..09b8c1a8d726 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -48,6 +48,7 @@ The namespace exposes the following APIs: - [`caxpb( arrays )`][@stdlib/blas/ext/base/ndarray/caxpb]: multiply each element in a one-dimensional single-precision complex floating-point ndarray by a scalar constant and add a scalar constant to each result. - [`caxpby( arrays )`][@stdlib/blas/ext/base/ndarray/caxpby]: multiply a one-dimensional single-precision complex floating-point ndarray by a scalar constant and add the result to a second one-dimensional single-precision complex floating-point ndarray multiplied by a scalar constant. - [`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. - [`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. @@ -69,6 +70,7 @@ 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. +- [`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. - [`dcusumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/dcusumkbn2]: compute the cumulative sum of a one-dimensional double-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm. @@ -87,6 +89,7 @@ The namespace exposes the following APIs: - [`dindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/dindex-of]: return the first index of a search element in a one-dimensional double-precision floating-point ndarray. - [`dlastIndexEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dlast-index-equal]: return the index of the last element in a one-dimensional double-precision floating-point ndarray equal to a corresponding element in another one-dimensional double-precision floating-point ndarray. - [`dlastIndexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/dlast-index-of-falsy]: return the index of the last falsy element in a one-dimensional double-precision floating-point ndarray. +- [`dlastIndexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/dlast-index-of-truthy]: return the index of the last truthy element in a one-dimensional double-precision floating-point ndarray. - [`dlastIndexOf( arrays )`][@stdlib/blas/ext/base/ndarray/dlast-index-of]: return the last index of a search element in a one-dimensional double-precision floating-point ndarray. - [`dlinspace( arrays )`][@stdlib/blas/ext/base/ndarray/dlinspace]: fill a one-dimensional double-precision floating-point ndarray with linearly spaced values over a specified interval. - [`dlogspace( arrays )`][@stdlib/blas/ext/base/ndarray/dlogspace]: fill a one-dimensional double-precision floating-point ndarray with logarithmically spaced values over a specified interval. @@ -122,11 +125,13 @@ 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. +- [`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. - [`gcusumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumkbn2]: compute the cumulative sum of a one-dimensional ndarray using a second-order iterative Kahan–Babuška algorithm. - [`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. - [`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. - [`gfillNaN( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-nan]: replace elements in a one-dimensional ndarray equal to `NaN` with a specified scalar constant. - [`gfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-not-equal]: replace elements in a one-dimensional ndarray not equal to a provided search element with a specified scalar constant. @@ -143,6 +148,7 @@ The namespace exposes the following APIs: - [`gjoin( arrays )`][@stdlib/blas/ext/base/ndarray/gjoin]: return a string created by joining one-dimensional ndarray elements using a specified separator. - [`glastIndexEqual( arrays )`][@stdlib/blas/ext/base/ndarray/glast-index-equal]: return the index of the last element in a one-dimensional ndarray equal to a corresponding element in another one-dimensional ndarray. - [`glastIndexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/glast-index-of-falsy]: return the index of the last falsy element in a one-dimensional ndarray. +- [`glastIndexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/glast-index-of-truthy]: return the index of the last truthy element in a one-dimensional ndarray. - [`glastIndexOf( arrays )`][@stdlib/blas/ext/base/ndarray/glast-index-of]: return the last index of a search element in a one-dimensional ndarray. - [`glinspace( arrays )`][@stdlib/blas/ext/base/ndarray/glinspace]: fill a one-dimensional ndarray with linearly spaced values over a specified interval. - [`glogspace( arrays )`][@stdlib/blas/ext/base/ndarray/glogspace]: fill a one-dimensional ndarray with logarithmically spaced values over a specified interval. @@ -181,6 +187,7 @@ The namespace exposes the following APIs: - [`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. - [`scusumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/scusumkbn2]: compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm. - [`scusumors( arrays )`][@stdlib/blas/ext/base/ndarray/scusumors]: compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation. +- [`sdiff( arrays )`][@stdlib/blas/ext/base/ndarray/sdiff]: calculate the k-th discrete forward difference of a one-dimensional single-precision floating-point ndarray. - [`sfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sfill-equal]: replace elements in a one-dimensional single-precision floating-point ndarray equal to a provided search element with a specified scalar constant. - [`sfillNaN( arrays )`][@stdlib/blas/ext/base/ndarray/sfill-nan]: replace elements in a one-dimensional single-precision floating-point ndarray equal to `NaN` with a specified scalar constant. - [`sfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sfill-not-equal]: replace elements in a one-dimensional single-precision floating-point ndarray not equal to a provided search element with a specified scalar constant. @@ -190,6 +197,7 @@ The namespace exposes the following APIs: - [`sindexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/sindex-of-truthy]: return the index of the first truthy element in a one-dimensional single-precision floating-point ndarray. - [`sindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/sindex-of]: return the first index of a search element in a one-dimensional single-precision floating-point ndarray. - [`slastIndexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/slast-index-of-falsy]: return the index of the last falsy element in a one-dimensional single-precision floating-point ndarray. +- [`slastIndexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/slast-index-of-truthy]: return the index of the last truthy element in a one-dimensional single-precision floating-point ndarray. - [`slastIndexOf( arrays )`][@stdlib/blas/ext/base/ndarray/slast-index-of]: return the last index of a search element in a one-dimensional single-precision floating-point ndarray. - [`slinspace( arrays )`][@stdlib/blas/ext/base/ndarray/slinspace]: fill a one-dimensional single-precision floating-point ndarray with linearly spaced values over a specified interval. - [`slogspace( arrays )`][@stdlib/blas/ext/base/ndarray/slogspace]: fill a one-dimensional single-precision floating-point ndarray with logarithmically spaced values over a specified interval. @@ -220,6 +228,7 @@ The namespace exposes the following APIs: - [`zaxpb( arrays )`][@stdlib/blas/ext/base/ndarray/zaxpb]: multiply each element in a one-dimensional double-precision complex floating-point ndarray by a scalar constant and add a scalar constant to each result. - [`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. - [`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. - [`zlogspace( arrays )`][@stdlib/blas/ext/base/ndarray/zlogspace]: fill a one-dimensional double-precision complex floating-point ndarray with logarithmically spaced values over a specified interval. @@ -284,6 +293,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/ccopy-within]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ccopy-within +[@stdlib/blas/ext/base/ndarray/cdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cdiff + [@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/cindex-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cindex-of-truthy @@ -326,6 +337,8 @@ 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/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 [@stdlib/blas/ext/base/ndarray/dcusumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dcusumkbn @@ -362,6 +375,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/dlast-index-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dlast-index-of-falsy +[@stdlib/blas/ext/base/ndarray/dlast-index-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dlast-index-of-truthy + [@stdlib/blas/ext/base/ndarray/dlast-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dlast-index-of [@stdlib/blas/ext/base/ndarray/dlinspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dlinspace @@ -432,6 +447,8 @@ 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/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 [@stdlib/blas/ext/base/ndarray/gcusumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcusumkbn @@ -442,6 +459,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/gcusumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcusumpw +[@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-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-nan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfill-nan @@ -474,6 +493,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/glast-index-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/glast-index-of-falsy +[@stdlib/blas/ext/base/ndarray/glast-index-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/glast-index-of-truthy + [@stdlib/blas/ext/base/ndarray/glast-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/glast-index-of [@stdlib/blas/ext/base/ndarray/glinspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/glinspace @@ -550,6 +571,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/scusumors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/scusumors +[@stdlib/blas/ext/base/ndarray/sdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sdiff + [@stdlib/blas/ext/base/ndarray/sfill-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sfill-equal [@stdlib/blas/ext/base/ndarray/sfill-nan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sfill-nan @@ -568,6 +591,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/slast-index-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/slast-index-of-falsy +[@stdlib/blas/ext/base/ndarray/slast-index-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/slast-index-of-truthy + [@stdlib/blas/ext/base/ndarray/slast-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/slast-index-of [@stdlib/blas/ext/base/ndarray/slinspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/slinspace @@ -628,6 +653,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/zcopy-within]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zcopy-within +[@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/zindex-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zindex-of-truthy [@stdlib/blas/ext/base/ndarray/zindex-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zindex-of