Skip to content

docs: update namespace table of contents #14249

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

docs: update namespace table of contents #14249

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
21 changes: 21 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 @@ -54,6 +54,7 @@ The namespace exposes the following APIs:
- <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">[`ctril( arrays )`][@stdlib/blas/ext/base/ndarray/ctril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a single-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`ctriu( arrays )`][@stdlib/blas/ext/base/ndarray/ctriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a single-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`cunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/cunitspace]</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 a specified value.</span>
- <span class="signature">[`cwxsa( arrays )`][@stdlib/blas/ext/base/ndarray/cwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in an input one-dimensional single-precision complex floating-point ndarray and assign the results to elements in a one-dimensional single-precision complex floating-point output ndarray.</span>
Expand Down Expand Up @@ -87,6 +88,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`dlastIndexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/dlast-index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the last falsy 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>
- <span class="signature">[`dlinspace( arrays )`][@stdlib/blas/ext/base/ndarray/dlinspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision floating-point ndarray with linearly spaced values over a specified interval.</span>
- <span class="signature">[`dlogspace( arrays )`][@stdlib/blas/ext/base/ndarray/dlogspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision floating-point ndarray with logarithmically spaced values over a specified interval.</span>
- <span class="signature">[`dnansum( arrays )`][@stdlib/blas/ext/base/ndarray/dnansum]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values.</span>
- <span class="signature">[`dnansumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumkbn]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`dnansumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumkbn2]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.</span>
Expand All @@ -102,6 +104,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`dsumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/dsumkbn2]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="signature">[`dsumors( arrays )`][@stdlib/blas/ext/base/ndarray/dsumors]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision floating-point ndarray using ordinary recursive summation.</span>
- <span class="signature">[`dsumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dsumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision floating-point ndarray using pairwise summation.</span>
- <span class="signature">[`dtril( arrays )`][@stdlib/blas/ext/base/ndarray/dtril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a double-precision floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`dtriu( arrays )`][@stdlib/blas/ext/base/ndarray/dtriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a double-precision floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`dunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/dunitspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`dwxsa( arrays )`][@stdlib/blas/ext/base/ndarray/dwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in an input one-dimensional double-precision floating-point ndarray and assign the results to elements in a one-dimensional double-precision floating-point output ndarray.</span>
Expand Down Expand Up @@ -152,6 +155,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`gsumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/gsumkbn2]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="signature">[`gsumors( arrays )`][@stdlib/blas/ext/base/ndarray/gsumors]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional ndarray using ordinary recursive summation.</span>
- <span class="signature">[`gsumpw( arrays )`][@stdlib/blas/ext/base/ndarray/gsumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional ndarray using pairwise summation.</span>
- <span class="signature">[`gtril( arrays )`][@stdlib/blas/ext/base/ndarray/gtril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a matrix `A` to another matrix `B`.</span>
- <span class="signature">[`gtriu( arrays )`][@stdlib/blas/ext/base/ndarray/gtriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a matrix `A` to another matrix `B`.</span>
- <span class="signature">[`gunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/gunitspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`gwxsa( arrays )`][@stdlib/blas/ext/base/ndarray/gwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in an input one-dimensional ndarray and assign the results to elements in a one-dimensional output ndarray.</span>
Expand Down Expand Up @@ -179,6 +183,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`sindexOfNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sindex-of-not-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a one-dimensional single-precision floating-point ndarray which is not equal to a specified search element.</span>
- <span class="signature">[`sindexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/sindex-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element in a one-dimensional single-precision floating-point ndarray.</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">[`slastIndexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/slast-index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the last falsy 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>
- <span class="signature">[`snansum( arrays )`][@stdlib/blas/ext/base/ndarray/snansum]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values.</span>
Expand All @@ -194,6 +199,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`ssumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/ssumkbn2]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="signature">[`ssumors( arrays )`][@stdlib/blas/ext/base/ndarray/ssumors]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in 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">[`stril( arrays )`][@stdlib/blas/ext/base/ndarray/stril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a single-precision floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`striu( arrays )`][@stdlib/blas/ext/base/ndarray/striu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a single-precision floating-point matrix `A` to another matrix `B`.</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">[`swxsa( arrays )`][@stdlib/blas/ext/base/ndarray/swxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in an input one-dimensional single-precision floating-point ndarray and assign the results to elements in a one-dimensional single-precision floating-point output ndarray.</span>
Expand All @@ -211,6 +217,7 @@ The namespace exposes the following APIs:
- <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">[`ztril( arrays )`][@stdlib/blas/ext/base/ndarray/ztril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a double-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`ztriu( arrays )`][@stdlib/blas/ext/base/ndarray/ztriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a double-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`zunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/zunitspace]</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 a specified value.</span>
- <span class="signature">[`zwxsa( arrays )`][@stdlib/blas/ext/base/ndarray/zwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in an input one-dimensional double-precision complex floating-point ndarray and assign the results to elements in a one-dimensional double-precision complex floating-point output ndarray.</span>
Expand Down Expand Up @@ -280,6 +287,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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