Skip to content

docs: update namespace table of contents #11350

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
Apr 10, 2026
+12 −0
Merged

docs: update namespace table of contents #11350

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/ext/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 contains the following:
- <span class="signature">[`sorthp( x[, sortOrder][, options] )`][@stdlib/blas/ext/sorthp]</span><span class="delimiter">: </span><span class="description">sort an input ndarray along one or more ndarray dimensions using heapsort.</span>
- <span class="signature">[`sum( x[, options] )`][@stdlib/blas/ext/sum]</span><span class="delimiter">: </span><span class="description">compute the sum along one or more ndarray dimensions.</span>
- <span class="signature">[`toSortedhp( x[, sortOrder][, options] )`][@stdlib/blas/ext/to-sortedhp]</span><span class="delimiter">: </span><span class="description">return a new ndarray containing the elements of an input ndarray sorted along one or more ndarray dimensions using heapsort.</span>
- <span class="signature">[`zeroTo( shape[, options] )`][@stdlib/blas/ext/zero-to]</span><span class="delimiter">: </span><span class="description">return a new ndarray filled with linearly spaced numeric elements which increment by `1` starting from zero along one or more ndarray dimensions.</span>

</div>

Expand Down Expand Up @@ -123,6 +124,8 @@ console.log( objectKeys( ns ) );

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

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

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

</section>
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 @@ -141,6 +141,7 @@ var o = ns;
- <span class="signature">[`gnansumors( N, x, strideX )`][@stdlib/blas/ext/base/gnansumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring `NaN` values and using ordinary recursive summation.</span>
- <span class="signature">[`gnansumpw( N, x, strideX )`][@stdlib/blas/ext/base/gnansumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring `NaN` values and using pairwise summation.</span>
- <span class="signature">[`goneTo( N, x, strideX )`][@stdlib/blas/ext/base/gone-to]</span><span class="delimiter">: </span><span class="description">fill a strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`greplicate( N, k, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/greplicate]</span><span class="delimiter">: </span><span class="description">replicate each strided array element a specified number of times.</span>
- <span class="signature">[`grev( N, x, strideX )`][@stdlib/blas/ext/base/grev]</span><span class="delimiter">: </span><span class="description">reverse a strided array in-place.</span>
- <span class="signature">[`gsort( N, order, x, strideX )`][@stdlib/blas/ext/base/gsort]</span><span class="delimiter">: </span><span class="description">sort a strided array.</span>
- <span class="signature">[`gsort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2hp]</span><span class="delimiter">: </span><span class="description">simultaneously sort two strided arrays based on the sort order of the first array using heapsort.</span>
Expand Down Expand Up @@ -452,6 +453,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/gsort]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gsort
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">[`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>
- <span class="signature">[`czeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/czero-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 zero.</span>
Expand Down Expand Up @@ -120,6 +121,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">[`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">[`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>
- <span class="signature">[`zzeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/zzero-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 zero.</span>
Expand Down Expand Up @@ -165,6 +167,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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