From 1e3c42e0ed1b1ca19cdd5f2ce9d6ff7bd04609e0 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 14 Jul 2026 03:11:40 +0000 Subject: [PATCH] feat: update `fft/base/fftpack` TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../fft/base/fftpack/docs/types/index.d.ts | 41 ++++++++++++++++++- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/docs/types/index.d.ts b/lib/node_modules/@stdlib/fft/base/fftpack/docs/types/index.d.ts index f1f67ff85559..a628f4d39fce 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/fft/base/fftpack/docs/types/index.d.ts @@ -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' ); @@ -94,13 +95,49 @@ interface Namespace { * // returns [ ~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 [ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ] + * // returns [ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ] * * var factors = workspace.slice( 3*N, ( 3*N ) + 4 ); * // returns [ 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 + * + * var bool = ( out === workspace ); + * // returns true + * + * var cosineTable = workspace.slice( 0, N ); + * // returns [ 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 [ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ] + * + * var factors = workspace.slice( (3*N)-2, (3*N)+2 ); + * // returns [ 8, 2, 2, 4 ] + */ + costi: typeof costi; + /** * Factorizes a sequence length into a product of integers. * @@ -186,7 +223,7 @@ interface Namespace { * // returns [ ~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 [ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ] + * // returns [ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ] * * var factors = workspace.slice( 3*N, ( 3*N ) + 4 ); * // returns [ 8, 2, 2, 4 ]