Skip to content

docs: update namespace table of contents #14319

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 16, 2026
Merged

docs: update namespace table of contents #14319

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
3 changes: 3 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 @@ -95,6 +95,7 @@ The namespace exposes the following APIs:
- <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">[`ssymv( arrays )`][@stdlib/blas/base/ndarray/ssymv]</span><span class="delimiter">: </span><span class="description">perform the matrix-vector operation `y = alpha*A*x + beta*y` for a symmetric matrix `A`.</span>
- <span class="signature">[`ssyr( arrays )`][@stdlib/blas/base/ndarray/ssyr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = alpha*x*x^T + A`.</span>
- <span class="signature">[`ssyr2( arrays )`][@stdlib/blas/base/ndarray/ssyr2]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 2 operation `A = alpha*x*y^T + alpha*y*x^T + A`.</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>
Expand Down Expand Up @@ -244,6 +245,8 @@ console.log( objectKeys( ns ) );

[@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/ssymv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/ssymv

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

[@stdlib/blas/base/ndarray/ssyr2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/ssyr2
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ The namespace contains the following:

- <span class="signature">[`base`][@stdlib/blas/ext/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) extensions to basic linear algebra subprograms (BLAS).</span>
- <span class="signature">[`circshift( x, k[, options] )`][@stdlib/blas/ext/circshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of an input ndarray by a specified number of positions along one or more ndarray dimensions.</span>
- <span class="signature">[`copyWithin( x, target, start[, end][, options] )`][@stdlib/blas/ext/copy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within an ndarray along an ndarray dimension.</span>
- <span class="signature">[`cusum( x[, initial][, options] )`][@stdlib/blas/ext/cusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum along one or more ndarray dimensions.</span>
- <span class="signature">[`findIndex( x[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-index]</span><span class="delimiter">: </span><span class="description">return the index of the first element along an ndarray dimension which passes a test implemented by a predicate function.</span>
- <span class="signature">[`findLastIndex( x[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-last-index]</span><span class="delimiter">: </span><span class="description">return the index of the last element along an ndarray dimension which passes a test implemented by a predicate function.</span>
Expand Down Expand Up @@ -108,6 +109,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/find-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/find-index
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 @@ -51,6 +51,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`cfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/cfill-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional single-precision complex floating-point ndarray equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`cindexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/cindex-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element in a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`cindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/cindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a search element in a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`clogspace( arrays )`][@stdlib/blas/ext/base/ndarray/clogspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision complex floating-point ndarray with logarithmically spaced values over a specified interval.</span>
- <span class="signature">[`coneTo( arrays )`][@stdlib/blas/ext/base/ndarray/cone-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`csum( arrays )`][@stdlib/blas/ext/base/ndarray/csum]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`csumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/csumkbn]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
Expand Down Expand Up @@ -221,6 +222,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`zcopyWithin( arrays )`][@stdlib/blas/ext/base/ndarray/zcopy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zindexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/zindex-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element in a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/zindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a search element in a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zlogspace( arrays )`][@stdlib/blas/ext/base/ndarray/zlogspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision complex floating-point ndarray with logarithmically spaced values over a specified interval.</span>
- <span class="signature">[`zoneTo( arrays )`][@stdlib/blas/ext/base/ndarray/zone-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`zsum( arrays )`][@stdlib/blas/ext/base/ndarray/zsum]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zsumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/zsumkbn]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
Expand Down Expand Up @@ -288,6 +290,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

[@stdlib/blas/ext/base/ndarray/zsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zsum
Expand Down
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/stats/base/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,11 @@ The namespace exposes the following APIs:
- <span class="signature">[`dstdevwd( arrays )`][@stdlib/stats/base/ndarray/dstdevwd]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using Welford's algorithm.</span>
- <span class="signature">[`dstdevyc( arrays )`][@stdlib/stats/base/ndarray/dstdevyc]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer.</span>
- <span class="signature">[`dvariance( arrays )`][@stdlib/stats/base/ndarray/dvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dvariancech( arrays )`][@stdlib/stats/base/ndarray/dvariancech]</span><span class="delimiter">: </span><span class="description">calculate the variance of a one-dimensional double-precision floating-point ndarray using a one-pass trial mean algorithm.</span>
- <span class="signature">[`dvariancepn( arrays )`][@stdlib/stats/base/ndarray/dvariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a one-dimensional double-precision floating-point ndarray using a two-pass algorithm.</span>
- <span class="signature">[`dvariancetk( arrays )`][@stdlib/stats/base/ndarray/dvariancetk]</span><span class="delimiter">: </span><span class="description">calculate the variance of a one-dimensional double-precision floating-point ndarray using a one-pass textbook algorithm.</span>
- <span class="signature">[`dvariancewd( arrays )`][@stdlib/stats/base/ndarray/dvariancewd]</span><span class="delimiter">: </span><span class="description">calculate the variance of a one-dimensional double-precision floating-point ndarray using Welford's algorithm.</span>
- <span class="signature">[`dvarianceyc( arrays )`][@stdlib/stats/base/ndarray/dvarianceyc]</span><span class="delimiter">: </span><span class="description">calculate the variance of a one-dimensional double-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer.</span>
- <span class="signature">[`dztest( arrays )`][@stdlib/stats/base/ndarray/dztest]</span><span class="delimiter">: </span><span class="description">compute a one-sample Z-test for a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dztest2( arrays )`][@stdlib/stats/base/ndarray/dztest2]</span><span class="delimiter">: </span><span class="description">compute a two-sample Z-test for two one-dimensional double-precision floating-point ndarrays.</span>
- <span class="signature">[`maxBy( arrays, clbk[, thisArg ] )`][@stdlib/stats/base/ndarray/max-by]</span><span class="delimiter">: </span><span class="description">compute the maximum value of a one-dimensional ndarray via a callback function.</span>
Expand Down Expand Up @@ -391,6 +396,16 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

[@stdlib/stats/base/ndarray/dztest2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dztest2
Expand Down