icentral-edge 0.1.0

Icetral-edge provides a utility for managing graph edges, enabling node connectivity and manipulation. This crate is exemplary for implementing robust graph data structures.
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

crate::ix!();

///-------------------------------------------------
/// src and dst are intentionally public
///
#[derive(Copy,Clone,Eq,Hash,PartialOrd,Ord,PartialEq)]
pub struct Edge {

    pub src: NodeId,
    pub dst: NodeId,
}

impl fmt::Debug for Edge {

    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {

        write!(f, "Edge({} <-> {})", self.src, self.dst)
    }
}

impl fmt::Display for Edge {

    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {

        write!(f, "({} <-> {})", self.src, self.dst)
    }
}

impl Edge {

    pub fn connects_nodes(&self, 
        v_i: NodeId, 
        v_n: NodeId) -> bool 
    {
        let connects: bool = 
        v_i == self.src && v_n == self.dst 
        || 
        v_i == self.dst && v_n == self.src ;

        debug!(
            "checking whether edge {} connects nodes {} and {} -- connects? {}", 
            self, 
            v_i, 
            v_n,
            connects
        );

        connects
    }

    /// This constructor is used in the case where
    /// we have numeric values only
    ///
    pub fn new_with_ids(src: usize, dst: usize) -> Self {

        Edge::new(nodeid![src], nodeid![dst])
    }

    pub fn new(src: NodeId, dst: NodeId) -> Self {

        let edge = Self { src, dst };

        debug!("created new edge: {}", edge);

        edge
    }

    pub fn random(node_max: usize) -> Self {

        let mut rng = WyRand::new();

        let n0 = rng.generate_range(0..node_max);
        let n1 = rng.generate_range(0..node_max);

        Self::new_with_ids(n0, n1)
    }

    pub fn reversed(&self) -> Self {
        Self {
            src: self.dst,
            dst: self.src,
        }
    }
}

impl Default for Edge {

    fn default() -> Self {
        Self {
            src: NodeId::bad(),
            dst: NodeId::bad(),
        }
    }
}