Skip to content

docs: update namespace table of contents #14584

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
Aug 25, 2026
Merged

docs: update namespace table of contents #14584

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
6 changes: 6 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 @@ -43,6 +43,8 @@ var o = ns;

<div class="namespace-toc">

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

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

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

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

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

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

[@stdlib/fft/base/fftpack/ndarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray
Expand Down
8 changes: 8 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 @@ -41,6 +41,12 @@ var o = ns;

<!-- <toc pattern="*"> -->

<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 single-precision floating-point array.</span>

</div>

<!-- </toc> -->

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

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

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

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

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

<!-- <toc pattern="*"> -->

<div class="namespace-toc">

- <span class="signature">[`cffti( N, workspace, strideW, offsetW )`][@stdlib/fft/base/fftpack/float64/cffti]</span><span class="delimiter">: </span><span class="description">initialize a double-precision floating-point workspace array for performing a complex-valued Fourier transform.</span>
- <span class="signature">[`decompose( N, M, initial, si, oi, out, so, oo )`][@stdlib/fft/base/fftpack/float64/decompose]</span><span class="delimiter">: </span><span class="description">factorize a sequence length into a product of integers and store the results in a double-precision floating-point array.</span>
- <span class="signature">[`rffti( N, workspace, strideW, offsetW )`][@stdlib/fft/base/fftpack/float64/rffti]</span><span class="delimiter">: </span><span class="description">initialize a double-precision floating-point workspace array for performing a real-valued Fourier transform.</span>

</div>

<!-- </toc> -->

</section>
Expand Down Expand Up @@ -80,6 +88,12 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

</section>
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">[`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>

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

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

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

<!-- </toc-links> -->
Expand Down
4 changes: 4 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,8 @@ var o = ns;

<div class="namespace-toc">

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

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

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

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

</section>
Expand Down