hypergraph 4.1.0

Hypergraph is data structure library to create a directed hypergraph in which an hyperedge can join any number of vertices.
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

use std::fmt::{
    Display,
    Formatter,
    Result,
};

/// Vertex stable index representation as usize.
/// Uses the newtype index pattern.
/// <https://matklad.github.io/2018/06/04/newtype-index-pattern.html>
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct VertexIndex(pub usize);

impl Display for VertexIndex {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> Result {
        write!(formatter, "{}", self.0)
    }
}

impl From<usize> for VertexIndex {
    fn from(index: usize) -> Self {
        VertexIndex(index)
    }
}

/// Hyperedge stable index representation as usize.
/// Uses the newtype index pattern.
/// <https://matklad.github.io/2018/06/04/newtype-index-pattern.html>
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct HyperedgeIndex(pub usize);

impl Display for HyperedgeIndex {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
        write!(f, "{}", self.0)
    }
}

impl From<usize> for HyperedgeIndex {
    fn from(index: usize) -> Self {
        HyperedgeIndex(index)
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        HyperedgeIndex,
        VertexIndex,
    };

    #[test]
    fn vertex_index_display() {
        assert_eq!(VertexIndex(7).to_string(), "7");
    }

    #[test]
    fn hyperedge_index_display() {
        assert_eq!(HyperedgeIndex(42).to_string(), "42");
    }

    #[test]
    fn vertex_index_from_usize() {
        assert_eq!(VertexIndex::from(3usize), VertexIndex(3));
    }

    #[test]
    fn hyperedge_index_from_usize() {
        assert_eq!(HyperedgeIndex::from(9usize), HyperedgeIndex(9));
    }

    #[test]
    fn vertex_index_ordering() {
        assert!(VertexIndex(0) < VertexIndex(1));
    }

    #[test]
    fn hyperedge_index_ordering() {
        assert!(HyperedgeIndex(2) > HyperedgeIndex(1));
    }
}