# `criterion-decimal-throughput` – KB/s, MB/s, GB/s in Criterion.rs outputs

[![Rust](https://github.com/V0ldek/criterion-decimal-throughput/actions/workflows/rust.yml/badge.svg)](https://github.com/V0ldek/criterion-decimal-throughput/actions/workflows/rust.yml)
[![docs.rs](https://img.shields.io/docsrs/criterion-decimal-throughput?logo=docs.rs)](https://docs.rs/criterion-decimal-throughput)

[![Crates.io](https://img.shields.io/crates/v/criterion-decimal-throughput?logo=docs.rs)](https://crates.io/crates/criterion-decimal-throughput)
[![GitHub Release Date](https://img.shields.io/github/release-date/v0ldek/criterion-decimal-throughput)](https://github.com/V0ldek/criterion-decimal-throughput/releases)
[![GitHub last commit](https://img.shields.io/github/last-commit/v0ldek/criterion-decimal-throughput?logo=github)](https://github.com/V0ldek/criterion-decimal-throughput/commits/main)

[![Crates.io](https://img.shields.io/crates/l/criterion-decimal-throughput)](https://choosealicense.com/licenses/mit/)

Custom measurement format for Criterion.rs that displays throughput in decimal byte-multiples (KB/s, MB/s, GB/s) instead of binary (KiB/s, MiB/s, GiB/s).

## Features

Under default Criterion.rs measurements, the output of a benchmark with throughput configured will look like this:

![Throughput in binary (GiB/s)](img/throughput-binary.png)

meaning '1.5050 * 2^(30)' which is fine, I guess, but I'm not good enough at on-the-fly calculations to see at a glance that this is, in fact, a mean of around 1.6 billion bytes. With this crate we get:

![Throughput in decimal (GB/s)](img/throughput-decimal.png)

which is a much nicer '1.5787e9'. It is quite subjective to prefer one over the other, but Criterion.rs forces you into binary. If you share my preference, this crate allows you to get nicer numbers.

## Usage

Simply use the provided `decimal_byte_measurement` function for default configuration,
or set the `DecimalByteMeasurement` type as measurement manually. See the example on [docs.rs](https://docs.rs/criterion-decimal-throughput/1.0.0/criterion_decimal_throughput/index.html).

## Installation

Add `criterion-decimal-throughput` as your dev-dependency, either with `cargo`:

```bash
cargo add --dev criterion-decimal-throughput
```

Alternatively, add it directly to the `dev-dependencies` section of your `Cargo.toml`:

```toml
[dev-dependencies]
criterion-decimal-throughput = "1.0.0"
```

## Build & test

Simply use `cargo`:

```bash
cargo build
cargo test
```

## Contributing

See [Contribution Guide](CONTRIBUTING.md).