wazabin-jstd 0.2.1

Typed identifiers, registries, graph containers with dominator/SESE analysis, string interning, and stable arenas
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

//! Edge views for immutable and mutable graph access.
use crate::graph::{
    Graph, GraphMut,
    node::{Node, NodeMut},
};

/// Typed edge handle trait for immutable graph references.
pub trait Edge<'graph> {
    type Graph: Graph;

    fn new(id: <Self::Graph as Graph>::EdgeId, graph: &'graph Self::Graph) -> Self;

    /// Returns this edge identifier.
    fn id(&self) -> <Self::Graph as Graph>::EdgeId;

    /// Returns the backing graph reference for this edge.
    fn graph(&self) -> &'graph Self::Graph;

    /// Returns the source node's id for this edge.
    #[allow(clippy::wrong_self_convention)]
    fn from_id(&self) -> <Self::Graph as Graph>::NodeId;

    /// Returns the destination node's id for this edge.
    fn to_id(&self) -> <Self::Graph as Graph>::NodeId;

    /// Returns the source node for this edge
    fn from(&self) -> <Self::Graph as Graph>::Node<'graph> {
        let id = self.from_id();
        <Self::Graph as Graph>::Node::new(id, self.graph())
    }

    /// Returns the destination node for this edge
    fn to(&self) -> <Self::Graph as Graph>::Node<'graph> {
        let id = self.to_id();
        <Self::Graph as Graph>::Node::new(id, self.graph())
    }

    /// Returns `true` when this edge starts and ends at the same node.
    fn is_loop(&self) -> bool {
        self.from_id() == self.to_id()
    }
}

pub trait EdgeMut<'graph> {
    type Graph: GraphMut;

    fn new(id: <Self::Graph as Graph>::EdgeId, graph: &'graph mut Self::Graph) -> Self;

    /// Returns this edge identifier.
    fn id(&self) -> <Self::Graph as Graph>::EdgeId;

    /// Returns the backing graph reference for this edge.
    fn graph(&mut self) -> &mut Self::Graph;

    /// Returns the source node's id for this edge.
    #[allow(clippy::wrong_self_convention)]
    fn from_id(&self) -> <Self::Graph as Graph>::NodeId;

    /// Returns mutable access to the source node for this edge.
    fn from(&mut self) -> <Self::Graph as GraphMut>::NodeMut<'_> {
        let id = self.from_id();
        <Self::Graph as GraphMut>::NodeMut::new(id, self.graph())
    }

    /// Returns the destination node's id for this edge.
    fn to_id(&self) -> <Self::Graph as Graph>::NodeId;

    /// Returns mutable access to the destination node for this edge.
    fn to(&mut self) -> <Self::Graph as GraphMut>::NodeMut<'_> {
        let id = self.to_id();
        <Self::Graph as GraphMut>::NodeMut::new(id, self.graph())
    }

    /// Redirects this edge to originate from `node` instead of its current source.
    fn set_from(&mut self, node: <Self::Graph as Graph>::NodeId);

    /// Returns an immutable view of this edge handle.
    fn as_ref(&mut self) -> <Self::Graph as Graph>::Edge<'_> {
        <Self::Graph as Graph>::Edge::new(self.id(), &*self.graph())
    }
}