From fab146604af4b2160943e0a463241875fbe1d617 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 26 Sep 2026 02:25:38 +0000 Subject: [PATCH] feat: update `fft/base/fftpack/ndarray/generic` TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../ndarray/generic/docs/types/index.d.ts | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/generic/docs/types/index.d.ts b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/generic/docs/types/index.d.ts index 5736b8b0c456..bb817b1b6f34 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/generic/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/generic/docs/types/index.d.ts @@ -22,6 +22,7 @@ import cffti = require( '@stdlib/fft/base/fftpack/ndarray/generic/cffti' ); import cosqi = require( '@stdlib/fft/base/fftpack/ndarray/generic/cosqi' ); +import rfftf = require( '@stdlib/fft/base/fftpack/ndarray/generic/rfftf' ); import rffti = require( '@stdlib/fft/base/fftpack/ndarray/generic/rffti' ); import sinqi = require( '@stdlib/fft/base/fftpack/ndarray/generic/sinqi' ); @@ -112,6 +113,42 @@ interface Namespace { */ cosqi: typeof cosqi; + /** + * Computes the forward discrete Fourier transform (DFT) of a real-valued one-dimensional ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional workspace ndarray containing pre-computed values. + * + * @param arrays - array-like object containing ndarrays + * @returns input ndarray + * + * @example + * var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var rffti = require( '@stdlib/fft/base/fftpack/ndarray/generic/rffti' ); + * + * var N = 4; + * var len = scalar2ndarray( N, { + * 'dtype': 'int32' + * }); + * + * var w = new Float64Vector( ( 2*N ) + 34 ); + * rffti( [ w, len ] ); + * + * var r = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); + * + * var out = ns.rfftf( [ r, w ] ); + * // returns [ 10.0, -2.0, 2.0, -2.0 ] + * + * var bool = ( out === r ); + * // returns true + */ + rfftf: typeof rfftf; + /** * Initializes a workspace array for performing a real-valued Fourier transform on a one-dimensional ndarray. *