diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/README.md b/lib/node_modules/@stdlib/fft/base/fftpack/README.md index 8a83772c243f..7a8707113b9e 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/README.md +++ b/lib/node_modules/@stdlib/fft/base/fftpack/README.md @@ -43,7 +43,8 @@ var o = ns;
-- [`base`][@stdlib/fft/base/fftpack/generic]: FFTPACK routines for fast Fourier transforms on "generic" collections. +- [`generic`][@stdlib/fft/base/fftpack/generic]: FFTPACK routines for fast Fourier transforms on "generic" collections. +- [`ndarray`][@stdlib/fft/base/fftpack/ndarray]: lower-level ndarray wrappers for FFTPACK fast Fourier transform routines.
@@ -88,6 +89,8 @@ console.log( objectKeys( ns ) ); [@stdlib/fft/base/fftpack/generic]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/generic +[@stdlib/fft/base/fftpack/ndarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fft/base/fftpack/ndarray + 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 6cb89805220e..b1c25465209c 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 @@ -21,15 +21,21 @@ /* eslint-disable max-lines */ import generic = require( '@stdlib/fft/base/fftpack/generic' ); +import ndarray = require( '@stdlib/fft/base/fftpack/ndarray' ); /** * Interface describing the `fftpack` namespace. */ interface Namespace { /** - * FFTPACK routines for fast Fourier transforms for "generic" collections. + * FFTPACK routines for fast Fourier transforms on generic collections. */ generic: typeof generic; + + /** + * Lower-level ndarray wrappers for FFTPACK fast Fourier transform routines. + */ + ndarray: typeof ndarray; } /** diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/docs/types/index.d.ts index 934d27f42164..096ac6afdba9 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/docs/types/index.d.ts @@ -23,11 +23,11 @@ import generic = require( '@stdlib/fft/base/fftpack/ndarray/generic' ); /** -* Interface describing the `fftpack` namespace. +* Interface describing the `ndarray` namespace. */ interface Namespace { /** - * TODO. + * Lower-level ndarray wrappers for generic FFTPACK fast Fourier transform routines. */ generic: typeof generic; } 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 fb2d966adf5f..b7f23e211c66 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 @@ -20,14 +20,49 @@ /* eslint-disable max-lines */ -import rffti = require( '@stdlib/fft/base/fftpack/generic/rffti' ); +import rffti = require( '@stdlib/fft/base/fftpack/ndarray/generic/rffti' ); /** * Interface describing the `generic` namespace. */ interface Namespace { /** - * TODO. + * Initializes a workspace array for performing a real-valued Fourier transform on a one-dimensional 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 Float64Vector = require( '@stdlib/ndarray/vector/float64' ); + * 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 Float64Vector( ( 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; } diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/lib/index.js b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/lib/index.js index 6574184cb7df..e7f191154c83 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/lib/index.js +++ b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/lib/index.js @@ -37,7 +37,7 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); var ns = {}; /** -* @name base +* @name generic * @memberof ns * @readonly * @type {Namespace} diff --git a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/package.json b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/package.json index 7b6a07aa2527..586da22fff7f 100644 --- a/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/package.json +++ b/lib/node_modules/@stdlib/fft/base/fftpack/ndarray/package.json @@ -1,5 +1,5 @@ { - "name": "@stdlib/fft/base/fftpack", + "name": "@stdlib/fft/base/fftpack/ndarray", "version": "0.0.0", "description": "Lower-level ndarray wrappers for FFTPACK fast Fourier transform routines.", "license": "Apache-2.0",