From 13fe64c1058ac3d4997b9910c6382936837ba8d9 Mon Sep 17 00:00:00 2001 From: Saveliy Yusufov Date: Wed, 8 May 2024 12:57:20 -0400 Subject: [PATCH] Update docs for interleaved fft --- src/lib.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 8f2dbfb..df32329 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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 ///