From eb33d3dc3dd43930144f7ba7e45ef778b8749249 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Fri, 2 Oct 2026 02:37:11 +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/README.md | 3 +++ .../@stdlib/blas/ext/base/ndarray/README.md | 27 +++++++++++++++++++ 3 files changed, 33 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/README.md b/lib/node_modules/@stdlib/blas/ext/README.md index 41613cc41dd4..24da217d251f 100644 --- a/lib/node_modules/@stdlib/blas/ext/README.md +++ b/lib/node_modules/@stdlib/blas/ext/README.md @@ -51,6 +51,7 @@ The namespace contains the following: - [`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. +- [`cusome( x, k[, options] )`][@stdlib/blas/ext/cusome]: cumulatively test whether at least `k` elements along one or more ndarray dimensions are truthy. - [`cusum( x[, initial][, options] )`][@stdlib/blas/ext/cusum]: compute the cumulative sum along one or more ndarray dimensions. - [`fillBetween( x, value[, start[, end]][, options] )`][@stdlib/blas/ext/fill-between]: fill an input ndarray with a specified value along an ndarray dimension. - [`findIndexBetween( x, fromIndex, toIndex[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-index-between]: return the index of the first element along an ndarray dimension which passes a test implemented by a predicate function within a specified range. @@ -129,6 +130,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/cunone]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/cunone +[@stdlib/blas/ext/cusome]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/cusome + [@stdlib/blas/ext/cusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/cusum [@stdlib/blas/ext/fill-between]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/fill-between diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 61dc3e48186f..1b469c70b459 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -249,6 +249,7 @@ var o = ns; - [`gindexOfColumn( order, M, N, A, LDA, x, strideX )`][@stdlib/blas/ext/base/gindex-of-column]: return the index of the first column in an input matrix which has the same elements as a provided search vector. - [`gindexOfFalsyRow( order, M, N, A, LDA )`][@stdlib/blas/ext/base/gindex-of-falsy-row]: return the index of the first row in an input matrix in which all elements are falsy. - [`gindexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/gindex-of-falsy]: return the index of the first falsy element in a strided array. +- [`gindexOfGreaterThanEqualSorted( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than-equal-sorted]: return the index of the first element in a sorted strided array which is greater than or equal to a specified search element. - [`gindexOfGreaterThanEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than-equal]: return the first index of an element in a strided array which is greater than or equal to a specified search element. - [`gindexOfGreaterThanSorted( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than-sorted]: return the index of the first element in a sorted strided array which is greater than a specified search element. - [`gindexOfGreaterThan( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than]: return the first index of an element in a strided array which is greater than a specified search element. @@ -935,6 +936,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/gindex-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-falsy +[@stdlib/blas/ext/base/gindex-of-greater-than-equal-sorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-greater-than-equal-sorted + [@stdlib/blas/ext/base/gindex-of-greater-than-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-greater-than-equal [@stdlib/blas/ext/base/gindex-of-greater-than-sorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-greater-than-sorted 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 ee5ab0695eba..df0dced38114 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -66,6 +66,7 @@ The namespace exposes the following APIs: - [`cwax( arrays )`][@stdlib/blas/ext/base/ndarray/cwax]: multiply each element in an input one-dimensional single-precision complex floating-point ndarray by a scalar constant and assign the results to elements in a one-dimensional single-precision complex floating-point output ndarray. - [`cwhere( arrays )`][@stdlib/blas/ext/base/ndarray/cwhere]: take elements from one of two one-dimensional single-precision complex floating-point ndarrays depending on a condition. - [`cwxsa( arrays )`][@stdlib/blas/ext/base/ndarray/cwxsa]: subtract a scalar constant from each element in an input one-dimensional single-precision complex floating-point ndarray and assign the results to elements in a one-dimensional single-precision complex floating-point output ndarray. +- [`cxdy( arrays )`][@stdlib/blas/ext/base/ndarray/cxdy]: divide elements of a one-dimensional single-precision complex floating-point ndarray by the corresponding elements of a second one-dimensional single-precision complex floating-point ndarray and assign the results to the second ndarray. - [`cxmy( arrays )`][@stdlib/blas/ext/base/ndarray/cxmy]: multiply elements of a one-dimensional single-precision complex floating-point ndarray by the corresponding elements of a second one-dimensional single-precision complex floating-point ndarray and assign the results to the second ndarray. - [`cxpy( arrays )`][@stdlib/blas/ext/base/ndarray/cxpy]: add elements of a one-dimensional single-precision complex floating-point ndarray to the corresponding elements of a second one-dimensional single-precision complex floating-point ndarray and assign the results to the second ndarray. - [`cxsa( arrays )`][@stdlib/blas/ext/base/ndarray/cxsa]: subtract a scalar constant from each element in a one-dimensional single-precision complex floating-point ndarray. @@ -133,7 +134,9 @@ The namespace exposes the following APIs: - [`dwapx( arrays )`][@stdlib/blas/ext/base/ndarray/dwapx]: add a scalar constant to each element in an input one-dimensional double-precision floating-point ndarray and assign the results to elements in a one-dimensional double-precision floating-point output ndarray. - [`dwax( arrays )`][@stdlib/blas/ext/base/ndarray/dwax]: multiply each element in an input one-dimensional double-precision floating-point ndarray by a scalar constant and assign the results to elements in a one-dimensional double-precision floating-point output ndarray. - [`dwhere( arrays )`][@stdlib/blas/ext/base/ndarray/dwhere]: take elements from one of two one-dimensional double-precision floating-point ndarrays depending on a condition. +- [`dwxpy( arrays )`][@stdlib/blas/ext/base/ndarray/dwxpy]: add elements of a one-dimensional double-precision floating-point ndarray to the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assign the results to elements in a third one-dimensional double-precision floating-point ndarray. - [`dwxsa( arrays )`][@stdlib/blas/ext/base/ndarray/dwxsa]: subtract a scalar constant from each element in an input one-dimensional double-precision floating-point ndarray and assign the results to elements in a one-dimensional double-precision floating-point output ndarray. +- [`dwxsy( arrays )`][@stdlib/blas/ext/base/ndarray/dwxsy]: subtract elements of a second one-dimensional double-precision floating-point ndarray from the corresponding elements of a first one-dimensional double-precision floating-point ndarray and assign the results to elements in a third one-dimensional double-precision floating-point ndarray. - [`dxdy( arrays )`][@stdlib/blas/ext/base/ndarray/dxdy]: divide elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assign the results to the second ndarray. - [`dxmy( arrays )`][@stdlib/blas/ext/base/ndarray/dxmy]: multiply elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assign the results to the second ndarray. - [`dxpy( arrays )`][@stdlib/blas/ext/base/ndarray/dxpy]: add elements of a one-dimensional double-precision floating-point ndarray to the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assign the results to the second ndarray. @@ -211,9 +214,13 @@ The namespace exposes the following APIs: - [`gvander( arrays )`][@stdlib/blas/ext/base/ndarray/gvander]: generate a Vandermonde matrix. - [`gwapx( arrays )`][@stdlib/blas/ext/base/ndarray/gwapx]: add a scalar constant to each element in an input one-dimensional ndarray and assign the results to elements in a one-dimensional output ndarray. - [`gwax( arrays )`][@stdlib/blas/ext/base/ndarray/gwax]: multiply each element in an input one-dimensional ndarray by a scalar constant and assign the results to elements in a one-dimensional output ndarray. +- [`gwaxpb( arrays )`][@stdlib/blas/ext/base/ndarray/gwaxpb]: multiply each element in an input one-dimensional ndarray by a scalar constant and add a scalar constant before assigning the results to elements in a one-dimensional output ndarray. - [`gwhere( arrays )`][@stdlib/blas/ext/base/ndarray/gwhere]: take elements from one of two one-dimensional ndarrays depending on a condition. +- [`gwxdy( arrays )`][@stdlib/blas/ext/base/ndarray/gwxdy]: divide elements of a one-dimensional ndarray by the corresponding elements of a second one-dimensional ndarray and assign the results to elements in a third one-dimensional ndarray. +- [`gwxmy( arrays )`][@stdlib/blas/ext/base/ndarray/gwxmy]: multiply elements of a one-dimensional ndarray by the corresponding elements of a second one-dimensional ndarray and assign the results to elements in a third one-dimensional ndarray. - [`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. +- [`gwxsy( arrays )`][@stdlib/blas/ext/base/ndarray/gwxsy]: subtract elements of a second one-dimensional ndarray from the corresponding elements of a first one-dimensional ndarray and assign the results to elements in a third one-dimensional 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. - [`gxpy( arrays )`][@stdlib/blas/ext/base/ndarray/gxpy]: add elements of a one-dimensional ndarray to the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray. @@ -274,7 +281,9 @@ The namespace exposes the following APIs: - [`swapx( arrays )`][@stdlib/blas/ext/base/ndarray/swapx]: add a scalar constant to each element in an input one-dimensional single-precision floating-point ndarray and assign the results to elements in a one-dimensional single-precision floating-point output ndarray. - [`swax( arrays )`][@stdlib/blas/ext/base/ndarray/swax]: multiply each element in an input one-dimensional single-precision floating-point ndarray by a scalar constant and assign the results to elements in a one-dimensional single-precision floating-point output ndarray. - [`swhere( arrays )`][@stdlib/blas/ext/base/ndarray/swhere]: take elements from one of two one-dimensional single-precision floating-point ndarrays depending on a condition. +- [`swxpy( arrays )`][@stdlib/blas/ext/base/ndarray/swxpy]: add elements of a one-dimensional single-precision floating-point ndarray to the corresponding elements of a second one-dimensional single-precision floating-point ndarray and assign the results to elements in a third one-dimensional single-precision floating-point ndarray. - [`swxsa( arrays )`][@stdlib/blas/ext/base/ndarray/swxsa]: subtract a scalar constant from each element in an input one-dimensional single-precision floating-point ndarray and assign the results to elements in a one-dimensional single-precision floating-point output ndarray. +- [`swxsy( arrays )`][@stdlib/blas/ext/base/ndarray/swxsy]: subtract elements of a second one-dimensional single-precision floating-point ndarray from the corresponding elements of a first one-dimensional single-precision floating-point ndarray and assign the results to elements in a third one-dimensional single-precision floating-point ndarray. - [`sxdy( arrays )`][@stdlib/blas/ext/base/ndarray/sxdy]: divide elements of a one-dimensional single-precision floating-point ndarray by the corresponding elements of a second one-dimensional single-precision floating-point ndarray and assign the results to the second ndarray. - [`sxmy( arrays )`][@stdlib/blas/ext/base/ndarray/sxmy]: multiply elements of a one-dimensional single-precision floating-point ndarray by the corresponding elements of a second one-dimensional single-precision floating-point ndarray and assign the results to the second ndarray. - [`sxpy( arrays )`][@stdlib/blas/ext/base/ndarray/sxpy]: add elements of a one-dimensional single-precision floating-point ndarray to the corresponding elements of a second one-dimensional single-precision floating-point ndarray and assign the results to the second ndarray. @@ -390,6 +399,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/cwxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cwxsa +[@stdlib/blas/ext/base/ndarray/cxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cxdy + [@stdlib/blas/ext/base/ndarray/cxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cxmy [@stdlib/blas/ext/base/ndarray/cxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cxpy @@ -524,8 +535,12 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/dwhere]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dwhere +[@stdlib/blas/ext/base/ndarray/dwxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dwxpy + [@stdlib/blas/ext/base/ndarray/dwxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dwxsa +[@stdlib/blas/ext/base/ndarray/dwxsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dwxsy + [@stdlib/blas/ext/base/ndarray/dxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dxdy [@stdlib/blas/ext/base/ndarray/dxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dxmy @@ -680,12 +695,20 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/gwax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gwax +[@stdlib/blas/ext/base/ndarray/gwaxpb]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gwaxpb + [@stdlib/blas/ext/base/ndarray/gwhere]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gwhere +[@stdlib/blas/ext/base/ndarray/gwxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gwxdy + +[@stdlib/blas/ext/base/ndarray/gwxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gwxmy + [@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/gwxsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gwxsy + [@stdlib/blas/ext/base/ndarray/gxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gxdy [@stdlib/blas/ext/base/ndarray/gxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gxmy @@ -806,8 +829,12 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/swhere]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/swhere +[@stdlib/blas/ext/base/ndarray/swxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/swxpy + [@stdlib/blas/ext/base/ndarray/swxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/swxsa +[@stdlib/blas/ext/base/ndarray/swxsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/swxsy + [@stdlib/blas/ext/base/ndarray/sxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sxdy [@stdlib/blas/ext/base/ndarray/sxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sxmy