Struct basic_dsp::MultiCoreSettings

#[repr(C)]pub struct MultiCoreSettings {
    pub core_limit: usize,
    pub med_dual_core_threshold: usize,
    pub med_multi_core_threshold: usize,
    pub large_dual_core_threshold: usize,
    pub large_multi_core_threshold: usize,
}

Holds parameters which specify how multiple cores are used to execute an operation.

Fields

core_limit: usize

All operations will be limited to not create more threads than specified here

med_dual_core_threshold: usize

med_multi_core_threshold: usize

large_dual_core_threshold: usize

large_multi_core_threshold: usize

Implementations

impl MultiCoreSettings

pub fn default() -> MultiCoreSettings

Creates multi core settings with default values

pub fn single_threaded() -> MultiCoreSettings

Creates multi core settings so that no thread will be spawned.

pub fn parallel() -> MultiCoreSettings

Creates multi core so that threads will be spawned if this appears to be beneficial.

pub fn new(core_limit: usize) -> MultiCoreSettings

Creates multi core settings with the given values.

If core_limit > 1 then the first time this function is executed a calibration run will be performed which determines the details for the multi threading strategy. This run takes between 200ms and 500ms.

pub fn with_thresholds(
    core_limit: usize,
    med_dual_core_threshold: usize,
    med_multi_core_threshold: usize,
    large_dual_core_threshold: usize,
    large_multi_core_threshold: usize
) -> MultiCoreSettings

Creates multi core settings with explicit thresholds.

The arguments allow to specify the number of cores which are used at maximum and as well as starting from which slice size the lib will start to use two or all cores. med denotes operations of medium complexity, e.g. such as log and sin. large denotes operations like convolution and interpolation.

Trait Implementations

impl Clone for MultiCoreSettings

pub fn clone(&self) -> MultiCoreSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MultiCoreSettings

impl Debug for MultiCoreSettings

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

Formats the value using the given formatter.