Skip to content

Commit

Permalink
Update docs for interleaved fft
Browse files Browse the repository at this point in the history
  • Loading branch information
smu160 committed May 8, 2024
1 parent 23c1d21 commit 13fe64c
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,11 @@ impl_fft_for!(fft_32, f32, Planner32, fft_32_with_opts_and_plan);

macro_rules! impl_fft_interleaved_for {
($func_name:ident, $precision:ty, $fft_func:ident) => {
/// FFT -- Decimation in Frequency. This is just the decimation-in-time algorithm, reversed.
/// This call to FFT is run, in-place.
/// The input should be provided in normal order, and then the modified input is bit-reversed.
/// FFT Interleaved -- this is an alternative to `fft_64`/`fft_32` in the case where
/// the input data is a array of `[num_complex::Complex]`.
///
/// The input should be provided in normal order, and then the modified input is
/// bit-reversed.
///
/// ## References
/// <https://inst.eecs.berkeley.edu/~ee123/sp15/Notes/Lecture08_FFT_and_SpectAnalysis.key.pdf>
Expand Down

0 comments on commit 13fe64c

Please sign in to comment.