Skip to content

docs: update namespace table of contents #12388

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

docs: update namespace table of contents #12388

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
9 changes: 9 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 @@ -141,6 +141,8 @@ var o = ns;
- <span class="signature">[`gcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/gcartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a strided array.</span>
- <span class="signature">[`gcircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/gcircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a strided array by a specified number of positions.</span>
- <span class="signature">[`gconjoin( N, prefix, suffix, conjunction, oxfordComma, x, strideX )`][@stdlib/blas/ext/base/gconjoin]</span><span class="delimiter">: </span><span class="description">return a string created by joining strided array elements into a human-readable list using a conjunction.</span>
- <span class="signature">[`gcuevery( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/gcuevery]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a strided array is truthy.</span>
- <span class="signature">[`gcunone( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/gcunone]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a strided array is falsy.</span>
- <span class="signature">[`gcusum( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gcusum]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of strided array elements.</span>
- <span class="signature">[`gcusumkbn( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gcusumkbn]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`gcusumkbn2( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gcusumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of strided array elements using a second-order iterative Kahan–Babuška algorithm.</span>
Expand Down Expand Up @@ -260,6 +262,7 @@ var o = ns;
- <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>
- <span class="signature">[`zwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/zwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two double-precision complex floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`zxsa( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a double-precision complex floating-point strided array.</span>
- <span class="signature">[`zzeroTo( N, x, strideX )`][@stdlib/blas/ext/base/zzero-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 zero.</span>

</div>
Expand Down Expand Up @@ -507,6 +510,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

<!-- </toc-links> -->
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 @@ -45,6 +45,7 @@ The namespace exposes the following APIs:

<div class="namespace-toc">

- <span class="signature">[`caxpb( arrays )`][@stdlib/blas/ext/base/ndarray/caxpb]</span><span class="delimiter">: </span><span class="description">multiply each element in a one-dimensional single-precision complex floating-point ndarray by a scalar constant and add a scalar constant to each result.</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">[`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>
Expand Down Expand Up @@ -130,6 +131,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`ssumors( arrays )`][@stdlib/blas/ext/base/ndarray/ssumors]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation.</span>
- <span class="signature">[`ssumpw( arrays )`][@stdlib/blas/ext/base/ndarray/ssumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using pairwise summation.</span>
- <span class="signature">[`sunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/sunitspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`sxsa( arrays )`][@stdlib/blas/ext/base/ndarray/sxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`szeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/szero-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from zero.</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">[`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>
Expand Down Expand Up @@ -179,6 +181,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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