Skip to content

docs: update namespace table of contents #15554

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 26, 2026
+24 −0
Merged

docs: update namespace table of contents #15554

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
18 changes: 18 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 @@ -85,8 +85,10 @@ The namespace exposes the following APIs:
- <span class="signature">[`dcusumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dcusumpw]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional double-precision floating-point ndarray using pairwise summation.</span>
- <span class="signature">[`ddiff( arrays )`][@stdlib/blas/ext/base/ndarray/ddiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional double-precision floating-point ndarray equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`dfillLessThan( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-less-than]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional double-precision floating-point ndarray less than a provided search element with a specified scalar constant.</span>
- <span class="signature">[`dfillNaN( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-nan]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional double-precision floating-point ndarray equal to `NaN` with a specified scalar constant.</span>
- <span class="signature">[`dfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional double-precision floating-point ndarray not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`dfill( arrays )`][@stdlib/blas/ext/base/ndarray/dfill]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision floating-point ndarray with a specified scalar constant.</span>
- <span class="signature">[`dfirstIndexEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dfirst-index-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional double-precision floating-point ndarray equal to a corresponding element in another one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dfirstIndexGreaterThan( arrays )`][@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional double-precision floating-point ndarray which is greater than a corresponding element in another one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dfirstIndexLessThan( arrays )`][@stdlib/blas/ext/base/ndarray/dfirst-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional double-precision floating-point ndarray which is less than a corresponding element in another one-dimensional double-precision floating-point ndarray.</span>
Expand Down Expand Up @@ -147,8 +149,10 @@ The namespace exposes the following APIs:
- <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">[`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>
- <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">[`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 @@ -218,6 +222,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`sfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sfill-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional single-precision floating-point ndarray equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`sfillNaN( arrays )`][@stdlib/blas/ext/base/ndarray/sfill-nan]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional single-precision floating-point ndarray equal to `NaN` with a specified scalar constant.</span>
- <span class="signature">[`sfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional single-precision floating-point ndarray not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`sfill( arrays )`][@stdlib/blas/ext/base/ndarray/sfill]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision floating-point ndarray with a specified scalar constant.</span>
- <span class="signature">[`sfirstIndexEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sfirst-index-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional single-precision floating-point ndarray equal to a corresponding element in another one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`sfirstIndexLessThan( arrays )`][@stdlib/blas/ext/base/ndarray/sfirst-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional single-precision floating-point ndarray which is less than a corresponding element in another one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`sindexOfFalsy( arrays )`][@stdlib/blas/ext/base/ndarray/sindex-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element in a one-dimensional single-precision floating-point ndarray.</span>
Expand Down Expand Up @@ -250,6 +255,7 @@ The namespace exposes the following APIs:
- <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">[`striu2tril( arrays )`][@stdlib/blas/ext/base/ndarray/striu2tril]</span><span class="delimiter">: </span><span class="description">reflect the upper triangular part of a single-precision floating-point matrix `A` into the lower triangular part of 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">[`svander( arrays )`][@stdlib/blas/ext/base/ndarray/svander]</span><span class="delimiter">: </span><span class="description">generate a single-precision floating-point Vandermonde matrix.</span>
- <span class="signature">[`swhere( arrays )`][@stdlib/blas/ext/base/ndarray/swhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two one-dimensional single-precision floating-point ndarrays depending on a condition.</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>
- <span class="signature">[`sxdy( arrays )`][@stdlib/blas/ext/base/ndarray/sxdy]</span><span class="delimiter">: </span><span class="description">divide elements of a one-dimensional single-precision floating-point ndarray by the corresponding elements of a second one-dimensional single-precision floating-point ndarray and assign the results to the second ndarray.</span>
Expand Down Expand Up @@ -402,10 +408,14 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

[@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dfirst-index-greater-than
Expand Down Expand Up @@ -526,10 +536,14 @@ console.log( objectKeys( ns ) );

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

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

[@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]: 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 Expand Up @@ -668,6 +682,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

[@stdlib/blas/ext/base/ndarray/swxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/swxsa
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/fft/base/fftpack/float32/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ var o = ns;
<div class="namespace-toc">

- <span class="signature">[`decompose( N, M, initial, si, oi, out, so, oo )`][@stdlib/fft/base/fftpack/float32/decompose]</span><span class="delimiter">: </span><span class="description">factorize a sequence length into a product of integers and store the results in a 32-bit unsigned integer array.</span>
- <span class="signature">[`rfftf( N, r, strideR, offsetR, w, strideW, offsetW )`][@stdlib/fft/base/fftpack/float32/rfftf]</span><span class="delimiter">: </span><span class="description">compute the forward discrete Fourier transform (DFT) of a real-valued single-precision floating-point sequence.</span>
- <span class="signature">[`rffti( N, w, strideW, offsetW )`][@stdlib/fft/base/fftpack/float32/rffti]</span><span class="delimiter">: </span><span class="description">initialize a single-precision floating-point workspace array for performing a real-valued Fourier transform.</span>

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

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

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

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

<!-- </toc-links> -->
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/fft/base/fftpack/ndarray/generic/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( arrays )`][@stdlib/fft/base/fftpack/ndarray/generic/cffti]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a complex-valued Fourier transform on a one-dimensional ndarray.</span>
- <span class="signature">[`cosqi( arrays )`][@stdlib/fft/base/fftpack/ndarray/generic/cosqi]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a quarter-wave cosine transform on a one-dimensional ndarray.</span>
- <span class="signature">[`rfftf( arrays )`][@stdlib/fft/base/fftpack/ndarray/generic/rfftf]</span><span class="delimiter">: </span><span class="description">compute the forward discrete Fourier transform (DFT) of a real-valued one-dimensional ndarray.</span>
- <span class="signature">[`rffti( arrays )`][@stdlib/fft/base/fftpack/ndarray/generic/rffti]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a real-valued Fourier transform on a one-dimensional ndarray.</span>
- <span class="signature">[`sinqi( arrays )`][@stdlib/fft/base/fftpack/ndarray/generic/sinqi]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a quarter-wave sine transform on a one-dimensional ndarray.</span>

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

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

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

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

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