numerated/lib.rs
1// This file is part of Gear.
2
3// Copyright (C) 2023-2025 Gear Technologies Inc.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19//! Crate for working with [`Numerated`] types and their sets: [`Interval`] and [`IntervalsTree`].
20//!
21//! ### Note
22//! In case [`Numerated`] is implemented incorrectly for some type `T`,
23//! then this can cause incorrect behavior of [`IntervalsTree`] and [`Interval`] for `T`.
24
25#![no_std]
26#![deny(missing_docs)]
27
28extern crate alloc;
29
30pub mod interval;
31pub mod iterators;
32mod numerated;
33pub mod tree;
34
35pub use num_traits;
36pub use numerated::*;
37
38#[cfg(any(feature = "mock", test))]
39pub mod mock;
40
41#[cfg(test)]
42mod tests;