phastft 0.4.0-rc.1

//! Options to tune to improve performance depending on the hardware and input size.

/// Calling FFT routines without specifying options will automatically select reasonable defaults
/// depending on the input size and other factors.
///
/// You only need to tune these options if you are trying to squeeze maximum performance
/// out of a known hardware platform that you can benchmark at varying input sizes.
#[non_exhaustive]
#[derive(Debug, Clone)]
pub struct Options {
    /// Whether to run the bit reversal step in 2 threads instead of one.
    /// This is beneficial only at medium to large sizes (i.e. megabytes of data).
    /// The exact threshold where it starts being beneficial varies depending on the hardware.
    ///
    /// This option is ignored if the `parallel` feature is disabled.
    pub multithreaded_bit_reversal: bool,

    /// Do not split the input any further to run in parallel below this size
    ///
    /// Set to `usize::MAX` to disable parallelism in the recursive FFT step.
    ///
    /// This option is ignored if the `parallel` feature is disabled.
    pub smallest_parallel_chunk_size: usize,
}

impl Default for Options {
    fn default() -> Self {
        Self {
            multithreaded_bit_reversal: false,
            smallest_parallel_chunk_size: 16384,
        }
    }
}

impl Options {
    /// Attempt to guess the best settings to use for optimal FFT
    /// `input_size` is measured in number of elements (floats)
    pub fn guess_options(input_size: usize) -> Options {
        let mut options = Options::default();
        let n: usize = input_size.ilog2() as usize;
        options.multithreaded_bit_reversal = n >= 16;
        options
    }
}