honeycomb_core/
lib.rs

1//! # honeycomb-core
2//!
3//! This crate implements all basic structures and methods for
4//! 2D and 3D combinatorial map modeling.
5//!
6//! This documentation focus on the implementation side of things and API usage, for more
7//! formal information about combinatorial maps, refer to the **Definitions** section of
8//! the [user guide][UG].
9//!
10//! ## Features
11//!
12//! The `par-internals` feature can be enabled so that `CMap` structures use `rayon` internally
13//! to accelerate some methods (e.g. `par_extend` for new element additions). This may also lead
14//! to changes in performance due to first-touch mechanisms (to be confirmed).
15//!
16//! [UG]:https://lihpc-computational-geometry.github.io/honeycomb/
17
18// ------ CUSTOM LINTS
19
20// --- enable doc_auto_cfg feature if compiling in nightly
21#![allow(unexpected_cfgs)]
22#![cfg_attr(nightly, feature(doc_auto_cfg))]
23#![warn(missing_docs)]
24#![warn(clippy::pedantic)]
25#![allow(clippy::similar_names)]
26#![allow(clippy::module_name_repetitions)]
27#![allow(clippy::cast_possible_truncation)]
28
29// ------ PUBLIC API
30
31pub mod attributes;
32
33pub mod cmap;
34
35pub mod geometry;
36
37// re-export since we use their items in the API
38pub use fast_stm as stm;