Struct tango_bench::MeasurementSettings

pub struct MeasurementSettings {
    pub filter_outliers: bool,
    pub samples_per_haystack: usize,
    pub min_iterations_per_sample: usize,
    pub max_iterations_per_sample: usize,
    pub sampler_type: SamplerType,
    pub cache_firewall: Option<usize>,
    pub yield_before_sample: bool,
}

Describes basic settings for the benchmarking process

This structure is passed to cli::run().

Should be created only with overriding needed properties, like so:

use tango_bench::MeasurementSettings;

let settings = MeasurementSettings {
    min_iterations_per_sample: 1000,
    ..Default::default()
};

Fields

filter_outliers: bool

samples_per_haystack: usize

The number of samples per one generated haystack

min_iterations_per_sample: usize

Minimum number of iterations in a sample for each of 2 tested functions

max_iterations_per_sample: usize

The number of iterations in a sample for each of 2 tested functions

sampler_type: SamplerType

cache_firewall: Option<usize>

Size of a CPU cache firewall in KBytes

If set, the scheduler will perform a dummy data read between samples generation to spoil the CPU cache

Cache firewall is a way to reduce the impact of the CPU cache on the benchmarking process. It tries to minimize discrepancies in performance between two algorithms due to the CPU cache state.

yield_before_sample: bool

If true, scheduler will perform a yield of control back to the OS before taking each sample

Yielding control to the OS is a way to reduce the impact of OS scheduler on the benchmarking process.

Trait Implementations

impl Clone for MeasurementSettings

fn clone(&self) -> MeasurementSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MeasurementSettings

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

Formats the value using the given formatter.

impl Default for MeasurementSettings

fn default() -> Self

Returns the “default value” for a type.

impl Copy for MeasurementSettings