Skip to content

docs: update namespace table of contents #13465

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
Jul 14, 2026
+9 −0
Merged

docs: update namespace table of contents #13465

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/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ var o = ns;
- <span class="signature">[`gevery( N, x, strideX )`][@stdlib/blas/ext/base/gevery]</span><span class="delimiter">: </span><span class="description">test whether every element in a strided array is truthy.</span>
- <span class="signature">[`gfillBy( N, x, strideX, clbk[, thisArg] )`][@stdlib/blas/ext/base/gfill-by]</span><span class="delimiter">: </span><span class="description">fill a strided array according to a provided callback function.</span>
- <span class="signature">[`gfillEqual( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/gfill-equal]</span><span class="delimiter">: </span><span class="description">replace strided array elements equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`gfillLessThan( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/gfill-less-than]</span><span class="delimiter">: </span><span class="description">replace strided array elements less than a provided search element with a specified scalar constant.</span>
- <span class="signature">[`gfillNaN( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gfill-nan]</span><span class="delimiter">: </span><span class="description">replace strided array elements equal to `NaN` with a specified scalar constant.</span>
- <span class="signature">[`gfillNotEqual( N, searchElement, alpha, x, strideX )`][@stdlib/blas/ext/base/gfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace strided array elements not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`gfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gfill]</span><span class="delimiter">: </span><span class="description">fill a strided array with a specified scalar constant.</span>
Expand Down Expand Up @@ -726,6 +727,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/gfill-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfill-not-equal
Expand Down
3 changes: 3 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 @@ -99,6 +99,7 @@ The namespace exposes the following APIs:
- <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>
- <span class="signature">[`gcusumors( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumors]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray using ordinary recursive summation.</span>
- <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">[`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>
- <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">[`gindexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/gindex-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element in a one-dimensional ndarray.</span>
Expand Down Expand Up @@ -319,6 +320,8 @@ console.log( objectKeys( ns ) );

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

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

[@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
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/fft/base/fftpack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ var o = ns;

- <span class="signature">[`cffti( N, workspace, strideW, offsetW )`][@stdlib/fft/base/fftpack/cffti]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a complex-valued Fourier transform.</span>
- <span class="signature">[`cosqi( N, workspace, strideW, offsetW )`][@stdlib/fft/base/fftpack/cosqi]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a quarter-wave cosine transform.</span>
- <span class="signature">[`costi( N, workspace, strideW, offsetW )`][@stdlib/fft/base/fftpack/costi]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a cosine transform.</span>
- <span class="signature">[`decompose( N, M, initial, si, oi, out, so, oo )`][@stdlib/fft/base/fftpack/decompose]</span><span class="delimiter">: </span><span class="description">factorize a sequence length into a product of integers.</span>
- <span class="signature">[`rffti( N, workspace, strideW, offsetW )`][@stdlib/fft/base/fftpack/rffti]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a real-valued Fourier transform.</span>
- <span class="signature">[`sinqi( N, workspace, strideW, offsetW )`][@stdlib/fft/base/fftpack/sinqi]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a quarter-wave sine transform.</span>
Expand Down Expand Up @@ -95,6 +96,8 @@ console.log( objectKeys( ns ) );

[@stdlib/fft/base/fftpack/cosqi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/cosqi

[@stdlib/fft/base/fftpack/costi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/costi

[@stdlib/fft/base/fftpack/decompose]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/decompose

[@stdlib/fft/base/fftpack/rffti]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/rffti
Expand Down
Loading