From 5bccbd363a549c96e72378acfd92bb18aad7a9ca Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Thu, 13 Aug 2026 03:12:54 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/blas/ext/base/ndarray/README.md | 27 +++++++++++++++++++ .../@stdlib/stats/base/dists/README.md | 3 +++ 2 files changed, 30 insertions(+) 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 9333933c3a8d..d52fe7737c42 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -47,6 +47,8 @@ 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. +- [`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. - [`coneTo( arrays )`][@stdlib/blas/ext/base/ndarray/cone-to]: fill a one-dimensional single-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one. @@ -74,6 +76,7 @@ The namespace exposes the following APIs: - [`dfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-equal]: replace elements in a one-dimensional double-precision floating-point ndarray equal to a provided search element with a specified scalar constant. - [`dfillNaN( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-nan]: replace elements in a one-dimensional double-precision floating-point ndarray equal to `NaN` with a specified scalar constant. - [`dfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-not-equal]: replace elements in a one-dimensional double-precision floating-point ndarray not equal to a provided search element with a specified scalar constant. +- [`dfirstIndexEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dfirst-index-equal]: return the index of the first element in a one-dimensional double-precision floating-point ndarray equal to a corresponding element in another one-dimensional double-precision floating-point ndarray. - [`dfirstIndexGreaterThan( arrays )`][@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than]: return the index of the first element in a one-dimensional double-precision floating-point ndarray which is greater than a corresponding element in another one-dimensional double-precision floating-point ndarray. - [`dfirstIndexLessThan( arrays )`][@stdlib/blas/ext/base/ndarray/dfirst-index-less-than]: return the index of the first element in a one-dimensional double-precision floating-point ndarray which is less than a corresponding element in another one-dimensional double-precision floating-point ndarray. - [`dindexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/dindex-of-falsy]: return the index of the first falsy element in a one-dimensional double-precision floating-point ndarray. @@ -81,6 +84,7 @@ The namespace exposes the following APIs: - [`dindexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/dindex-of-truthy]: return the index of the first truthy element in a one-dimensional double-precision floating-point ndarray. - [`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. - [`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. - [`dnansum( arrays )`][@stdlib/blas/ext/base/ndarray/dnansum]: compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values. @@ -122,6 +126,7 @@ The namespace exposes the following APIs: - [`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. - [`gfindIndex( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfind-index]: return the index of the first element in a one-dimensional ndarray which passes a test implemented by a predicate function. - [`gfindLastIndex( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfind-last-index]: return the index of the last element in a one-dimensional ndarray which passes a test implemented by a predicate function. +- [`gfirstIndexEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfirst-index-equal]: return the index of the first element in a one-dimensional ndarray equal to a corresponding element in another one-dimensional ndarray. - [`gfirstIndexGreaterThan( arrays )`][@stdlib/blas/ext/base/ndarray/gfirst-index-greater-than]: return the index of the first element in a one-dimensional ndarray which is greater than a corresponding element in another one-dimensional ndarray. - [`gfirstIndexLessThan( arrays )`][@stdlib/blas/ext/base/ndarray/gfirst-index-less-than]: return the index of the first element in a one-dimensional ndarray which is less than a corresponding element in another one-dimensional ndarray. - [`gindexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/gindex-of-falsy]: return the index of the first falsy element in a one-dimensional ndarray. @@ -131,6 +136,7 @@ The namespace exposes the following APIs: - [`gjoinBetween( arrays )`][@stdlib/blas/ext/base/ndarray/gjoin-between]: return a string by joining one-dimensional ndarray elements using a specified separator for each pair of consecutive elements. - [`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. - [`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. - [`gnansum( arrays )`][@stdlib/blas/ext/base/ndarray/gnansum]: compute the sum of a one-dimensional ndarray, ignoring `NaN` values. @@ -165,8 +171,10 @@ 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. +- [`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. +- [`sfirstIndexEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sfirst-index-equal]: return the index of the first element in a one-dimensional single-precision floating-point ndarray equal to a corresponding element in another one-dimensional single-precision floating-point ndarray. - [`sfirstIndexLessThan( arrays )`][@stdlib/blas/ext/base/ndarray/sfirst-index-less-than]: return the index of the first element in a one-dimensional single-precision floating-point ndarray which is less than a corresponding element in another one-dimensional single-precision floating-point ndarray. - [`sindexOfNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sindex-of-not-equal]: return the first index of an element in a one-dimensional single-precision floating-point ndarray which is not equal to a specified search element. - [`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. @@ -197,6 +205,7 @@ The namespace exposes the following APIs: - [`szeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/szero-to]: fill a one-dimensional single-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from zero. - [`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. - [`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. - [`zoneTo( arrays )`][@stdlib/blas/ext/base/ndarray/zone-to]: fill a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one. @@ -257,6 +266,10 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/caxpby]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/caxpby +[@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/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 [@stdlib/blas/ext/base/ndarray/cindex-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cindex-of @@ -311,6 +324,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/dfill-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dfill-not-equal +[@stdlib/blas/ext/base/ndarray/dfirst-index-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dfirst-index-equal + [@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dfirst-index-greater-than [@stdlib/blas/ext/base/ndarray/dfirst-index-less-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dfirst-index-less-than @@ -325,6 +340,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/dlast-index-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dlast-index-equal +[@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]: 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 @@ -407,6 +424,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/gfind-last-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfind-last-index +[@stdlib/blas/ext/base/ndarray/gfirst-index-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfirst-index-equal + [@stdlib/blas/ext/base/ndarray/gfirst-index-greater-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfirst-index-greater-than [@stdlib/blas/ext/base/ndarray/gfirst-index-less-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfirst-index-less-than @@ -425,6 +444,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/glast-index-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/glast-index-equal +[@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]: 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 @@ -493,10 +514,14 @@ 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/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 [@stdlib/blas/ext/base/ndarray/sfill-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sfill-not-equal +[@stdlib/blas/ext/base/ndarray/sfirst-index-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sfirst-index-equal + [@stdlib/blas/ext/base/ndarray/sfirst-index-less-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sfirst-index-less-than [@stdlib/blas/ext/base/ndarray/sindex-of-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sindex-of-not-equal @@ -557,6 +582,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/zaxpby]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zaxpby +[@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/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 diff --git a/lib/node_modules/@stdlib/stats/base/dists/README.md b/lib/node_modules/@stdlib/stats/base/dists/README.md index bed312e6b954..b4cf34fe6b42 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/README.md @@ -74,6 +74,7 @@ var distributions = dists; - [`triangular`][@stdlib/stats/base/dists/triangular]: triangular distribution. - [`truncatedNormal`][@stdlib/stats/base/dists/truncated-normal]: truncated normal distribution. - [`uniform`][@stdlib/stats/base/dists/uniform]: continuous uniform distribution. +- [`weibull`][@stdlib/stats/base/dists/weibull]: Weibull distribution. @@ -223,6 +224,8 @@ console.log( objectKeys( dists ) ); [@stdlib/stats/base/dists/uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/uniform +[@stdlib/stats/base/dists/weibull]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dists/weibull +