chore: change some fn's and variable's name

Signed-off-by: feathercyc <[email protected]>

Cargo.toml

@@ -8,14 +8,20 @@ license = "Apache-2.0"
 keywords = ["Interval Tree", "Augmented Tree", "Red-Black Tree"]
 
 [dependencies]
+serde = { version = "1.0", default-features = false, features = [
+    "derive",
+    "std",
+], optional = true }
 
 [dev-dependencies]
 criterion = "0.5.1"
 rand = "0.8.5"
+serde_json = "1.0"
 
 [features]
 default = []
-interval_tree_find_overlap_ordered = []
+graphviz = []
+serde = ["dep:serde"]
 
 [[bench]]
 name = "bench"

benches/bench.rs

@@ -65,7 +65,7 @@ fn interval_map_insert_remove(count: usize, bench: &mut Bencher) {
             black_box(map.insert(i, ()));
         }
         for i in &intervals {
-            black_box(map.remove(&i));
+            black_box(map.remove(i));
         }
     });
 }

src/entry.rs

@@ -19,7 +19,7 @@ pub struct OccupiedEntry<'a, T, V, Ix> {
     /// Reference to the map
     pub map_ref: &'a mut IntervalMap<T, V, Ix>,
     /// The entry node
-    pub node: NodeIndex<Ix>,
+    pub node_idx: NodeIndex<Ix>,
 }
 
 /// A view into a vacant entry in a `IntervalMap`.
@@ -53,7 +53,7 @@ where
     #[inline]
     pub fn or_insert(self, default: V) -> &'a mut V {
         match self {
-            Entry::Occupied(entry) => entry.map_ref.node_mut(entry.node, Node::value_mut),
+            Entry::Occupied(entry) => entry.map_ref.node_mut(entry.node_idx, Node::value_mut),
             Entry::Vacant(entry) => {
                 let entry_idx = NodeIndex::new(entry.map_ref.nodes.len());
                 let _ignore = entry.map_ref.insert(entry.interval, default);
@@ -88,7 +88,7 @@ where
     {
         match self {
             Entry::Occupied(entry) => {
-                f(entry.map_ref.node_mut(entry.node, Node::value_mut));
+                f(entry.map_ref.node_mut(entry.node_idx, Node::value_mut));
                 Self::Occupied(entry)
             }
             Entry::Vacant(entry) => Self::Vacant(entry),

src/index.rs

@@ -1,30 +1,60 @@
 use std::fmt;
 use std::hash::Hash;
 
-pub type DefaultIx = u32;
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+
+/// Trait for the unsigned integer type used for node indices.
+pub trait IndexType: Copy + Default + Hash + Ord + fmt::Debug + 'static {
+    const SENTINEL: Self;
 
-pub unsafe trait IndexType: Copy + Default + Hash + Ord + fmt::Debug + 'static {
+    /// Convert x from usize to the corresponding type
+    /// # Notice
+    /// Using u8 and u16 types may cause numerical overflow. Please check the numerical range before using
     fn new(x: usize) -> Self;
+
+    /// Convert self to usize
     fn index(&self) -> usize;
+
+    /// Return Self::MAX
     fn max() -> Self;
-}
 
-unsafe impl IndexType for u32 {
-    #[inline(always)]
-    fn new(x: usize) -> Self {
-        x as u32
-    }
-    #[inline(always)]
-    fn index(&self) -> usize {
-        *self as usize
-    }
-    #[inline(always)]
-    fn max() -> Self {
-        ::std::u32::MAX
+    /// Check if self is Self::SENTINEL
+    fn is_sentinel(&self) -> bool {
+        *self == Self::SENTINEL
     }
 }
 
+macro_rules! impl_index {
+    ($type:ident) => {
+        impl IndexType for $type {
+            const SENTINEL: Self = 0;
+
+            #[inline(always)]
+            fn new(x: usize) -> Self {
+                x as $type
+            }
+            #[inline(always)]
+            fn index(&self) -> usize {
+                *self as usize
+            }
+            #[inline(always)]
+            fn max() -> Self {
+                Self::MAX
+            }
+        }
+    };
+}
+
+impl_index!(u8);
+impl_index!(u16);
+impl_index!(u32);
+impl_index!(u64);
+
+pub type DefaultIx = u32;
+
 /// Node identifier.
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Copy, Clone, Default, PartialEq, PartialOrd, Eq, Ord, Hash)]
 pub struct NodeIndex<Ix = DefaultIx>(Ix);
 
@@ -34,26 +64,30 @@ impl<Ix: IndexType> NodeIndex<Ix> {
         NodeIndex(IndexType::new(x))
     }
 
-    #[inline]
-    pub fn index(self) -> usize {
-        self.0.index()
-    }
-
-    #[inline]
-    pub fn end() -> Self {
-        NodeIndex(IndexType::max())
+    pub fn inc(&self) -> Self {
+        if self.index() == <Ix as IndexType>::max().index() {
+            panic!("Index will overflow!")
+        }
+        NodeIndex::new(self.index() + 1)
     }
 }
 
-unsafe impl<Ix: IndexType> IndexType for NodeIndex<Ix> {
+impl<Ix: IndexType> IndexType for NodeIndex<Ix> {
+    const SENTINEL: Self = NodeIndex(Ix::SENTINEL);
+
+    #[inline]
     fn index(&self) -> usize {
         self.0.index()
     }
+
+    #[inline]
     fn new(x: usize) -> Self {
         NodeIndex::new(x)
     }
+
+    #[inline]
     fn max() -> Self {
-        NodeIndex(<Ix as IndexType>::max())
+        NodeIndex(IndexType::max())
     }
 }
 

src/interval.rs

@@ -8,9 +8,14 @@
 //!
 //! Currently, `interval_map` only supports half-open intervals, i.e., [...,...).
 
+use std::fmt::{Display, Formatter};
+
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Deserializer, Serialize, Serializer};
+
 /// The interval stored in `IntervalMap` represents [low, high)
-#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
 #[non_exhaustive]
+#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct Interval<T> {
     /// Low value
     pub low: T,
@@ -32,9 +37,27 @@ impl<T: Ord> Interval<T> {
 
     /// Checks if self overlaps with other interval
     #[inline]
-    pub fn overlap(&self, other: &Self) -> bool {
+    pub fn overlaps(&self, other: &Self) -> bool {
         self.high > other.low && other.high > self.low
     }
+
+    /// Checks if self contains other interval
+    /// e.g. [1,10) contains [1,8)
+    #[inline]
+    pub fn contains(&self, other: &Self) -> bool {
+        self.low <= other.low && self.high > other.high
+    }
+
+    /// Checks if self contains a point
+    pub fn contains_point(&self, p: T) -> bool {
+        self.low <= p && self.high > p
+    }
+}
+
+impl<T: Display> Display for Interval<T> {
+    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
+        write!(f, "[{},{})", self.low, self.high)
+    }
 }
 
 /// Reference type of `Interval`
@@ -64,6 +87,21 @@ impl<'a, T: Ord> IntervalRef<'a, T> {
     }
 }
 
+#[cfg(feature = "serde")]
+impl<T: Serialize + Ord> Serialize for Interval<T> {
+    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+        (&self.low, &self.high).serialize(serializer)
+    }
+}
+
+#[cfg(feature = "serde")]
+impl<'de, T: Deserialize<'de> + Ord> Deserialize<'de> for Interval<T> {
+    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
+        let (low, high) = <(T, T)>::deserialize(deserializer)?;
+        Ok(Interval::new(low, high))
+    }
+}
+
 #[cfg(test)]
 mod test {
     use super::*;
@@ -73,4 +111,42 @@ mod test {
     fn invalid_range_should_panic() {
         let _interval = Interval::new(3, 1);
     }
+
+    #[test]
+    fn test_interval_clone() {
+        let interval1 = Interval::new(1, 10);
+        let interval2 = interval1.clone();
+        assert_eq!(interval1, interval2);
+    }
+
+    #[test]
+    fn test_interval_compare() {
+        let interval1 = Interval::new(1, 10);
+        let interval2 = Interval::new(5, 15);
+        assert!(interval1 < interval2);
+        assert!(interval2 > interval1);
+        assert_eq!(interval1, Interval::new(1, 10));
+        assert_ne!(interval1, interval2);
+    }
+
+    #[test]
+    fn test_interval_hash() {
+        let interval1 = Interval::new(1, 10);
+        let interval2 = Interval::new(1, 10);
+        let interval3 = Interval::new(5, 15);
+        let mut hashset = std::collections::HashSet::new();
+        hashset.insert(interval1);
+        hashset.insert(interval2);
+        hashset.insert(interval3);
+        assert_eq!(hashset.len(), 2);
+    }
+
+    #[cfg(feature = "serde")]
+    #[test]
+    fn test_interval_serialize_deserialize() {
+        let interval = Interval::new(1, 10);
+        let serialized = serde_json::to_string(&interval).unwrap();
+        let deserialized: Interval<i32> = serde_json::from_str(&serialized).unwrap();
+        assert_eq!(interval, deserialized);
+    }
 }