Skip to content

docs: update namespace table of contents #14117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Aug 10, 2026
+27 −0
Merged

docs: update namespace table of contents #14117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ var o = ns;
- <span class="signature">[`capx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/capx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a single-precision complex floating-point strided array.</span>
- <span class="signature">[`caxpb( N, alpha, beta, x, strideX )`][@stdlib/blas/ext/base/caxpb]</span><span class="delimiter">: </span><span class="description">multiply each element in a single-precision complex floating-point strided array by a scalar constant and add a scalar constant to each result.</span>
- <span class="signature">[`caxpby( N, alpha, x, strideX, beta, y, strideY )`][@stdlib/blas/ext/base/caxpby]</span><span class="delimiter">: </span><span class="description">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.</span>
- <span class="signature">[`ccopyWithin( N, target, start, end, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/ccopy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within a single-precision complex floating-point strided array.</span>
- <span class="signature">[`cdiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/cdiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a single-precision complex floating-point strided array.</span>
- <span class="signature">[`cfillEqual( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/cfill-equal]</span><span class="delimiter">: </span><span class="description">replace single-precision complex floating-point strided array elements equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`cfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/cfill]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with a specified scalar constant.</span>
- <span class="signature">[`cindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-column]</span><span class="delimiter">: </span><span class="description">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.</span>
- <span class="signature">[`cindexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/cindex-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element in a single-precision complex floating-point strided array.</span>
Expand Down Expand Up @@ -276,6 +278,7 @@ var o = ns;
- <span class="signature">[`gsumors( N, x, strideX )`][@stdlib/blas/ext/base/gsumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using ordinary recursive summation.</span>
- <span class="signature">[`gsumpw( N, x, strideX )`][@stdlib/blas/ext/base/gsumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using pairwise summation.</span>
- <span class="signature">[`gtril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a matrix `A` to another matrix `B`.</span>
- <span class="signature">[`gtril2triu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtril2triu]</span><span class="delimiter">: </span><span class="description">reflect the lower triangular part of a matrix `A` into the upper triangular part of another matrix `B`.</span>
- <span class="signature">[`gtriu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a matrix `A` to another matrix `B`.</span>
- <span class="signature">[`gtriu2tril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtriu2tril]</span><span class="delimiter">: </span><span class="description">reflect the upper triangular part of a matrix A into the lower triangular part of another matrix B.</span>
- <span class="signature">[`gunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/gunitspace]</span><span class="delimiter">: </span><span class="description">fill a strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
Expand Down Expand Up @@ -399,6 +402,7 @@ var o = ns;
- <span class="signature">[`zaxpby( N, alpha, x, strideX, beta, y, strideY )`][@stdlib/blas/ext/base/zaxpby]</span><span class="delimiter">: </span><span class="description">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.</span>
- <span class="signature">[`zcartesianProduct( order, M, N, x, strideX, y, strideY, out, LDO )`][@stdlib/blas/ext/base/zcartesian-product]</span><span class="delimiter">: </span><span class="description">compute the Cartesian product for two double-precision complex floating-point strided arrays.</span>
- <span class="signature">[`zcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/zcartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a double-precision complex floating-point strided array.</span>
- <span class="signature">[`zcopyWithin( N, target, start, end, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zcopy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within a double-precision complex floating-point strided array.</span>
- <span class="signature">[`zdiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/zdiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a double-precision complex floating-point strided array.</span>
- <span class="signature">[`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with a specified scalar constant.</span>
- <span class="signature">[`zindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-column]</span><span class="delimiter">: </span><span class="description">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.</span>
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading