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//! [UG]:https://lihpc-computational-geometry.github.io/honeycomb/
11//!
12
13// ------ CUSTOM LINTS
14
15// --- enable doc_auto_cfg feature if compiling in nightly
16#![allow(unexpected_cfgs)]
17#![cfg_attr(nightly, feature(doc_auto_cfg))]
18#![warn(missing_docs)]
19#![warn(clippy::pedantic)]
20#![allow(clippy::similar_names)]
21#![allow(clippy::module_name_repetitions)]
22#![allow(clippy::cast_possible_truncation)]
23
24// ------ PUBLIC API
25
26pub mod attributes;
27
28pub mod cmap;
29
30pub mod geometry;
31
32// re-export since we use their items in the API
33pub use fast_stm as stm;