factor: Add BENCHMARKING.md

This commit is contained in:
nicoo 2021-05-03 12:26:05 +02:00
parent 7c287542c7
commit 12efaa6add

View file

@ -0,0 +1,12 @@
# Benchmarking `factor`
## Microbenchmarking deterministic functions
We currently use [`criterion`] to benchmark deterministic functions,
such as `gcd` and `table::factor`.
Those benchmarks can be simply executed with `cargo bench` as usual,
but may require a recent version of Rust, *i.e.* the project's minimum
supported version of Rust does not apply to the benchmarks.
[`criterion`]: https://bheisler.github.io/criterion.rs/book/index.html