bounded_graph 0.3.0

A thin newtype wrapper for `petgraph` to assist in the creation of graphs with restrictions on their edges
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

use std::ops::{Deref, DerefMut, Index, IndexMut};

use petgraph::graph::{EdgeIndex, IndexType, NodeIndex};
use petgraph::visit::GraphBase;

use crate::{BoundedGraph, BoundedNode};

// Implement Deref to allow transparent access to graph methods
impl<N, E, G> Deref for BoundedGraph<N, E, G> {
    type Target = G;

    fn deref(&self) -> &Self::Target {
        &self.graph
    }
}

// Implement DerefMut to allow transparent mutable access
// Only available for nodes with ImmutableEdgeBounds to prevent edge count violations
impl<N, E, G> DerefMut for BoundedGraph<N, E, G>
where
    N: crate::ImmutableEdgeBounds,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.graph
    }
}

impl<N, E, G> AsRef<G> for BoundedGraph<N, E, G> {
    fn as_ref(&self) -> &G {
        &self.graph
    }
}

impl<N, E, Ix, G> Index<EdgeIndex<Ix>> for BoundedGraph<N, E, G>
where
    Ix: IndexType,
    G: GraphBase<NodeId = NodeIndex<Ix>, EdgeId = EdgeIndex<Ix>> + Index<EdgeIndex<Ix>>,
{
    type Output = G::Output;

    fn index(&self, index: EdgeIndex<Ix>) -> &Self::Output {
        &self.graph[index]
    }
}

impl<N, E, Ix, G> Index<NodeIndex<Ix>> for BoundedGraph<N, E, G>
where
    Ix: IndexType,
    G: GraphBase<NodeId = NodeIndex<Ix>, EdgeId = EdgeIndex<Ix>> + Index<NodeIndex<Ix>>,
{
    type Output = G::Output;

    fn index(&self, index: NodeIndex<Ix>) -> &Self::Output {
        &self.graph[index]
    }
}

impl<N, E, Ix, G> IndexMut<EdgeIndex<Ix>> for BoundedGraph<N, E, G>
where
    Ix: IndexType,
    G: GraphBase<NodeId = NodeIndex<Ix>, EdgeId = EdgeIndex<Ix>>
        + IndexMut<EdgeIndex<Ix>, Output = E>,
{
    fn index_mut(&mut self, index: EdgeIndex<Ix>) -> &mut Self::Output {
        &mut self.graph[index]
    }
}

impl<N, E, Ix, G> IndexMut<NodeIndex<Ix>> for BoundedGraph<N, E, G>
where
    Ix: IndexType,
    N: BoundedNode<Ix> + crate::ImmutableEdgeBounds,
    G: GraphBase<NodeId = NodeIndex<Ix>, EdgeId = EdgeIndex<Ix>> + IndexMut<NodeIndex<Ix>>,
{
    fn index_mut(&mut self, index: NodeIndex<Ix>) -> &mut Self::Output {
        &mut self.graph[index]
    }
}