Skip to content

feat: update fft/base/fftpack TypeScript declarations #13463

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

feat: update fft/base/fftpack TypeScript declarations #13463

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
41 changes: 39 additions & 2 deletions lib/node_modules/@stdlib/fft/base/fftpack/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

import cffti = require( '@stdlib/fft/base/fftpack/cffti' );
import cosqi = require( '@stdlib/fft/base/fftpack/cosqi' );
import costi = require( '@stdlib/fft/base/fftpack/costi' );
import decompose = require( '@stdlib/fft/base/fftpack/decompose' );
import rffti = require( '@stdlib/fft/base/fftpack/rffti' );
import sinqi = require( '@stdlib/fft/base/fftpack/sinqi' );
Expand Down Expand Up @@ -94,13 +95,49 @@ interface Namespace {
* // returns <Float64Array>[ ~0.98, ~0.92, ~0.83, ~0.7, ~0.56, ~0.38, ~0.2, ~0.0 ]
*
* var twiddleFactors = workspace.slice( 2*N, 3*N );
* // returns <Float64Array>[ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ]
* // returns <Float64Array>[ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ]
*
* var factors = workspace.slice( 3*N, ( 3*N ) + 4 );
* // returns <Float64Array>[ 8, 2, 2, 4 ]
*/
cosqi: typeof cosqi;

/**
* Initializes a workspace array for performing a cosine transform.
*
* ## Notes
*
* - The workspace array should have a length of at least `( 3*N ) + 34` elements.
*
* @param N - length of the sequence
* @param workspace - workspace array
* @param strideW - stride length for `workspace`
* @param offsetW - starting index for `workspace`
* @returns workspace array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var N = 9;
* var workspace = new Float64Array( ( 3*N ) + 34 );
*
* var out = ns.costi( N, workspace, 1, 0 );
* // returns <Float64Array>
*
* var bool = ( out === workspace );
* // returns true
*
* var cosineTable = workspace.slice( 0, N );
* // returns <Float64Array>[ 0, ~0.765, ~1.414, ~1.848, 0, ~0.765, ~1.414, ~1.848, 0 ]
*
* var twiddleFactors = workspace.slice( (2*N)-1, (3*N)-2 );
* // returns <Float64Array>[ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ]
*
* var factors = workspace.slice( (3*N)-2, (3*N)+2 );
* // returns <Float64Array>[ 8, 2, 2, 4 ]
*/
costi: typeof costi;

/**
* Factorizes a sequence length into a product of integers.
*
Expand Down Expand Up @@ -186,7 +223,7 @@ interface Namespace {
* // returns <Float64Array>[ ~0.98, ~0.92, ~0.83, ~0.7, ~0.56, ~0.38, ~0.2, ~0.0 ]
*
* var twiddleFactors = workspace.slice( 2*N, 3*N );
* // returns <Float64Array>[ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ]
* // returns <Float64Array>[ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ]
*
* var factors = workspace.slice( 3*N, ( 3*N ) + 4 );
* // returns <Float64Array>[ 8, 2, 2, 4 ]
Expand Down
Loading