Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion lib/node_modules/@stdlib/fft/base/fftpack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ var o = ns;

<div class="namespace-toc">

- <span class="signature">[`base`][@stdlib/fft/base/fftpack/generic]</span><span class="delimiter">: </span><span class="description">FFTPACK routines for fast Fourier transforms on "generic" collections.</span>
- <span class="signature">[`generic`][@stdlib/fft/base/fftpack/generic]</span><span class="delimiter">: </span><span class="description">FFTPACK routines for fast Fourier transforms on "generic" collections.</span>
- <span class="signature">[`ndarray`][@stdlib/fft/base/fftpack/ndarray]</span><span class="delimiter">: </span><span class="description">lower-level ndarray wrappers for FFTPACK fast Fourier transform routines.</span>

</div>

Expand Down Expand Up @@ -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

<!-- </toc-links> -->

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ndarray>
*
* var bool = ( out === w );
* // returns true
*
* var twiddleFactors = slice( w, new Slice( N, 2*N ) );
* // returns <ndarray>[ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ]
*
* var factors = slice( w, new Slice( 2*N, ( 2*N ) + 4 ) );
* // returns <ndarray>[ 8, 2, 2, 4 ]
*/
rffti: typeof rffti;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
var ns = {};

/**
* @name base
* @name generic
* @memberof ns
* @readonly
* @type {Namespace}
Expand Down
Original file line number Diff line number Diff line change
@@ -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",
Expand Down