cch 0.3.0

Pure-Rust Customizable Contraction Hierarchies (CCH): build, customize in parallel, and serve fast shortest-path distance, many-to-many matrix, and path queries on road networks
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

//! Input graph type in Compressed-Sparse-Row (CSR) format.

/// Node identifier (index into the CSR `first_out` array).
pub type NodeId = u32;

/// Arc identifier (index into the CSR `head`/`weight` arrays).
pub type ArcId = u32;

/// A directed, weighted graph stored in Compressed-Sparse-Row format.
///
/// Invariants (caller-enforced at construction time):
/// - `first_out.len() == node_count + 1`
/// - `head.len() == arc_count` and `weight.len() == arc_count`
/// - `first_out` is non-decreasing; `first_out[0] == 0`; `first_out[node_count] == arc_count`
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Graph {
    /// CSR row-pointer array; length `node_count + 1`.
    pub first_out: Vec<u32>,
    /// Arc target nodes; length `arc_count`.
    pub head: Vec<u32>,
    /// Arc weights; length `arc_count`.
    pub weight: Vec<u32>,
}

impl Graph {
    /// Returns the number of nodes in the graph.
    #[must_use]
    #[inline]
    pub fn node_count(&self) -> usize {
        self.first_out.len() - 1
    }

    /// Returns the number of arcs in the graph.
    #[must_use]
    #[inline]
    pub fn arc_count(&self) -> usize {
        self.head.len()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn graph_node_and_arc_count() {
        let g = Graph {
            first_out: vec![0, 2, 3, 3],
            head: vec![1, 2, 0],
            weight: vec![10, 20, 30],
        };
        assert_eq!(g.node_count(), 3);
        assert_eq!(g.arc_count(), 3);

        let empty = Graph {
            first_out: vec![0],
            head: vec![],
            weight: vec![],
        };
        assert_eq!(empty.node_count(), 0);
        assert_eq!(empty.arc_count(), 0);
    }
}