B-Tree range map

CI Crate informations License Documentation

A range map is a map where keys are aggregated into ranges of keys for efficient storage. Every time you need to store a large number numeric-keyed items in a map or set, a range map (or range set) should be used.

This library provides a range map implementation based on btree-slab's B-tree. It defines three basic types RangeSet<T>, RangeMap<K, V> and RangeMultiMap<K, S>.

Usage

The RangeSet<T> and RangeMap<K, V> behave similarly to the standard BTreeSet<T> and BTreeMap<K, V> types. However in addition to PartialOrd, the key type must also implement the Measure trait defining how keys are merged into ranges. This trait is implemented by default for char, integer types and float types.

```rust use btreerangemap::RangeMap;

let mut rangemap: RangeMap = RangeMap::new(); rangemap.insert(00..=05, true); rangemap.insert(4, false); asserteq!(rangemap.rangecount(), 3); asserteq!(rangemap.get(03), Some(&true)); asserteq!(rangemap.get(04), Some(&false)); asserteq!(rangemap.get(05), Some(&true)); ```

This library supports included and excluded bounds:

rust range_map.insert(..1, true); range_map.insert(..=1, true); range_map.insert(2, true); range_map.insert(3..5, true); range_map.insert(5..=7, true); range_map.insert(7.., true); assert_eq!(range_map.range_count(), 1);

It also supports non standard ranges with excluded start bounds:

```rust use btreerangemap::{ RangeFromExcluded, RangeFromExcludedTo, RangeFromExcludedToIncluded };

// same as 4.. range_map.insert(RangeFromExcluded::new(3), true);

// same as 3 range_map.insert(RangeFromExcludedTo::new(2, 4), true);

// same as 1..=2 range_map.insert(RangeFromExcludedToIncluded::new(0, 2), true);

asserteq!(rangemap.range_count(), 1); ```

Floats

Floating point numbers f32 and f64 are handled as one might expect.

```rust use btreerangemap::{RangeMap, RangeFromExcluded}; let mut range_map: RangeMap = RangeMap::new();

// sets all f32 below zero to false. range_map.insert(..0.0, false);

// sets all f32 above zero to true. range_map.insert(RangeFromExcluded::new(0.0), true);

asserteq!(rangemap.rangecount(), 2); asserteq!(range_map.get(0.0), None); // only 0.0 is unmapped. ```

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.