From 4921d0080b1312094ad36799bbf1c930ab29ff81 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Mon, 10 Aug 2026 03:05:37 +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/base/README.md | 12 ++++++++++++ .../@stdlib/blas/ext/base/ndarray/README.md | 15 +++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 2a65b61d1ecf..b92ff4bc7c71 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -46,7 +46,9 @@ var o = ns; - [`capx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/capx]: add a scalar constant to each element in a single-precision complex floating-point strided array. - [`caxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/caxpb]: multiply each element in a single-precision complex floating-point strided array by a scalar constant and add a scalar constant to each result. - [`caxpby( N, alpha, x, strideX, beta, y, strideY )`][@stdlib/blas/ext/base/caxpby]: multiply a single-precision complex floating-point strided array `x` by a constant and add the result to a single-precision complex floating-point strided array `y` multiplied by a constant. +- [`ccopyWithin( N, target, start, end, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/ccopy-within]: perform an in-place copy of elements within a single-precision complex floating-point strided array. - [`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. +- [`cfillEqual( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/cfill-equal]: replace single-precision complex floating-point strided array elements equal to a provided search element with a specified scalar constant. - [`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. @@ -276,6 +278,7 @@ var o = ns; - [`gsumors( N, x, strideX )`][@stdlib/blas/ext/base/gsumors]: calculate the sum of strided array elements using ordinary recursive summation. - [`gsumpw( N, x, strideX )`][@stdlib/blas/ext/base/gsumpw]: calculate the sum of strided array elements using pairwise summation. - [`gtril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtril]: copy the lower triangular part of a matrix `A` to another matrix `B`. +- [`gtril2triu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtril2triu]: reflect the lower triangular part of a matrix `A` into the upper triangular part of another matrix `B`. - [`gtriu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtriu]: copy the upper triangular part of a matrix `A` to another matrix `B`. - [`gtriu2tril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtriu2tril]: reflect the upper triangular part of a matrix A into the lower triangular part of another matrix B. - [`gunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/gunitspace]: fill a strided array with linearly spaced numeric elements which increment by `1` starting from a specified value. @@ -399,6 +402,7 @@ var o = ns; - [`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. - [`zcartesianProduct( order, M, N, x, strideX, y, strideY, out, LDO )`][@stdlib/blas/ext/base/zcartesian-product]: compute the Cartesian product for two double-precision complex floating-point strided arrays. - [`zcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/zcartesian-square]: compute the Cartesian square for a double-precision complex floating-point strided array. +- [`zcopyWithin( N, target, start, end, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zcopy-within]: perform an in-place copy of elements within a double-precision complex floating-point strided array. - [`zdiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/zdiff]: calculate the k-th discrete forward difference of a double-precision complex floating-point strided array. - [`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]: fill a double-precision complex floating-point strided array with a specified scalar constant. - [`zindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-column]: return the index of the first column in a double-precision complex floating-point input matrix which has the same elements as a provided search vector. @@ -485,8 +489,12 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/caxpby]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/caxpby +[@stdlib/blas/ext/base/ccopy-within]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ccopy-within + [@stdlib/blas/ext/base/cdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cdiff +[@stdlib/blas/ext/base/cfill-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cfill-equal + [@stdlib/blas/ext/base/cfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cfill [@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 @@ -945,6 +953,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/gtril]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gtril +[@stdlib/blas/ext/base/gtril2triu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gtril2triu + [@stdlib/blas/ext/base/gtriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gtriu [@stdlib/blas/ext/base/gtriu2tril]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gtriu2tril @@ -1191,6 +1201,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/zcartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zcartesian-square +[@stdlib/blas/ext/base/zcopy-within]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zcopy-within + [@stdlib/blas/ext/base/zdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zdiff [@stdlib/blas/ext/base/zfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zfill 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 b37013d47cca..dba2f02863f3 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -52,6 +52,7 @@ The namespace exposes the following APIs: - [`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. - [`csum( arrays )`][@stdlib/blas/ext/base/ndarray/csum]: compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray. - [`csumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/csumkbn]: compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm. +- [`ctriu( arrays )`][@stdlib/blas/ext/base/ndarray/ctriu]: copy the upper triangular part of a single-precision complex floating-point matrix `A` to another matrix `B`. - [`cunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/cunitspace]: fill a one-dimensional single-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. - [`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. - [`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. @@ -96,6 +97,7 @@ The namespace exposes the following APIs: - [`dsumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/dsumkbn2]: compute the sum of all elements in a one-dimensional double-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm. - [`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. +- [`dtriu( arrays )`][@stdlib/blas/ext/base/ndarray/dtriu]: copy the upper triangular part of a double-precision floating-point matrix `A` to another matrix `B`. - [`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. - [`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. - [`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. @@ -142,6 +144,7 @@ The namespace exposes the following APIs: - [`gsumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/gsumkbn2]: compute the sum of all elements in a one-dimensional ndarray using a second-order iterative Kahan–Babuška algorithm. - [`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. +- [`gtriu( arrays )`][@stdlib/blas/ext/base/ndarray/gtriu]: copy the upper triangular part of a matrix `A` to another matrix `B`. - [`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. - [`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. - [`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. @@ -180,6 +183,7 @@ The namespace exposes the following APIs: - [`ssumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/ssumkbn2]: compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm. - [`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. +- [`striu( arrays )`][@stdlib/blas/ext/base/ndarray/striu]: copy the upper triangular part of a single-precision floating-point matrix `A` to another matrix `B`. - [`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. - [`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. - [`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. @@ -195,6 +199,7 @@ The namespace exposes the following APIs: - [`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. - [`zsum( arrays )`][@stdlib/blas/ext/base/ndarray/zsum]: compute the sum of all elements in a one-dimensional double-precision complex floating-point ndarray. - [`zsumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/zsumkbn]: compute the sum of all elements in a one-dimensional double-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm. +- [`ztriu( arrays )`][@stdlib/blas/ext/base/ndarray/ztriu]: copy the upper triangular part of a double-precision complex floating-point matrix `A` to another matrix `B`. - [`zunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/zunitspace]: fill a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value. - [`zwxsa( arrays )`][@stdlib/blas/ext/base/ndarray/zwxsa]: subtract a scalar constant from each element in an input one-dimensional double-precision complex floating-point ndarray and assign the results to elements in a one-dimensional double-precision complex floating-point output ndarray. - [`zxdy( arrays )`][@stdlib/blas/ext/base/ndarray/zxdy]: divide elements of a one-dimensional double-precision complex floating-point ndarray by the corresponding elements of a second one-dimensional double-precision complex floating-point ndarray and assign the results to the second ndarray. @@ -259,6 +264,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/csumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/csumkbn +[@stdlib/blas/ext/base/ndarray/ctriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ctriu + [@stdlib/blas/ext/base/ndarray/cunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cunitspace [@stdlib/blas/ext/base/ndarray/cwxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cwxsa @@ -347,6 +354,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/dsumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsumpw +[@stdlib/blas/ext/base/ndarray/dtriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dtriu + [@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/dwxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dwxsa @@ -439,6 +448,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/gsumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gsumpw +[@stdlib/blas/ext/base/ndarray/gtriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gtriu + [@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/gwxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gwxsa @@ -515,6 +526,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/ssumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ssumpw +[@stdlib/blas/ext/base/ndarray/striu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/striu + [@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/swxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/swxsa @@ -545,6 +558,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/zsumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zsumkbn +[@stdlib/blas/ext/base/ndarray/ztriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ztriu + [@stdlib/blas/ext/base/ndarray/zunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zunitspace [@stdlib/blas/ext/base/ndarray/zwxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zwxsa