diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float32/docs/types/index.d.ts b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float32/docs/types/index.d.ts index 014fd6cc4e5c..7c5af963fea6 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float32/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/float32/docs/types/index.d.ts @@ -20,6 +20,7 @@ /* eslint-disable max-lines */ +import rfftf = require( '@stdlib/fft/base/fftpack/ndarray/float32/rfftf' ); import rffti = require( '@stdlib/fft/base/fftpack/ndarray/float32/rffti' ); /** @@ -27,7 +28,78 @@ import rffti = require( '@stdlib/fft/base/fftpack/ndarray/float32/rffti' ); */ interface Namespace { /** - * TODO + * Computes the forward discrete Fourier transform (DFT) of a real-valued one-dimensional single-precision floating-point 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 Float32Vector = require( '@stdlib/ndarray/vector/float32' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var rffti = require( '@stdlib/fft/base/fftpack/ndarray/float32/rffti' ); + * + * var N = 4; + * var len = scalar2ndarray( N, { + * 'dtype': 'int32' + * }); + * + * var w = new Float32Vector( ( 2*N ) + 34 ); + * rffti( [ w, len ] ); + * + * var r = new Float32Vector( [ 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 single-precision floating-point ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a zero-dimensional ndarray containing the length of the sequence to transform. + * + * @param arrays - array-like object containing ndarrays + * @returns input ndarray + * + * @example + * var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var Slice = require( '@stdlib/slice/ctor' ); + * var slice = require( '@stdlib/ndarray/slice' ); + * + * var N = 8; + * var len = scalar2ndarray( N, { + * 'dtype': 'int32' + * }); + * + * var w = new Float32Vector( ( 2*N ) + 34 ); + * + * var out = ns.rffti( [ w, len ] ); + * // returns + * + * var bool = ( out === w ); + * // returns true + * + * var twiddleFactors = slice( w, new Slice( N, 2*N ) ); + * // returns [ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ] + * + * var factors = slice( w, new Slice( 2*N, ( 2*N ) + 4 ) ); + * // returns [ 8, 2, 2, 4 ] */ rffti: typeof rffti; }