Skip to content

docs: update namespace table of contents #11276

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 3, 2026
+27 −0
Merged

docs: update namespace table of contents #11276

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 @@ -47,6 +47,7 @@ The namespace exposes the following APIs:

- <span class="signature">[`dasum( arrays )`][@stdlib/blas/base/ndarray/dasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`ddot( arrays )`][@stdlib/blas/base/ndarray/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional double-precision floating-point ndarrays.</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">[`gdot( arrays )`][@stdlib/blas/base/ndarray/gdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of 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">[`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>
Expand Down Expand Up @@ -96,6 +97,8 @@ console.log( objectKeys( ns ) );

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

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

[@stdlib/blas/base/ndarray/sasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/sasum
Expand Down
6 changes: 6 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 @@ -46,10 +46,12 @@ The namespace contains the following:
<div class="namespace-toc">

- <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">[`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>
- <span class="signature">[`indexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/index-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element along an ndarray dimension.</span>
- <span class="signature">[`join( x[, options] )`][@stdlib/blas/ext/join]</span><span class="delimiter">: </span><span class="description">return an ndarray created by joining elements using a separator along one or more ndarray dimensions.</span>
- <span class="signature">[`lastIndexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a specified search element along an ndarray dimension.</span>
- <span class="signature">[`linspace( shape, start, stop[, endpoint][, options] )`][@stdlib/blas/ext/linspace]</span><span class="delimiter">: </span><span class="description">return a new ndarray filled with linearly spaced values over a specified interval along one or more ndarray dimensions.</span>
- <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>
Expand Down Expand Up @@ -99,6 +101,8 @@ console.log( objectKeys( ns ) );

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

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

[@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 All @@ -107,6 +111,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/linspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/linspace
Expand Down
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 @@ -172,6 +172,7 @@ var o = ns;
- <span class="signature">[`sdssum( N, x, strideX )`][@stdlib/blas/ext/base/sdssum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using extended accumulation.</span>
- <span class="signature">[`sdssumpw( N, x, strideX )`][@stdlib/blas/ext/base/sdssumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using pairwise summation with extended accumulation.</span>
- <span class="signature">[`sfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sfill]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with a specified scalar constant.</span>
- <span class="signature">[`sindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/sindex-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in a single-precision floating-point input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`sindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/sindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element in a single-precision floating-point strided array.</span>
- <span class="signature">[`slastIndexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/slast-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a specified search element in a single-precision floating-point strided array.</span>
- <span class="signature">[`slinspace( N, start, stop, endpoint, x, strideX )`][@stdlib/blas/ext/base/slinspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced values over a specified interval.</span>
Expand All @@ -180,6 +181,7 @@ var o = ns;
- <span class="signature">[`snansumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/snansumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="signature">[`snansumors( N, x, strideX )`][@stdlib/blas/ext/base/snansumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.</span>
- <span class="signature">[`snansumpw( N, x, strideX )`][@stdlib/blas/ext/base/snansumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation.</span>
- <span class="signature">[`soneTo( N, x, strideX )`][@stdlib/blas/ext/base/sone-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`srev( N, x, strideX )`][@stdlib/blas/ext/base/srev]</span><span class="delimiter">: </span><span class="description">reverse a single-precision floating-point strided array in-place.</span>
- <span class="signature">[`ssort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/ssort2hp]</span><span class="delimiter">: </span><span class="description">simultaneously sort two single-precision floating-point strided arrays based on the sort order of the first array using heapsort.</span>
- <span class="signature">[`ssort2ins( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/ssort2ins]</span><span class="delimiter">: </span><span class="description">simultaneously sort two single-precision floating-point strided arrays based on the sort order of the first array using insertion sort.</span>
Expand All @@ -197,6 +199,7 @@ var o = ns;
- <span class="signature">[`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with a specified scalar constant.</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">[`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 @@ -505,6 +508,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/slast-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/slast-index-of
Expand All @@ -521,6 +526,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

</section>
Expand Down
Loading