Skip to content

Commit a87d76e

Browse files
committed
feat: update fft/base/fftpack TypeScript declarations
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 4f96827 commit a87d76e

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/fft/base/fftpack/docs/types

lib/node_modules/@stdlib/fft/base/fftpack/docs/types/index.d.ts

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
/* eslint-disable max-lines */
2222

2323
import cffti = require( '@stdlib/fft/base/fftpack/cffti' );
24+
import cosqi = require( '@stdlib/fft/base/fftpack/cosqi' );
2425
import decompose = require( '@stdlib/fft/base/fftpack/decompose' );
2526
import rffti = require( '@stdlib/fft/base/fftpack/rffti' );
2627

@@ -62,6 +63,42 @@ interface Namespace {
6263
*/
6364
cffti: typeof cffti;
6465

66+
/**
67+
* Initializes a workspace array for performing a quarter-wave cosine transform.
68+
*
69+
* ## Notes
70+
*
71+
* - The workspace array should have a length of at least `( 3*N ) + 34` elements.
72+
*
73+
* @param N - length of the sequence
74+
* @param workspace - workspace array
75+
* @param strideW - stride length for `workspace`
76+
* @param offsetW - starting index for `workspace`
77+
* @returns workspace array
78+
*
79+
* @example
80+
* var Float64Array = require( '@stdlib/array/float64' );
81+
*
82+
* var N = 8;
83+
* var workspace = new Float64Array( ( 3*N ) + 34 );
84+
*
85+
* var out = ns.cosqi( N, workspace, 1, 0 );
86+
* // returns <Float64Array>
87+
*
88+
* var bool = ( out === workspace );
89+
* // returns true
90+
*
91+
* var cosineTable = workspace.slice( 0, N );
92+
* // returns <Float64Array>[ ~0.98, ~0.92, ~0.83, ~0.7, ~0.56, ~0.38, ~0.2, ~0.0 ]
93+
*
94+
* var twiddleFactors = workspace.slice( 2*N, 3*N );
95+
* // returns <Float64Array>[ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ]
96+
*
97+
* var factors = workspace.slice( 3*N, ( 3*N ) + 4 );
98+
* // returns <Float64Array>[ 8, 2, 2, 4 ]
99+
*/
100+
cosqi: typeof cosqi;
101+
65102
/**
66103
* Factorizes a sequence length into a product of integers.
67104
*

0 commit comments

Comments
 (0)