Skip to content

docs: update namespace table of contents #15584

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

docs: update namespace table of contents #15584

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
24 changes: 24 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 @@ -48,11 +48,19 @@ The namespace contains the following:
- <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">[`copyWithin( x, target, start[, end][, options] )`][@stdlib/blas/ext/copy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within an ndarray along an ndarray dimension.</span>
- <span class="signature">[`cuany( x[, options] )`][@stdlib/blas/ext/cuany]</span><span class="delimiter">: </span><span class="description">cumulatively test whether at least one element along one or more ndarray dimensions is truthy.</span>
- <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">[`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>
- <span class="signature">[`indexOfNotEqual( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/index-of-not-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element which is not equal to a specified search element along an ndarray dimension.</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">[`lastIndexOfFalsy( x[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the last falsy element along an ndarray dimension.</span>
- <span class="signature">[`lastIndexOfTruthy( x[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the last truthy element along an ndarray dimension.</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">[`logspace( shape, base, start, stop[, endpoint][, options] )`][@stdlib/blas/ext/logspace]</span><span class="delimiter">: </span><span class="description">return a new ndarray filled with logarithmically spaced values over a specified interval along one or more ndarray dimensions.</span>
Expand Down Expand Up @@ -112,16 +120,32 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

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

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

[@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/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`ccopyWithin( arrays )`][@stdlib/blas/ext/base/ndarray/ccopy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`cdiff( arrays )`][@stdlib/blas/ext/base/ndarray/cdiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`cfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/cfill-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional single-precision complex floating-point ndarray equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`cfill( arrays )`][@stdlib/blas/ext/base/ndarray/cfill]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision complex floating-point ndarray with a specified scalar constant.</span>
- <span class="signature">[`cindexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/cindex-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element in a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`cindexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/cindex-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element in a one-dimensional single-precision complex floating-point ndarray.</span>
- <span class="signature">[`cindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/cindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a search element in a one-dimensional single-precision complex floating-point ndarray.</span>
Expand Down Expand Up @@ -147,6 +148,7 @@ The namespace exposes the following APIs:
- <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">[`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">[`gfillBy( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfill-by]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray according to a provided callback function.</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">[`gfillGreaterThan( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-greater-than]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional ndarray greater than a provided search element with a specified scalar constant.</span>
Expand Down Expand Up @@ -268,6 +270,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`zaxpby( arrays )`][@stdlib/blas/ext/base/ndarray/zaxpby]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision complex floating-point ndarray by a scalar constant and add the result to a second one-dimensional double-precision complex floating-point ndarray multiplied by a scalar constant.</span>
- <span class="signature">[`zcopyWithin( arrays )`][@stdlib/blas/ext/base/ndarray/zcopy-within]</span><span class="delimiter">: </span><span class="description">perform an in-place copy of elements within a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zdiff( arrays )`][@stdlib/blas/ext/base/ndarray/zdiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zfill( arrays )`][@stdlib/blas/ext/base/ndarray/zfill]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision complex floating-point ndarray with a specified scalar constant.</span>
- <span class="signature">[`zindexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/zindex-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element in a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zindexOfTruthy( arrays )`][@stdlib/blas/ext/base/ndarray/zindex-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element in a one-dimensional double-precision complex floating-point ndarray.</span>
- <span class="signature">[`zindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/zindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a search element in a one-dimensional double-precision complex floating-point ndarray.</span>
Expand Down Expand Up @@ -338,6 +341,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

[@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
Expand Down Expand Up @@ -774,6 +781,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/ndarray/zindex-of-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zindex-of-truthy
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/fft/base/fftpack/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ var o = ns;

<div class="namespace-toc">

- <span class="signature">[`float32`][@stdlib/fft/base/fftpack/ndarray/float32]</span><span class="delimiter">: </span><span class="description">lower-level ndarray wrappers for single-precision floating-point FFTPACK fast Fourier transform routines.</span>
- <span class="signature">[`float64`][@stdlib/fft/base/fftpack/ndarray/float64]</span><span class="delimiter">: </span><span class="description">lower-level ndarray wrappers for double-precision floating-point FFTPACK fast Fourier transform routines.</span>
- <span class="signature">[`generic`][@stdlib/fft/base/fftpack/ndarray/generic]</span><span class="delimiter">: </span><span class="description">lower-level ndarray wrappers for generic FFTPACK fast Fourier transform routines.</span>

Expand Down Expand Up @@ -87,6 +88,8 @@ console.log( objectKeys( ns ) );

<!-- <toc-links> -->

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

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

[@stdlib/fft/base/fftpack/ndarray/generic]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray/generic
Expand Down
7 changes: 7 additions & 0 deletions lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float32/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ var o = ns;

<div class="namespace-toc">

- <span class="signature">[`rfftf( arrays )`][@stdlib/fft/base/fftpack/ndarray/float32/rfftf]</span><span class="delimiter">: </span><span class="description">compute the forward discrete Fourier transform (DFT) of a real-valued one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`rffti( arrays )`][@stdlib/fft/base/fftpack/ndarray/float32/rffti]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a real-valued Fourier transform on a one-dimensional single-precision floating-point ndarray.</span>

</div>

<!-- </toc> -->
Expand Down Expand Up @@ -84,6 +87,10 @@ console.log( objectKeys( ns ) );

<!-- <toc-links> -->

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

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

<!-- </toc-links> -->

</section>
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float64/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ var o = ns;

<div class="namespace-toc">

- <span class="signature">[`rfftf( arrays )`][@stdlib/fft/base/fftpack/ndarray/float64/rfftf]</span><span class="delimiter">: </span><span class="description">compute the forward discrete Fourier transform (DFT) of a real-valued one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`rffti( arrays )`][@stdlib/fft/base/fftpack/ndarray/float64/rffti]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a real-valued Fourier transform on a one-dimensional double-precision floating-point ndarray.</span>

</div>
Expand Down Expand Up @@ -86,6 +87,8 @@ console.log( objectKeys( ns ) );

<!-- <toc-links> -->

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

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

<!-- </toc-links> -->
Expand Down
Loading