Skip to content

docs: update namespace table of contents #15675

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

docs: update namespace table of contents #15675

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
4 changes: 2 additions & 2 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 @@ -52,7 +52,7 @@ The namespace contains the following:
- <span class="signature">[`cuevery( x[, options] )`][@stdlib/blas/ext/cuevery]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element along one or more ndarray dimensions is truthy.</span>
- <span class="signature">[`cunone( x[, options] )`][@stdlib/blas/ext/cunone]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element along one or more ndarray dimensions is falsy.</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">[`fillRange( x, value[, start[, end]][, options] )`][@stdlib/blas/ext/fill-range]</span><span class="delimiter">: </span><span class="description">fill an input ndarray with a specified value along an ndarray dimension.</span>
- <span class="signature">[`fillBetween( x, value[, start[, end]][, options] )`][@stdlib/blas/ext/fill-between]</span><span class="delimiter">: </span><span class="description">fill an input ndarray with a specified value along an ndarray dimension.</span>
- <span class="signature">[`findIndex( x[, fromIndex][, 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[, fromIndex][, 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">[`indexOfFalsy( x[, fromIndex][, options] )`][@stdlib/blas/ext/index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element along an ndarray dimension.</span>
Expand Down Expand Up @@ -128,7 +128,7 @@ console.log( objectKeys( ns ) );

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

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

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

Expand Down
15 changes: 9 additions & 6 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 @@ -241,18 +241,19 @@ var o = ns;
- <span class="signature">[`gfirstIndexGreaterThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-greater-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is greater than a corresponding element in another strided array.</span>
- <span class="signature">[`gfirstIndexLessThanEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-less-than-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is less than or equal to a corresponding element in another strided array.</span>
- <span class="signature">[`gfirstIndexLessThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is less than a corresponding element in another strided array.</span>
- <span class="signature">[`gfirstIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-not-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is not equal to the corresponding element in another strided array.</span>
- <span class="signature">[`gindexOfAlmostSameValue( N, searchElement, maxULP, x, strideX )`][@stdlib/blas/ext/base/gindex-of-almost-same-value]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is almost the same value as a provided search element.</span>
- <span class="signature">[`gfirstIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-not-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is not equal to a corresponding element in another strided array.</span>
- <span class="signature">[`gindexOfAlmostSameValue( N, searchElement, maxULP, x, strideX )`][@stdlib/blas/ext/base/gindex-of-almost-same-value]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is almost the same value as a specified search element.</span>
- <span class="signature">[`gindexOfColumn( order, M, N, A, LDA, x, strideX )`][@stdlib/blas/ext/base/gindex-of-column]</span><span class="delimiter">: </span><span class="description">return the index of the first column in an input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`gindexOfFalsyRow( order, M, N, A, LDA )`][@stdlib/blas/ext/base/gindex-of-falsy-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in an input matrix in which all elements are falsy.</span>
- <span class="signature">[`gindexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/gindex-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element in a strided array.</span>
- <span class="signature">[`gindexOfGreaterThanEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is greater than or equal to a specified search element.</span>
- <span class="signature">[`gindexOfGreaterThan( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is greater than a specified search element.</span>
- <span class="signature">[`gindexOfGreaterThanEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is greater than or equal to a specified search element.</span>
- <span class="signature">[`gindexOfGreaterThanSorted( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than-sorted]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a sorted strided array which is greater than a specified search element.</span>
- <span class="signature">[`gindexOfGreaterThan( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is greater than a specified search element.</span>
- <span class="signature">[`gindexOfLessThanEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-less-than-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is less than or equal to a specified search element.</span>
- <span class="signature">[`gindexOfLessThan( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-less-than]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is less than a specified search element.</span>
- <span class="signature">[`gindexOfNotEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-not-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is not equal to a specified search element.</span>
- <span class="signature">[`gindexOfRow( order, M, N, A, LDA, x, strideX )`][@stdlib/blas/ext/base/gindex-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in an input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`gindexOfSameValue( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-same-value]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which has the same value as a provided search element.</span>
- <span class="signature">[`gindexOfSameValue( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-same-value]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which has the same value as a specified search element.</span>
- <span class="signature">[`gindexOfTruthyRow( order, M, N, A, LDA )`][@stdlib/blas/ext/base/gindex-of-truthy-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in an input matrix which contains at least one truthy element.</span>
- <span class="signature">[`gindexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/gindex-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element in a strided array.</span>
- <span class="signature">[`gindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element in a strided array.</span>
Expand All @@ -264,7 +265,7 @@ var o = ns;
- <span class="signature">[`glastIndexGreaterThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-greater-than]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is greater than a corresponding element in another strided array.</span>
- <span class="signature">[`glastIndexLessThanEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-less-than-equal]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is less than or equal to a corresponding element in another strided array.</span>
- <span class="signature">[`glastIndexLessThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is less than a corresponding element in another strided array.</span>
- <span class="signature">[`glastIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-not-equal]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is not equal to the corresponding element in another strided array.</span>
- <span class="signature">[`glastIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-not-equal]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is not equal to a corresponding element in another strided array.</span>
- <span class="signature">[`glastIndexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/glast-index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the last falsy element in a strided array.</span>
- <span class="signature">[`glastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/glast-index-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the last row in an input matrix which has the same elements as a provided search vector.</span>
- <span class="signature">[`glastIndexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/glast-index-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the last truthy element in a strided array.</span>
Expand Down Expand Up @@ -924,6 +925,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/gindex-of-less-than-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-less-than-equal
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 @@ -142,6 +142,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`gcuany( arrays )`][@stdlib/blas/ext/base/ndarray/gcuany]</span><span class="delimiter">: </span><span class="description">cumulatively test whether at least one element in a one-dimensional ndarray is truthy.</span>
- <span class="signature">[`gcuevery( arrays )`][@stdlib/blas/ext/base/ndarray/gcuevery]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a one-dimensional ndarray is truthy.</span>
- <span class="signature">[`gcunone( arrays )`][@stdlib/blas/ext/base/ndarray/gcunone]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a one-dimensional ndarray is falsy.</span>
- <span class="signature">[`gcusome( arrays )`][@stdlib/blas/ext/base/ndarray/gcusome]</span><span class="delimiter">: </span><span class="description">cumulatively test whether at least `k` elements in a one-dimensional ndarray are truthy.</span>
- <span class="signature">[`gcusum( arrays )`][@stdlib/blas/ext/base/ndarray/gcusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray.</span>
- <span class="signature">[`gcusumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumkbn]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`gcusumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumkbn2]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
Expand All @@ -156,6 +157,7 @@ The namespace exposes the following APIs:
- <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">[`gfill( arrays )`][@stdlib/blas/ext/base/ndarray/gfill]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with a specified scalar constant.</span>
- <span class="signature">[`gfindIndexBetween( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfind-index-between]</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 within a specified range.</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>
- <span class="signature">[`gfindLastIndex( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfind-last-index]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a one-dimensional ndarray which passes a test implemented by a predicate function.</span>
- <span class="signature">[`gfirstIndexEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfirst-index-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional ndarray equal to a corresponding element in another one-dimensional ndarray.</span>
Expand Down Expand Up @@ -526,6 +528,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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