Skip to content

docs: update namespace table of contents #12272

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
May 25, 2026
+9 −0
Merged

docs: update namespace table of contents #12272

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
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/blas/base/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`dnrm2( arrays )`][@stdlib/blas/base/ndarray/dnrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dscal( arrays )`][@stdlib/blas/base/ndarray/dscal]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision floating-point ndarray by a scalar constant.</span>
- <span class="signature">[`dswap( arrays )`][@stdlib/blas/base/ndarray/dswap]</span><span class="delimiter">: </span><span class="description">interchange two one-dimensional double-precision floating-point ndarrays.</span>
- <span class="signature">[`dznrm2( arrays )`][@stdlib/blas/base/ndarray/dznrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`gasum( arrays )`][@stdlib/blas/base/ndarray/gasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional ndarray.</span>
- <span class="signature">[`gaxpy( arrays )`][@stdlib/blas/base/ndarray/gaxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional ndarray `x` by a constant `alpha` and add the result to a one-dimensional ndarray `y`.</span>
- <span class="signature">[`gcopy( arrays )`][@stdlib/blas/base/ndarray/gcopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional ndarray `x` into a one-dimensional ndarray `y`.</span>
Expand All @@ -66,6 +67,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`gswap( arrays )`][@stdlib/blas/base/ndarray/gswap]</span><span class="delimiter">: </span><span class="description">interchange two one-dimensional ndarrays.</span>
- <span class="signature">[`sasum( arrays )`][@stdlib/blas/base/ndarray/sasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`saxpy( arrays )`][@stdlib/blas/base/ndarray/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional single-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision floating-point ndarray `y`.</span>
- <span class="signature">[`scnrm2( arrays )`][@stdlib/blas/base/ndarray/scnrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`scopy( arrays )`][@stdlib/blas/base/ndarray/scopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional single-precision floating-point ndarray `x` into a one-dimensional single-precision floating-point ndarray `y`.</span>
- <span class="signature">[`sdot( arrays )`][@stdlib/blas/base/ndarray/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional single-precision floating-point ndarrays.</span>
- <span class="signature">[`snrm2( arrays )`][@stdlib/blas/base/ndarray/snrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a one-dimensional single-precision floating-point ndarray.</span>
Expand Down Expand Up @@ -142,6 +144,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/base/ndarray/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/dswap

[@stdlib/blas/base/ndarray/dznrm2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/dznrm2

[@stdlib/blas/base/ndarray/gasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gasum

[@stdlib/blas/base/ndarray/gaxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gaxpy
Expand All @@ -160,6 +164,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/base/ndarray/saxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/saxpy

[@stdlib/blas/base/ndarray/scnrm2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/scnrm2

[@stdlib/blas/base/ndarray/scopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/scopy

[@stdlib/blas/base/ndarray/sdot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/sdot
Expand Down
3 changes: 3 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 @@ -43,6 +43,7 @@ var o = ns;

<div class="namespace-toc">

- <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">[`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">[`cindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-row]</span><span class="delimiter">: </span><span class="description">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.</span>
Expand Down Expand Up @@ -301,6 +302,8 @@ console.log( objectKeys( ns ) );

<!-- <toc-links> -->

[@stdlib/blas/ext/base/capx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/capx

[@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