Skip to content

docs: update namespace table of contents #13369

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 8, 2026
+18 −0
Merged

docs: update namespace table of contents #13369

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
15 changes: 15 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 @@ -57,6 +57,7 @@ var o = ns;
- <span class="signature">[`csumkbn( N, x, strideX )`][@stdlib/blas/ext/base/csumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`cunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/cunitspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`cwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/cwapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a single-precision complex floating-point strided array `x` and assign the results to elements in a single-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`cwax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/cwax]</span><span class="delimiter">: </span><span class="description">multiply each element in a single-precision complex floating-point strided array `x` by a scalar constant and assign the results to elements in a single-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`cwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/cwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two single-precision complex floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`cwxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/cwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a single-precision complex floating-point strided array `x` and assign the results to elements in a single-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`cxpy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/cxpy]</span><span class="delimiter">: </span><span class="description">add elements of a single-precision complex floating-point strided array `x` to the corresponding elements of a single-precision complex floating-point strided array `y` and assign the results to `y`.</span>
Expand Down Expand Up @@ -150,6 +151,7 @@ var o = ns;
- <span class="signature">[`dunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/dunitspace]</span><span class="delimiter">: </span><span class="description">fill a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`dvander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/dvander]</span><span class="delimiter">: </span><span class="description">generate a double-precision floating-point Vandermonde matrix.</span>
- <span class="signature">[`dwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/dwapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a double-precision floating-point strided array `x` and assign the results to elements in a double-precision floating-point strided array `w`.</span>
- <span class="signature">[`dwax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/dwax]</span><span class="delimiter">: </span><span class="description">multiply each element in a double-precision floating-point strided array `x` by a scalar constant and assign the results to elements in a double-precision floating-point strided array `w`.</span>
- <span class="signature">[`dwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/dwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two double-precision floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`dwxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/dwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a double-precision floating-point strided array `x` and assign the results to elements in a double-precision floating-point strided array `w`.</span>
- <span class="signature">[`dxmy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a double-precision floating-point strided array `x` by the corresponding elements of a double-precision floating-point strided array `y` and assign the results to `y`.</span>
Expand Down Expand Up @@ -188,6 +190,7 @@ var o = ns;
- <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">[`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>
- <span class="signature">[`gfindIndex( N, x, strideX, clbk[, thisArg] )`][@stdlib/blas/ext/base/gfind-index]</span><span class="delimiter">: </span><span class="description">return the index of the first element which passes a test implemented by a predicate function.</span>
- <span class="signature">[`gfindLastIndex( N, x, strideX, clbk[, thisArg] )`][@stdlib/blas/ext/base/gfind-last-index]</span><span class="delimiter">: </span><span class="description">return the index of the last element which passes a test implemented by a predicate function.</span>
Expand Down Expand Up @@ -326,6 +329,7 @@ var o = ns;
- <span class="signature">[`sunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/sunitspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`svander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/svander]</span><span class="delimiter">: </span><span class="description">generate a single-precision floating-point Vandermonde matrix.</span>
- <span class="signature">[`swapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/swapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a single-precision floating-point strided array `x` and assign the results to elements in a single-precision floating-point strided array `w`.</span>
- <span class="signature">[`swax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/swax]</span><span class="delimiter">: </span><span class="description">multiply each element in a single-precision floating-point strided array `x` by a scalar constant and assign the results to elements in a single-precision floating-point strided array `w`.</span>
- <span class="signature">[`swhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/swhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two single-precision floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`swxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/swxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a single-precision floating-point strided array `x` and assign the results to elements in a single-precision floating-point strided array `w`.</span>
- <span class="signature">[`sxmy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/sxmy]</span><span class="delimiter">: </span><span class="description">multiply elements of a single-precision floating-point strided array `x` by the corresponding elements of a single-precision floating-point strided array `y` and assign the results to `y`.</span>
Expand All @@ -350,6 +354,7 @@ var o = ns;
- <span class="signature">[`zsumkbn( N, x, strideX )`][@stdlib/blas/ext/base/zsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`zunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/zunitspace]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`zwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a double-precision complex floating-point strided array `x` and assign the results to elements in a double-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`zwax( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwax]</span><span class="delimiter">: </span><span class="description">multiply each element in a double-precision complex floating-point strided array `x` by a scalar constant and assign the results to elements in a double-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`zwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/zwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two double-precision complex floating-point strided arrays depending on a condition.</span>
- <span class="signature">[`zwxsa( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwxsa]</span><span class="delimiter">: </span><span class="description">subtract a scalar constant from each element in a double-precision complex floating-point strided array `x` and assign the results to elements in a double-precision complex floating-point strided array `w`.</span>
- <span class="signature">[`zxpy( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/zxpy]</span><span class="delimiter">: </span><span class="description">add elements of a double-precision complex floating-point strided array `x` to the corresponding elements of a double-precision complex floating-point strided array `y` and assign the results to `y`.</span>
Expand Down Expand Up @@ -434,6 +439,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[@stdlib/blas/ext/base/zwxsa]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zwxsa
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 @@ -48,6 +48,7 @@ var o = ns;
- <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>
- <span class="signature">[`sinti( N, workspace, strideW, offsetW )`][@stdlib/fft/base/fftpack/sinti]</span><span class="delimiter">: </span><span class="description">initialize a workspace array for performing a sine transform.</span>

</div>

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

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

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

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

</section>
Expand Down