safe-graph 0.1.6

Graph implementation (refactored version of GraphMap from popular crate petgraph).
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

//! Graph Node related constructs.

use crate::edge::CompactDirection;
use indexmap::map::Keys;
use std::fmt::Debug;
use std::hash::Hash;
use std::iter::Cloned;

/// A trait group for `Graph`'s node identifier.
pub trait NodeTrait: Copy + Debug + Hash + Ord {}

/// Implement the `NodeTrait` for all types satisfying bounds.
impl<N> NodeTrait for N where N: Copy + Debug + Hash + Ord {}

/// Iterator over Nodes.
pub struct Nodes<'a, N: 'a + NodeTrait> {
    iter: Cloned<Keys<'a, N, Vec<(N, CompactDirection)>>>,
}

impl<'a, N: 'a + NodeTrait> Nodes<'a, N> {
    pub fn new(iter: Cloned<Keys<'a, N, Vec<(N, CompactDirection)>>>) -> Self {
        Self { iter }
    }
}

impl<'a, N: 'a + NodeTrait> Iterator for Nodes<'a, N> {
    type Item = N;
    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next()
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }
}

#[cfg(test)]
mod tests {
    use crate::edge::CompactDirection;
    use crate::node::Nodes;
    use indexmap::IndexMap;

    #[test]
    fn new() {
        let nodes: IndexMap<i32, Vec<(i32, CompactDirection)>> = IndexMap::new();

        Nodes::new(nodes.keys().cloned());
    }

    #[test]
    fn next() {
        let mut nodes: IndexMap<i32, Vec<(i32, CompactDirection)>> = IndexMap::with_capacity(3);
        nodes.insert(1, vec![]);
        nodes.insert(2, vec![]);
        nodes.insert(3, vec![]);

        let mut nodes = Nodes::new(nodes.keys().cloned());

        // Test node `1`.
        assert_eq!(nodes.next(), Some(1));
        assert_eq!(nodes.next(), Some(2));
        assert_eq!(nodes.next(), Some(3));

        // Test the end of iteration.
        assert_eq!(nodes.next(), None);
    }

    #[test]
    fn size_hint() {
        let mut nodes: IndexMap<i32, Vec<(i32, CompactDirection)>> = IndexMap::with_capacity(3);
        nodes.insert(1, vec![]);
        nodes.insert(2, vec![]);
        nodes.insert(3, vec![]);

        let mut nodes = Nodes::new(nodes.keys().cloned());

        assert_eq!(nodes.size_hint(), (3, Some(3)));

        // Lower the length of the iterator.
        nodes.next();

        assert_eq!(nodes.size_hint(), (2, Some(2)));

        // Lower the length of the iterator.
        nodes.next();

        assert_eq!(nodes.size_hint(), (1, Some(1)));

        // Lower the length of the iterator.
        nodes.next();

        assert_eq!(nodes.size_hint(), (0, Some(0)));
    }
}