Enum FrequencyLimit 

pub enum FrequencyLimit {
    All,
    Min(NonNegF32),
    Max(NonNegF32),
    Range(NonNegF32, NonNegF32),
}

Can be used to specify a desired frequency limit.

If you know that you only need frequencies f <= 1000Hz, 1000 <= f <= 6777, or 10000 <= f, then this can help you to accelerate overall computation speed and memory usage.

Please note that due to frequency inaccuracies the FFT result may not contain a value for 1000Hz but for 998.76Hz!

Variants

All

Interested in all frequencies, including the DC component up to the Nyquist frequency. In other words, no limit at all.

Min(NonNegF32)

Lower bound: only interested in frequencies >= x. Limit is inclusive. Supported values are 0 <= x <= Nyquist-Frequency.

Max(NonNegF32)

Upper bound: only interested in frequencies <= x. Limit is inclusive. Supported values are 0 <= x <= Nyquist-Frequency.

Range(NonNegF32, NonNegF32)

Only interested in frequencies 1000 <= f <= 6777 for example. Both values are inclusive. The first value of the tuple is equivalent to FrequencyLimit::Min and the latter equivalent to FrequencyLimit::Max. Furthermore, the first value must not be bigger than the second value.

Implementations

impl FrequencyLimit

pub fn min(min: impl Into<NonNegF32>) -> Self

Creates a Self::Min limit.

Panics

If min is negative or not finite.

pub fn max(max: impl Into<NonNegF32>) -> Self

Creates a Self::Max limit.

Panics

If max is negative or not finite.

pub fn range(min: impl Into<NonNegF32>, max: impl Into<NonNegF32>) -> Self

Creates a Self::Range limit.

Panics

If one of the values is negative or not finite or if min > max.

pub const fn maybe_min(&self) -> Option<NonNegF32>

Returns the minimum value, if any.

pub const fn maybe_max(&self) -> Option<NonNegF32>

Returns the maximum value, if any.

pub fn verify( &self, max_detectable_frequency: f32, ) -> Result<(), FrequencyLimitError>

Verifies that the frequency limit has sane values and takes the maximum possible frequency into account.

Trait Implementations

impl Clone for FrequencyLimit

fn clone(&self) -> FrequencyLimit

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for FrequencyLimit

impl Debug for FrequencyLimit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.