Skip to content

docs: update namespace table of contents #15482

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
Sep 24, 2026
Merged

docs: update namespace table of contents #15482

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
24 changes: 24 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 @@ -121,6 +121,7 @@ The namespace exposes the following APIs:
- <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">[`dtriu2tril( arrays )`][@stdlib/blas/ext/base/ndarray/dtriu2tril]</span><span class="delimiter">: </span><span class="description">reflect the upper triangular part of a double-precision floating-point matrix `A` into the lower triangular part of 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">[`dvander( arrays )`][@stdlib/blas/ext/base/ndarray/dvander]</span><span class="delimiter">: </span><span class="description">generate a double-precision floating-point Vandermonde matrix.</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>
- <span class="signature">[`dxdy( arrays )`][@stdlib/blas/ext/base/ndarray/dxdy]</span><span class="delimiter">: </span><span class="description">divide elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assign the results to the second ndarray.</span>
- <span class="signature">[`dxmy( arrays )`][@stdlib/blas/ext/base/ndarray/dxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assign the results to the second ndarray.</span>
Expand All @@ -143,6 +144,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`gcusumpw( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumpw]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray using pairwise summation.</span>
- <span class="signature">[`gdiff( arrays )`][@stdlib/blas/ext/base/ndarray/gdiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a one-dimensional ndarray.</span>
- <span class="signature">[`gfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional ndarray equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`gfillGreaterThanEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-greater-than-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional ndarray greater than or equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`gfillNaN( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-nan]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional ndarray equal to `NaN` with a specified scalar constant.</span>
- <span class="signature">[`gfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional ndarray not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`gfindIndex( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfind-index]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional ndarray which passes a test implemented by a predicate function.</span>
Expand All @@ -162,6 +164,8 @@ The namespace exposes the following APIs:
- <span class="signature">[`glastIndexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/glast-index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the last falsy element in a one-dimensional ndarray.</span>
- <span class="signature">[`glastIndexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/glast-index-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the last truthy element in a one-dimensional ndarray.</span>
- <span class="signature">[`glastIndexOf( arrays )`][@stdlib/blas/ext/base/ndarray/glast-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a search element in a one-dimensional ndarray.</span>
- <span class="signature">[`gleftPadCircular( arrays )`][@stdlib/blas/ext/base/ndarray/gleft-pad-circular]</span><span class="delimiter">: </span><span class="description">prepend elements to a one-dimensional input ndarray by circularly repeating existing elements and write the results to a one-dimensional output ndarray.</span>
- <span class="signature">[`gleftPadEdge( arrays )`][@stdlib/blas/ext/base/ndarray/gleft-pad-edge]</span><span class="delimiter">: </span><span class="description">prepend elements to a one-dimensional input ndarray by repeating the leading edge element and write the results to a one-dimensional output ndarray.</span>
- <span class="signature">[`glinspace( arrays )`][@stdlib/blas/ext/base/ndarray/glinspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with linearly spaced values over a specified interval.</span>
- <span class="signature">[`glogspace( arrays )`][@stdlib/blas/ext/base/ndarray/glogspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with logarithmically spaced values over a specified interval.</span>
- <span class="signature">[`gnansum( arrays )`][@stdlib/blas/ext/base/ndarray/gnansum]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional ndarray, ignoring `NaN` values.</span>
Expand All @@ -171,6 +175,8 @@ The namespace exposes the following APIs:
- <span class="signature">[`gnansumpw( arrays )`][@stdlib/blas/ext/base/ndarray/gnansumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional ndarray, ignoring `NaN` values and using pairwise summation.</span>
- <span class="signature">[`gnone( arrays )`][@stdlib/blas/ext/base/ndarray/gnone]</span><span class="delimiter">: </span><span class="description">test whether every element in a one-dimensional ndarray is falsy.</span>
- <span class="signature">[`goneTo( arrays )`][@stdlib/blas/ext/base/ndarray/gone-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`grightPadCircular( arrays )`][@stdlib/blas/ext/base/ndarray/gright-pad-circular]</span><span class="delimiter">: </span><span class="description">append elements to a one-dimensional input ndarray by circularly repeating existing elements and write the results to a one-dimensional output ndarray.</span>
- <span class="signature">[`grightPadEdge( arrays )`][@stdlib/blas/ext/base/ndarray/gright-pad-edge]</span><span class="delimiter">: </span><span class="description">append elements to a one-dimensional input ndarray by repeating the trailing edge element and write the results to a one-dimensional output ndarray.</span>
- <span class="signature">[`gsome( arrays )`][@stdlib/blas/ext/base/ndarray/gsome]</span><span class="delimiter">: </span><span class="description">test whether a one-dimensional ndarray contains at least `k` truthy elements.</span>
- <span class="signature">[`gsort( arrays )`][@stdlib/blas/ext/base/ndarray/gsort]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional ndarray.</span>
- <span class="signature">[`gsorthp( arrays )`][@stdlib/blas/ext/base/ndarray/gsorthp]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional ndarray using heapsort.</span>
Expand All @@ -184,6 +190,8 @@ The namespace exposes the following APIs:
- <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">[`gtriu2tril( arrays )`][@stdlib/blas/ext/base/ndarray/gtriu2tril]</span><span class="delimiter">: </span><span class="description">reflect the upper triangular part of a matrix `A` into the lower triangular part of 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">[`gvander( arrays )`][@stdlib/blas/ext/base/ndarray/gvander]</span><span class="delimiter">: </span><span class="description">generate a Vandermonde matrix.</span>
- <span class="signature">[`gwhere( arrays )`][@stdlib/blas/ext/base/ndarray/gwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two one-dimensional ndarrays depending on a condition.</span>
- <span class="signature">[`gwxpy( arrays )`][@stdlib/blas/ext/base/ndarray/gwxpy]</span><span class="delimiter">: </span><span class="description">add elements of a one-dimensional ndarray to the corresponding elements of a second one-dimensional ndarray and assign the results to elements in a third one-dimensional ndarray.</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>
- <span class="signature">[`gxdy( arrays )`][@stdlib/blas/ext/base/ndarray/gxdy]</span><span class="delimiter">: </span><span class="description">divide elements of a one-dimensional ndarray by the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray.</span>
Expand Down Expand Up @@ -462,6 +470,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

[@stdlib/blas/ext/base/ndarray/gfill-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfill-not-equal
Expand Down Expand Up @@ -544,6 +556,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

[@stdlib/blas/ext/base/ndarray/glogspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/glogspace
Expand All @@ -562,6 +578,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

[@stdlib/blas/ext/base/ndarray/gsort]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gsort
Expand All @@ -588,6 +608,10 @@ console.log( objectKeys( ns ) );

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

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

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

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

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