Skip to content

Commit 3ad67eb

Browse files
committed
Auto-generated commit
1 parent 584ef0c commit 3ad67eb

2 files changed

Lines changed: 39 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2026-06-17)
7+
## Unreleased (2026-06-18)
88

99
<section class="features">
1010

1111
### Features
1212

13+
- [`6e2e1fe`](https://github.com/stdlib-js/stdlib/commit/6e2e1feeedc61cb7fe91652568033cfbe9de276e) - update `fft/base/fftpack` TypeScript declarations [(#12946)](https://github.com/stdlib-js/stdlib/pull/12946)
1314
- [`9ea348e`](https://github.com/stdlib-js/stdlib/commit/9ea348efe3ffdfbf20263c5982bae054623f351a) - add `cffti` to namespace
1415
- [`61cc8a7`](https://github.com/stdlib-js/stdlib/commit/61cc8a7075fa22f699230509bbcb4628e04b41ca) - add `fft/base/fftpack/cffti` [(#12441)](https://github.com/stdlib-js/stdlib/pull/12441)
1516
- [`3a0597c`](https://github.com/stdlib-js/stdlib/commit/3a0597cddb16d89ade4cf3fbf7ed1422df9b0d03) - add `fft/base/fftpack` namespace
@@ -36,6 +37,8 @@
3637

3738
<details>
3839

40+
- [`6e2e1fe`](https://github.com/stdlib-js/stdlib/commit/6e2e1feeedc61cb7fe91652568033cfbe9de276e) - **feat:** update `fft/base/fftpack` TypeScript declarations [(#12946)](https://github.com/stdlib-js/stdlib/pull/12946) _(by stdlib-bot)_
41+
- [`46fd304`](https://github.com/stdlib-js/stdlib/commit/46fd304d00ac69f1fb6bb3eaa8965022724aa247) - **chore:** follow-up fixes for recent commits [(#12933)](https://github.com/stdlib-js/stdlib/pull/12933) _(by Philipp Burckhardt)_
3942
- [`9ea348e`](https://github.com/stdlib-js/stdlib/commit/9ea348efe3ffdfbf20263c5982bae054623f351a) - **feat:** add `cffti` to namespace _(by Athan Reines)_
4043
- [`61cc8a7`](https://github.com/stdlib-js/stdlib/commit/61cc8a7075fa22f699230509bbcb4628e04b41ca) - **feat:** add `fft/base/fftpack/cffti` [(#12441)](https://github.com/stdlib-js/stdlib/pull/12441) _(by Gunj Joshi, Athan Reines)_
4144
- [`30fc1af`](https://github.com/stdlib-js/stdlib/commit/30fc1afe3d3dbe8b50a93b20291f8efc6c6bdfd0) - **docs:** update notes _(by Athan Reines)_

docs/types/index.d.ts

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,48 @@
2020

2121
/* eslint-disable max-lines */
2222

23+
import cffti = require( '@stdlib/fft-base-fftpack-cffti' );
2324
import decompose = require( '@stdlib/fft-base-fftpack-decompose' );
2425
import rffti = require( '@stdlib/fft-base-fftpack-rffti' );
2526

2627
/**
2728
* Interface describing the `fftpack` namespace.
2829
*/
2930
interface Namespace {
31+
/**
32+
* Initializes a workspace array for performing a complex-valued Fourier transform.
33+
*
34+
* ## Notes
35+
*
36+
* - The workspace array should have a length of at least `( 4*N ) + 34` elements.
37+
* - For single-point sequences (N=1), the function returns immediately as the FFT is the identity operation.
38+
*
39+
* @param N - length of the sequence
40+
* @param workspace - workspace array
41+
* @param strideW - stride length for `workspace`
42+
* @param offsetW - starting index for `workspace`
43+
* @returns workspace array
44+
*
45+
* @example
46+
* var Float64Array = require( '@stdlib/array-float64' );
47+
*
48+
* var N = 8;
49+
* var workspace = new Float64Array( ( 4*N ) + 34 );
50+
*
51+
* var out = ns.cffti( N, workspace, 1, 0 );
52+
* // returns <Float64Array>
53+
*
54+
* var bool = ( out === workspace );
55+
* // returns true
56+
*
57+
* var twiddleFactors = workspace.slice( 2*N, 4*N );
58+
* // returns <Float64Array>[ 1, 0, ~0.707, ~0.707, ~0, 1, ~-0.707, ~0.707, 1, 0, 1, 0, 1, 0, ~0, -1 ]
59+
*
60+
* var factors = workspace.slice( 4*N, ( 4*N ) + 4 );
61+
* // returns <Float64Array>[ 8, 2, 2, 4 ]
62+
*/
63+
cffti: typeof cffti;
64+
3065
/**
3166
* Factorizes a sequence length into a product of integers.
3267
*

0 commit comments

Comments
 (0)