honeycomb_benches/lib.rs
1//! # honeycomb-benches
2//!
3//! This crate contains all benchmarks of the project. It also contains simple binaries used to
4//! profile and further optimize the implementation.
5//!
6//! ## Binary
7//!
8//! The package provides a single binary, `hc-bench`, which exposes several benchmarks as
9//! subcommands. For details on options and arguments, run:
10//!
11//! ```sh
12//! cargo run --bin hc-bench -- --help
13//! ```
14//!
15//! Benchmarks are described in the documentation of their respective modules.
16//!
17//! ## Available benchmarks
18//!
19//! ### Criterion-based
20//!
21//! - `builder` - grid building routines at fixed size
22//! - `builder-grid-size` - grid building routines over a range of grid sizes
23//! - `fetch_icells` - `CMap2::iter_<CELL>` methods
24//! - `grisubal` - grisubal kernel with a fixed size grid
25//! - `grisubal-grid-size` - grisubal kernel over a range of grid granularity
26//! - `triangulate-quads` - triangulate all cells of a mixed-mesh
27//!
28//! ### Iai-callgrind-based
29//!
30//! - `prof-dim2-basic` - `CMap2` basic operations benchmarks
31//! - `prof-dim2-build` - `CMap2` constructor & building functions benchmarks
32//! - `prof-dim2-sewing-unsewing` - `CMap2` (un)sewing & (un)linking methods benchmarks
33
34#[doc(hidden)]
35pub mod cli;
36pub mod cut_edges;
37pub mod grid_gen;
38pub mod grisubal;
39pub mod remesh;
40pub mod shift;
41#[doc(hidden)]
42pub mod utils;