Struct CriterionCycleCounter

pub struct CriterionCycleCounter;

Custom cycle accurate measurement class for criterion

pub fn criterion_benchmark(c: &mut Criterion<CriterionCycleCounter>) {
  c.bench_function("cycle_10K", |b| b.iter(|| const_cycle_loop(black_box(10_000))));
}

fn core_cycle_measurement() -> Criterion<CriterionCycleCounter> {
  Criterion::default().with_measurement(CriterionCycleCounter)
}

criterion_group! {
  name = benches;
  config = core_cycle_measurement();
  targets = criterion_benchmark
}

Trait Implementations

impl Measurement for CriterionCycleCounter

type Intermediate = CycleInstant

This type represents an intermediate value for the measurements. It will be produced by the start function and passed to the end function. An example might be the wall-clock time as of the start call.

type Value = u64

This type is the measured value. An example might be the elapsed wall-clock time between the start and end calls.

fn start(&self) -> Self::Intermediate

Criterion.rs will call this before iterating the benchmark.

fn end(&self, i: Self::Intermediate) -> Self::Value

Criterion.rs will call this after iterating the benchmark to get the measured value.

fn add(&self, v1: &Self::Value, v2: &Self::Value) -> Self::Value

Combine two values. Criterion.rs sometimes needs to perform measurements in multiple batches of iterations, so the value from one batch must be added to the sum of the previous batches.

fn zero(&self) -> Self::Value

Return a “zero” value for the Value type which can be added to another value.

fn to_f64(&self, val: &Self::Value) -> f64

Converts the measured value to f64 so that it can be used in statistical analysis.

fn formatter(&self) -> &dyn ValueFormatter

Return a trait-object reference to the value formatter for this measurement.

impl ValueFormatter for CriterionCycleCounter

fn format_value(&self, value: f64) -> String

Format the value (with appropriate unit) and return it as a string.

fn format_throughput(&self, throughput: &Throughput, value: f64) -> String

Format the value as a throughput measurement. The value represents the measurement value; the implementor will have to calculate bytes per second, iterations per cycle, etc.

fn scale_values(&self, _typical_value: f64, _values: &mut [f64]) -> &'static str

Scale the given values to some appropriate unit and return the unit string.

fn scale_throughputs( &self, _typical_value: f64, throughput: &Throughput, _values: &mut [f64], ) -> &'static str

Convert the given measured values into throughput numbers based on the given throughput value, scale them to some appropriate unit, and return the unit string.

fn scale_for_machines(&self, _values: &mut [f64]) -> &'static str

Scale the values and return a unit string designed for machines.