Iai

https://docs.rs/crate/iai/latest
Admin
Iai is an experimental benchmarking harness that uses Cachegrind to perform extremely precise...
Tokens:876
Snippets:7
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Running Iai Tests and Benchmarks (Rust)

Source: https://docs.rs/crate/iai/latest/source/CONTRIBUTING

This snippet demonstrates how to run all tests and benchmarks for the Iai project using Cargo. It also includes commands for linting with Clippy and formatting with Rustfmt, essential steps for contributing to the project.

```bash
cargo test --all
cargo bench

rustup component add clippy-preview
rustup component add rustfmt-preview

cargo clippy --all
cargo fmt --all
```

--------------------------------

### Cloning the Iai Repository (Git)

Source: https://docs.rs/crate/iai/latest/source/CONTRIBUTING

Instructions for cloning the Iai project repository to your local machine using Git. This is the first step for anyone looking to contribute to the codebase.

```bash
git clone git@github.com:your-username/iai.git
```

--------------------------------

### Rust: Define and run iai benchmarks

Source: https://docs.rs/crate/iai/latest/source/README

This example demonstrates how to define benchmarks using the iai crate in Rust. It includes a sample recursive Fibonacci function, how to use `iai::black_box` to prevent optimizations on inputs, and how to register multiple benchmark functions using `iai::main!` macro. The output shows the detailed performance metrics gathered by iai.

```rust
use iai::{black_box, main};

fn fibonacci(n: u64) -> u64 {
    match n {
        0 => 1,
        1 => 1,
        n => fibonacci(n-1) + fibonacci(n-2),
    }
}

fn iai_benchmark_short() -> u64 {
    fibonacci(black_box(10))
}

fn iai_benchmark_long() -> u64 {
    fibonacci(black_box(30));
}


ialiai::main!(iai_benchmark_short, iai_benchmark_long);

```

--------------------------------

### Rust Crate Configuration (Cargo.toml)

Source: https://docs.rs/crate/iai/latest/source/Cargo

This snippet shows the Cargo.toml file for the iai crate. It defines the package name, version, authors, edition, description, repository, readme, keywords, categories, and license. It also lists dependencies, feature flags, and bench configurations.

```toml
[package]
name = "iai"
version = "0.1.1"
authors = ["Brook Heisler <redattack34@gmail.com>"]
edition = "2018"

description = "One-shot benchmarking library"
repository = "https://github.com/bheisler/iai"
readme = "README.md"
keywords = ["iai", "benchmark"]
categories = ["development-tools::profiling"]
license = "Apache-2.0/MIT"

[dependencies]
iai_macro = { version = "0.1.0", path = "macro", optional = true }

[features]
real_blackbox = []
macro = ["iai_macro"]
default = []

[[bench]]
name = "test_regular_bench"
harness = false

```

--------------------------------

### Define and run iai benchmarks in Rust

Source: https://docs.rs/crate/iai/latest/index

This Rust code defines a benchmark suite using the 'iai' library. It includes a `fibonacci` function, benchmark functions (`iai_benchmark_short`, `iai_benchmark_long`) that use `iai::black_box` to prevent optimizations, and registers these benchmarks using `iai::main!` macro. The benchmarks are then run using `cargo bench`.

```rust
use iai::{black_box, main};

fn fibonacci(n: u64) -> u64 {
    match n {
        0 => 1,
        1 => 1,
        n => fibonacci(n-1) + fibonacci(n-2),
    }
}

fn iai_benchmark_short() -> u64 {
    fibonacci(black_box(10))
}

fn iai_benchmark_long() -> u64 {
    fibonacci(black_box(30));
}


iai::main!(iai_benchmark_short, iai_benchmark_long);

```

--------------------------------

### Rust: Add iai dependency and configure for benchmarking

Source: https://docs.rs/crate/iai/latest/source/README

This snippet shows how to add the iai benchmarking library as a development dependency in your project's Cargo.toml file and configure a benchmark target. It specifies that the benchmark harness should not be used, indicating that a custom harness (provided by iai) will be employed.

```toml
[dev-dependencies]
iai = "0.1"

[[bench]]
name = "my_benchmark"
harness = false

```
Tokens:
Raw