gctree 0.35.0

A library for cache-friendly, graph-like, arena-allocated datastructures.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

//!

pub trait NodeIdx: Copy
    + PartialEq<Self> + Eq
    + PartialOrd<Self> + Ord
    + std::hash::Hash
    + From<usize> // for indexing into Vec<_>
    + std::ops::Deref<Target = usize>
    + std::fmt::Display
    + std::fmt::Debug
{}


/// Create a new type `$name : NodeIdx`.
#[macro_export]
macro_rules! node_idx {
    ($name:ident) => {
        #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
        pub struct $name(usize);

        impl From<usize> for $name {
            fn from(raw: usize) -> Self {
                Self(raw)
            }
        }

        impl std::ops::Deref for $name {
            type Target = usize;

            fn deref(&self) -> &Self::Target {
                &self.0
            }
        }

        impl std::fmt::Debug for $name {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                let Self(idx) = *self;
                write!(f, "@{idx}")?;
                Ok(())
            }
        }

        impl std::fmt::Display for $name {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                let Self(idx) = *self;
                write!(f, "@{idx}")?;
                Ok(())
            }
        }

        impl $crate::new::node_idx::NodeIdx for $name {}
    };
}


#[cfg(test)]
mod tests {
    node_idx![TestIdx];

    #[test]
    fn make_idx_type() {
        let idx = TestIdx::from(0);
        assert_eq!(*idx, 0);
    }
}