Skip to content

docs: update namespace table of contents #13515

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
Jul 17, 2026
+15 −0
Merged

docs: update namespace table of contents #13515

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 @@ -60,6 +60,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">[`dsdot( arrays )`][@stdlib/blas/base/ndarray/dsdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional single-precision floating-point ndarrays with double-precision accumulation.</span>
- <span class="signature">[`dspr( arrays )`][@stdlib/blas/base/ndarray/dspr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix `A` supplied in packed form.</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">[`dzasum( arrays )`][@stdlib/blas/base/ndarray/dzasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional double-precision complex floating-point ndarray.</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>
Expand All @@ -86,6 +87,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`sger( arrays )`][@stdlib/blas/base/ndarray/sger]</span><span class="delimiter">: </span><span class="description">perform the rank 1 operation `A = alpha*x*y^T + A`.</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>
- <span class="signature">[`sscal( arrays )`][@stdlib/blas/base/ndarray/sscal]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional single-precision floating-point ndarray by a scalar constant.</span>
- <span class="signature">[`sspr( arrays )`][@stdlib/blas/base/ndarray/sspr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix `A` supplied in packed form.</span>
- <span class="signature">[`sswap( arrays )`][@stdlib/blas/base/ndarray/sswap]</span><span class="delimiter">: </span><span class="description">interchange two one-dimensional single-precision floating-point ndarrays.</span>
- <span class="signature">[`zaxpy( arrays )`][@stdlib/blas/base/ndarray/zaxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision complex floating-point ndarray `y`.</span>
- <span class="signature">[`zcopy( arrays )`][@stdlib/blas/base/ndarray/zcopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`.</span>
Expand Down Expand Up @@ -164,6 +166,8 @@ console.log( objectKeys( ns ) );

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

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

[@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/dzasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/dzasum
Expand Down Expand Up @@ -216,6 +220,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/base/ndarray/zaxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/zaxpy
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 @@ -365,6 +365,7 @@ var o = ns;
- <span class="signature">[`zlastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zlast-index-of-row]</span><span class="delimiter">: </span><span class="description">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.</span>
- <span class="signature">[`znancount( N, x, strideX )`][@stdlib/blas/ext/base/znancount]</span><span class="delimiter">: </span><span class="description">calculate the number of non-`NaN` elements in a double-precision complex floating-point strided array.</span>
- <span class="signature">[`zoneTo( N, x, strideX )`][@stdlib/blas/ext/base/zone-to]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`zreplicate( N, k, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/zreplicate]</span><span class="delimiter">: </span><span class="description">replicate each element in a double-precision complex floating-point strided array a specified number of times.</span>
- <span class="signature">[`zsum( N, x, strideX )`][@stdlib/blas/ext/base/zsum]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements.</span>
- <span class="signature">[`zsumkbn( N, x, strideX )`][@stdlib/blas/ext/base/zsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`zunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/zunitspace]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
Expand Down Expand Up @@ -1071,6 +1072,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/zsumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zsumkbn
Expand Down
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`dcusumors( arrays )`][@stdlib/blas/ext/base/ndarray/dcusumors]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional double-precision floating-point ndarray using ordinary recursive summation.</span>
- <span class="signature">[`dcusumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dcusumpw]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional double-precision floating-point ndarray using pairwise summation.</span>
- <span class="signature">[`ddiff( arrays )`][@stdlib/blas/ext/base/ndarray/ddiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional double-precision floating-point ndarray not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`dindexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/dindex-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element in a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/dindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a search element in a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dlastIndexOf( arrays )`][@stdlib/blas/ext/base/ndarray/dlast-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a search element in a one-dimensional double-precision floating-point ndarray.</span>
Expand Down Expand Up @@ -136,6 +137,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`scusumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/scusumkbn]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`scusumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/scusumkbn2]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="signature">[`scusumors( arrays )`][@stdlib/blas/ext/base/ndarray/scusumors]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation.</span>
- <span class="signature">[`sfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional single-precision floating-point ndarray not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`sindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/sindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a search element in a one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`slastIndexOf( arrays )`][@stdlib/blas/ext/base/ndarray/slast-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a search element in a one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`slinspace( arrays )`][@stdlib/blas/ext/base/ndarray/slinspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision floating-point ndarray with linearly spaced values over a specified interval.</span>
Expand Down Expand Up @@ -254,6 +256,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/ndarray/dindex-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dindex-of
Expand Down Expand Up @@ -394,6 +398,8 @@ console.log( objectKeys( ns ) );

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

[@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]: 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
Expand Down