From 971f07f8702564bb9ecad71cc951ac5a96cfd339 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Sat, 1 Aug 2026 03:24:41 +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/README.md | 24 +++++++++++++++++++ .../@stdlib/blas/ext/base/ndarray/README.md | 6 +++++ 2 files changed, 30 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index e8e6d8bc83c7..403a49866d83 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -49,6 +49,7 @@ var o = ns; - [`cdiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/cdiff]: calculate the k-th discrete forward difference of a single-precision complex floating-point strided array. - [`cfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/cfill]: fill a single-precision complex floating-point strided array with a specified scalar constant. - [`cindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-column]: return the index of the first column in a single-precision complex floating-point input matrix which has the same elements as a provided search vector. +- [`cindexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/cindex-of-falsy]: return the index of the first falsy element in a single-precision complex floating-point strided array. - [`cindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-row]: return the index of the first row in a single-precision complex floating-point input matrix which has the same elements as a provided search vector. - [`cindexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/cindex-of-truthy]: return the index of the first truthy element in a single-precision complex floating-point strided array. - [`cindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/cindex-of]: return the first index of a specified search element in a single-precision complex floating-point strided array. @@ -98,6 +99,7 @@ var o = ns; - [`dfillNotEqual( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill-not-equal]: replace double-precision floating-point strided array elements not equal to a provided search element with a specified scalar constant. - [`dfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill]: fill a double-precision floating-point strided array with a specified scalar constant. - [`dfirstIndexEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dfirst-index-equal]: return the index of the first element in a double-precision floating-point strided array equal to a corresponding element in another double-precision floating-point strided array. +- [`dfirstIndexGreaterThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dfirst-index-greater-than]: return the index of the first element in a double-precision floating-point strided array which is greater than a corresponding element in another double-precision floating-point strided array. - [`dfirstIndexLessThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dfirst-index-less-than]: return the index of the first element in a double-precision floating-point strided array which is less than a corresponding element in another double-precision floating-point strided array. - [`dindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/dindex-of-column]: return the index of the first column in a double-precision floating-point input matrix which has the same elements as a provided search vector. - [`dindexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/dindex-of-falsy]: return the index of the first falsy element in a double-precision floating-point strided array. @@ -159,6 +161,7 @@ var o = ns; - [`dsumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/dsumkbn2]: calculate the sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm. - [`dsumors( N, x, strideX )`][@stdlib/blas/ext/base/dsumors]: calculate the sum of double-precision floating-point strided array elements using ordinary recursive summation. - [`dsumpw( N, x, strideX )`][@stdlib/blas/ext/base/dsumpw]: calculate the sum of double-precision floating-point strided array elements using pairwise summation. +- [`dtriu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/dtriu]: copy the upper triangular part of a double-precision floating-point matrix `A` to another matrix `B`. - [`dunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/dunitspace]: fill a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value. - [`dvander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/dvander]: generate a double-precision floating-point Vandermonde matrix. - [`dwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/dwapx]: add a scalar constant to each element in a double-precision floating-point strided array `x` and assign the results to elements in a double-precision floating-point strided array `w`. @@ -317,6 +320,7 @@ var o = ns; - [`sfirstIndexLessThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sfirst-index-less-than]: return the index of the first element in a single-precision floating-point strided array which is less than a corresponding element in another single-precision floating-point strided array. - [`sindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/sindex-of-column]: return the index of the first column in a single-precision floating-point input matrix which has the same elements as a provided search vector. - [`sindexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/sindex-of-falsy]: return the index of the first falsy element in a single-precision floating-point strided array. +- [`sindexOfNotEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/sindex-of-not-equal]: return the first index of an element in a single-precision floating-point strided array which is not equal to a specified search element. - [`sindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/sindex-of-row]: return the index of the first row in a single-precision floating-point input matrix which has the same elements as a provided search vector. - [`sindexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/sindex-of-truthy]: return the index of the first truthy element in a single-precision floating-point strided array. - [`sindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/sindex-of]: return the first index of a specified search element in a single-precision floating-point strided array. @@ -352,6 +356,7 @@ var o = ns; - [`ssumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/ssumkbn2]: calculate the sum of single-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm. - [`ssumors( N, x, strideX )`][@stdlib/blas/ext/base/ssumors]: calculate the sum of single-precision floating-point strided array elements using ordinary recursive summation. - [`ssumpw( N, x, strideX )`][@stdlib/blas/ext/base/ssumpw]: calculate the sum of single-precision floating-point strided array elements using pairwise summation. +- [`striu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/striu]: copy the upper triangular part of a single-precision floating-point matrix `A` to another matrix `B`. - [`sunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/sunitspace]: fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value. - [`svander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/svander]: generate a single-precision floating-point Vandermonde matrix. - [`swapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/swapx]: add a scalar constant to each element in a single-precision floating-point strided array `x` and assign the results to elements in a single-precision floating-point strided array `w`. @@ -369,6 +374,7 @@ var o = ns; - [`szeroTo( N, x, strideX )`][@stdlib/blas/ext/base/szero-to]: fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero. - [`szeros( N, x, strideX )`][@stdlib/blas/ext/base/szeros]: fill a single-precision floating-point strided array with zeros. - [`wasm`][@stdlib/blas/ext/base/wasm]: extensions to basic linear algebra subprograms (BLAS) compiled to WebAssembly. +- [`zany( N, x, strideX )`][@stdlib/blas/ext/base/zany]: test whether at least one element in a double-precision complex floating-point strided array is truthy. - [`zapx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zapx]: add a scalar constant to each element in a double-precision complex floating-point strided array. - [`zaxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/zaxpb]: multiply each element in a double-precision complex floating-point strided array by a scalar constant and add a scalar constant to each result. - [`zaxpby( N, alpha, x, strideX, beta, y, strideY )`][@stdlib/blas/ext/base/zaxpby]: multiply a double-precision complex floating-point strided array `x` by a constant and add the result to a double-precision complex floating-point strided array `y` multiplied by a constant. @@ -381,6 +387,7 @@ var o = ns; - [`zindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-row]: return the index of the first row in a double-precision complex floating-point input matrix which has the same elements as a provided search vector. - [`zindexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/zindex-of-truthy]: return the index of the first truthy element in a double-precision complex floating-point strided array. - [`zindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/zindex-of]: return the first index of a specified search element in a double-precision complex floating-point strided array. +- [`zlastIndexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/zlast-index-of-falsy]: return the index of the last falsy element in a double-precision complex floating-point strided array. - [`zlastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zlast-index-of-row]: return the index of the last row in a double-precision complex floating-point input matrix which has the same elements as a provided search vector. - [`zlogspace( N, base, start, stop, endpoint, x, strideX )`][@stdlib/blas/ext/base/zlogspace]: fill a double-precision complex floating-point strided array with logarithmically spaced values over a specified interval. - [`znancount( N, x, strideX )`][@stdlib/blas/ext/base/znancount]: calculate the number of non-`NaN` elements in a double-precision complex floating-point strided array. @@ -392,6 +399,7 @@ var o = ns; - [`zwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwapx]: add a scalar constant to each element in a double-precision complex floating-point strided array `x` and assign the results to elements in a double-precision complex floating-point strided array `w`. - [`zwax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwax]: multiply each element in a double-precision complex floating-point strided array `x` by a scalar constant and assign the results to elements in a double-precision complex floating-point strided array `w`. - [`zwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/zwhere]: take elements from one of two double-precision complex floating-point strided arrays depending on a condition. +- [`zwxmy( N, x, strideX, y, strideY, w, strideW )`][@stdlib/blas/ext/base/zwxmy]: multiply elements of a double-precision complex floating-point strided array `x` by the corresponding elements of a double-precision complex floating-point strided array `y` and assign the results to elements in a double-precision complex floating-point strided array `w`. - [`zwxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwxsa]: subtract a scalar constant from each element in a double-precision complex floating-point strided array `x` and assign the results to elements in a double-precision complex floating-point strided array `w`. - [`zxdy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/zxdy]: divide elements of a double-precision complex floating-point strided array `x` by the corresponding elements of a double-precision complex floating-point strided array `y` and assign the results to `y`. - [`zxmy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/zxmy]: multiply elements of a double-precision complex floating-point strided array `x` by the corresponding elements of a double-precision complex floating-point strided array `y` and assign the results to `y`. @@ -461,6 +469,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/cindex-of-column]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cindex-of-column +[@stdlib/blas/ext/base/cindex-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cindex-of-falsy + [@stdlib/blas/ext/base/cindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cindex-of-row [@stdlib/blas/ext/base/cindex-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cindex-of-truthy @@ -559,6 +569,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/dfirst-index-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dfirst-index-equal +[@stdlib/blas/ext/base/dfirst-index-greater-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dfirst-index-greater-than + [@stdlib/blas/ext/base/dfirst-index-less-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dfirst-index-less-than [@stdlib/blas/ext/base/dindex-of-column]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dindex-of-column @@ -681,6 +693,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/dsumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dsumpw +[@stdlib/blas/ext/base/dtriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dtriu + [@stdlib/blas/ext/base/dunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dunitspace [@stdlib/blas/ext/base/dvander]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dvander @@ -997,6 +1011,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/sindex-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sindex-of-falsy +[@stdlib/blas/ext/base/sindex-of-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sindex-of-not-equal + [@stdlib/blas/ext/base/sindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sindex-of-row [@stdlib/blas/ext/base/sindex-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sindex-of-truthy @@ -1067,6 +1083,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ssumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ssumpw +[@stdlib/blas/ext/base/striu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/striu + [@stdlib/blas/ext/base/sunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sunitspace [@stdlib/blas/ext/base/svander]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/svander @@ -1101,6 +1119,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/wasm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/wasm +[@stdlib/blas/ext/base/zany]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zany + [@stdlib/blas/ext/base/zapx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zapx [@stdlib/blas/ext/base/zaxpb]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zaxpb @@ -1125,6 +1145,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/zindex-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zindex-of +[@stdlib/blas/ext/base/zlast-index-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zlast-index-of-falsy + [@stdlib/blas/ext/base/zlast-index-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zlast-index-of-row [@stdlib/blas/ext/base/zlogspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zlogspace @@ -1147,6 +1169,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/zwhere]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zwhere +[@stdlib/blas/ext/base/zwxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zwxmy + [@stdlib/blas/ext/base/zwxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zwxsa [@stdlib/blas/ext/base/zxdy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zxdy 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 52757a9e00f1..f8f5a06f3f0f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -108,6 +108,7 @@ The namespace exposes the following APIs: - [`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. +- [`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. - [`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. @@ -151,6 +152,7 @@ The namespace exposes the following APIs: - [`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. - [`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. +- [`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. - [`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. - [`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. @@ -357,6 +359,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/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-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfill-not-equal [@stdlib/blas/ext/base/ndarray/gfind-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfind-index @@ -443,6 +447,8 @@ console.log( objectKeys( ns ) ); [@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/sindex-of-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sindex-of-not-equal + [@stdlib/blas/ext/base/ndarray/sindex-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sindex-of [@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