#benchmark #bench #simple

no-std dev benchmark-simple

A tiny, super simple and portable benchmarking library

11 releases

0.1.10 Nov 5, 2024
0.1.9 Feb 9, 2024
0.1.8 May 23, 2023
0.1.7 Oct 20, 2021

#79 in WebAssembly

Download history 268/week @ 2024-07-29 56/week @ 2024-08-05 41/week @ 2024-08-12 37/week @ 2024-08-19 86/week @ 2024-08-26 36/week @ 2024-09-02 58/week @ 2024-09-09 31/week @ 2024-09-16 77/week @ 2024-09-23 35/week @ 2024-09-30 15/week @ 2024-10-07 43/week @ 2024-10-14 40/week @ 2024-10-21 18/week @ 2024-10-28 197/week @ 2024-11-04 37/week @ 2024-11-11

298 downloads per month
Used in 17 crates

MIT license

15KB
299 lines

benchmark-simple

A tiny benchmarking library for Rust.

  • Trivial to use
  • Works pretty much everywhere, including WebAssembly (WASI, but also in-browser)
use benchmark_simple::*;

fn test_function() {
    // ...
}

let bench = Bench::new();
let options = Options::default();
let res = bench.run(&options, || test_function());
println!("result: {}", res);

Throughput computation:

use benchmark_simple::*;

fn test_function(m: &mut [u8]) {
    // ...
}

let mut m = vec![0u8; 1_000_000];
let bench = Bench::new();
let options = Options::default();
let res = bench.run(&options, || test_function(&mut m));
let throughput = res.throughput(m.len() as _);
println!("throughput: {}", throughput);

Options:

pub struct Options {
    /// Number of iterations to perform.
    pub iterations: u64,
    /// Number of warm-up iterations to perform.
    pub warmup_iterations: u64,
    /// Minimum number of samples to collect.
    pub min_samples: usize,
    /// Maximum number of samples to collect.
    pub max_samples: usize,
    /// Maximum RSD to tolerate (in 0...100).
    pub max_rsd: f64,
    /// Maximum benchmark duration time.
    pub max_duration: Option<std::time::Duration>,
    /// Verbose output
    pub verbose: bool,
}

Benchmark results can be made verbose by setting verbose to true in the Options struct, or by defining a BENCHMARK_VERBOSE environment variable.

Dependencies

~16–375KB