From 3becfb56530def7f376ecb032315a887e5117c1f Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Tue, 7 Jul 2026 03:26:56 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/blas/base/ndarray/README.md | 3 +++ .../@stdlib/blas/ext/base/README.md | 27 +++++++++++++++++++ .../@stdlib/blas/ext/base/ndarray/README.md | 9 +++++++ 3 files changed, 39 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/README.md index 2e90981de895..f2a348afb42b 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/README.md @@ -47,6 +47,7 @@ The namespace exposes the following APIs: - [`caxpy( arrays )`][@stdlib/blas/base/ndarray/caxpy]: multiply a one-dimensional single-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision complex floating-point ndarray `y`. - [`ccopy( arrays )`][@stdlib/blas/base/ndarray/ccopy]: copy values from a one-dimensional single-precision complex floating-point ndarray `x` into a one-dimensional single-precision complex floating-point ndarray `y`. +- [`cgemv( arrays )`][@stdlib/blas/base/ndarray/cgemv]: perform one of the matrix-vector operations `y = alpha*A*x + beta*y`, `y = alpha*A^T*x + beta*y`, or `y = alpha*A^H*x + beta*y`. - [`cscal( arrays )`][@stdlib/blas/base/ndarray/cscal]: multiply a one-dimensional single-precision complex floating-point ndarray by a scalar constant. - [`csscal( arrays )`][@stdlib/blas/base/ndarray/csscal]: multiply a one-dimensional single-precision complex floating-point ndarray by a single-precision floating-point scalar constant. - [`cswap( arrays )`][@stdlib/blas/base/ndarray/cswap]: interchange two one-dimensional single-precision complex floating-point ndarrays. @@ -131,6 +132,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/base/ndarray/ccopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/ccopy +[@stdlib/blas/base/ndarray/cgemv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/cgemv + [@stdlib/blas/base/ndarray/cscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/cscal [@stdlib/blas/base/ndarray/csscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/csscal diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 59159ea30f9d..0e08b1f3d2e5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -88,6 +88,7 @@ var o = ns; - [`dcusumpw( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusumpw]: calculate the cumulative sum of double-precision floating-point strided array elements using pairwise summation. - [`ddiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/ddiff]: calculate the k-th discrete forward difference of a double-precision floating-point strided array. - [`dediff( N, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut )`][@stdlib/blas/ext/base/dediff]: calculate the differences between consecutive elements of a double-precision floating-point strided array. +- [`dfillNaN( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill-nan]: replace double-precision floating-point strided array elements equal to `NaN` 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. - [`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. @@ -185,18 +186,25 @@ var o = ns; - [`gediff( N, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut )`][@stdlib/blas/ext/base/gediff]: calculate the differences between consecutive elements of a strided array. - [`gevery( N, x, strideX )`][@stdlib/blas/ext/base/gevery]: test whether every element in a strided array is truthy. - [`gfillBy( N, x, strideX, clbk[, thisArg] )`][@stdlib/blas/ext/base/gfill-by]: fill a strided array according to a provided callback function. +- [`gfillEqual( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/gfill-equal]: replace strided array elements equal to a provided search element with a specified scalar constant. - [`gfillNaN( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gfill-nan]: replace strided array elements equal to `NaN` with a specified scalar constant. - [`gfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gfill]: fill a strided array with a specified scalar constant. - [`gfindIndex( N, x, strideX, clbk[, thisArg] )`][@stdlib/blas/ext/base/gfind-index]: return the index of the first element which passes a test implemented by a predicate function. - [`gfindLastIndex( N, x, strideX, clbk[, thisArg] )`][@stdlib/blas/ext/base/gfind-last-index]: return the index of the last element which passes a test implemented by a predicate function. - [`gfirstIndexEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-equal]: return the index of the first element in a strided array equal to a corresponding element in another strided array. +- [`gfirstIndexGreaterThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-greater-than]: return the index of the first element in a strided array which is greater than a corresponding element in another strided array. +- [`gfirstIndexLessThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-less-than]: return the index of the first element in a strided array which is less than a corresponding element in another strided array. +- [`gfirstIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-not-equal]: return the index of the first element in a strided array which is not equal to the corresponding element in another strided array. - [`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. - [`gindexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/gindex-of-falsy]: return the index of the first falsy element in a strided array. +- [`gindexOfNotEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-not-equal]: return the first index of an element in a strided array which is not equal to a specified search element. - [`gindexOfRow( order, M, N, A, LDA, x, strideX )`][@stdlib/blas/ext/base/gindex-of-row]: return the index of the first row in an input matrix which has the same elements as a provided search vector. +- [`gindexOfSameValue( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-same-value]: return the index of the first element in a strided array which has the same value as a provided search element. - [`gindexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/gindex-of-truthy]: return the index of the first truthy element in a strided array. - [`gindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of]: return the first index of a specified search element in a strided array. - [`gjoinBetween( N, prefix, suffix, x, strideX, separators, strideS )`][@stdlib/blas/ext/base/gjoin-between]: return a string by joining strided array elements using a specified separator for each pair of consecutive elements. - [`gjoin( N, separator, x, strideX )`][@stdlib/blas/ext/base/gjoin]: return a string created by joining strided array elements using a specified separator. +- [`glastIndexEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-equal]: return the index of the last element in a strided array equal to a corresponding element in another strided array. - [`glastIndexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/glast-index-of-falsy]: return the index of the last falsy element in a strided array. - [`glastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/glast-index-of-row]: return the index of the last row in an input matrix which has the same elements as a provided search vector. - [`glastIndexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/glast-index-of-truthy]: return the index of the last truthy element in a strided array. @@ -277,6 +285,7 @@ var o = ns; - [`sdssum( N, x, strideX )`][@stdlib/blas/ext/base/sdssum]: calculate the sum of single-precision floating-point strided array elements using extended accumulation. - [`sdssumpw( N, x, strideX )`][@stdlib/blas/ext/base/sdssumpw]: calculate the sum of single-precision floating-point strided array elements using pairwise summation with extended accumulation. - [`sediff( N, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut )`][@stdlib/blas/ext/base/sediff]: calculate the differences between consecutive elements of a single-precision floating-point strided array. +- [`sfillNaN( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sfill-nan]: replace single-precision floating-point strided array elements equal to `NaN` with a specified scalar constant. - [`sfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sfill]: fill a single-precision floating-point strided array with a specified scalar constant. - [`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. @@ -487,6 +496,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/dediff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dediff +[@stdlib/blas/ext/base/dfill-nan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dfill-nan + [@stdlib/blas/ext/base/dfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dfill [@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 +692,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/gfill-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfill-by +[@stdlib/blas/ext/base/gfill-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfill-equal + [@stdlib/blas/ext/base/gfill-nan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfill-nan [@stdlib/blas/ext/base/gfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfill @@ -691,12 +704,22 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/gfirst-index-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfirst-index-equal +[@stdlib/blas/ext/base/gfirst-index-greater-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfirst-index-greater-than + +[@stdlib/blas/ext/base/gfirst-index-less-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfirst-index-less-than + +[@stdlib/blas/ext/base/gfirst-index-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfirst-index-not-equal + [@stdlib/blas/ext/base/gindex-of-column]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-column [@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-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-not-equal + [@stdlib/blas/ext/base/gindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-row +[@stdlib/blas/ext/base/gindex-of-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-same-value + [@stdlib/blas/ext/base/gindex-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-truthy [@stdlib/blas/ext/base/gindex-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of @@ -705,6 +728,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/gjoin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gjoin +[@stdlib/blas/ext/base/glast-index-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/glast-index-equal + [@stdlib/blas/ext/base/glast-index-of-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/glast-index-of-falsy [@stdlib/blas/ext/base/glast-index-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/glast-index-of-row @@ -865,6 +890,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/sediff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sediff +[@stdlib/blas/ext/base/sfill-nan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sfill-nan + [@stdlib/blas/ext/base/sfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sfill [@stdlib/blas/ext/base/sindex-of-column]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sindex-of-column 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 66f826a30866..4c1b847509d0 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -85,6 +85,7 @@ The namespace exposes the following APIs: - [`dsumors( arrays )`][@stdlib/blas/ext/base/ndarray/dsumors]: compute the sum of all elements in a one-dimensional double-precision floating-point ndarray using ordinary recursive summation. - [`dsumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dsumpw]: compute the sum of all elements in a one-dimensional double-precision floating-point ndarray using pairwise summation. - [`dunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/dunitspace]: fill a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. +- [`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. - [`dxsa( arrays )`][@stdlib/blas/ext/base/ndarray/dxsa]: subtract a scalar constant from each element in a one-dimensional double-precision floating-point ndarray. - [`dxsy( arrays )`][@stdlib/blas/ext/base/ndarray/dxsy]: subtract the elements of an output one-dimensional double-precision floating-point ndarray from the corresponding elements in an input one-dimensional double-precision floating-point ndarray and assign the results to the output ndarray. @@ -120,6 +121,7 @@ The namespace exposes the following APIs: - [`gsumors( arrays )`][@stdlib/blas/ext/base/ndarray/gsumors]: compute the sum of all elements in a one-dimensional ndarray using ordinary recursive summation. - [`gsumpw( arrays )`][@stdlib/blas/ext/base/ndarray/gsumpw]: compute the sum of all elements in a one-dimensional ndarray using pairwise summation. - [`gunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/gunitspace]: fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. +- [`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. - [`gxsa( arrays )`][@stdlib/blas/ext/base/ndarray/gxsa]: subtract a scalar constant from each element in a one-dimensional ndarray. - [`gxsy( arrays )`][@stdlib/blas/ext/base/ndarray/gxsy]: subtract the elements of an output one-dimensional ndarray from the corresponding elements in an input one-dimensional ndarray and assign the results to the output ndarray. @@ -149,6 +151,7 @@ The namespace exposes the following APIs: - [`ssumors( arrays )`][@stdlib/blas/ext/base/ndarray/ssumors]: compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using ordinary recursive summation. - [`ssumpw( arrays )`][@stdlib/blas/ext/base/ndarray/ssumpw]: compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using pairwise summation. - [`sunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/sunitspace]: fill a one-dimensional single-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. +- [`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. - [`sxsa( arrays )`][@stdlib/blas/ext/base/ndarray/sxsa]: subtract a scalar constant from each element in a one-dimensional single-precision floating-point ndarray. - [`sxsy( arrays )`][@stdlib/blas/ext/base/ndarray/sxsy]: subtract the elements of an output one-dimensional single-precision floating-point ndarray from the corresponding elements in an input one-dimensional single-precision floating-point ndarray and assign the results to the output ndarray. @@ -286,6 +289,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/dunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dunitspace +[@stdlib/blas/ext/base/ndarray/dxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dxmy + [@stdlib/blas/ext/base/ndarray/dxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dxpy [@stdlib/blas/ext/base/ndarray/dxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dxsa @@ -356,6 +361,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/gunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gunitspace +[@stdlib/blas/ext/base/ndarray/gxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gxmy + [@stdlib/blas/ext/base/ndarray/gxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gxpy [@stdlib/blas/ext/base/ndarray/gxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gxsa @@ -414,6 +421,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/sunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sunitspace +[@stdlib/blas/ext/base/ndarray/sxmy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sxmy + [@stdlib/blas/ext/base/ndarray/sxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sxpy [@stdlib/blas/ext/base/ndarray/sxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sxsa