gryf 0.2.1

Graph data structure library with focus on convenience, versatility, correctness and performance.
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
95
96
97
98
99
100
101
102
103
104
105

//! Adapters that act as casts to a more constrained type while checking the
//! validity at runtime.

use gryf_derive::{
    EdgeSet, GraphAdd, GraphFull, GraphMut, GraphRef, Guarantee, MultiEdge, Neighbors, VertexSet,
};

use crate::core::{
    GraphBase,
    marker::{Directed, Undirected},
};

/// Cast a graph to a directed graph.
#[derive(
    Debug,
    Neighbors,
    VertexSet,
    EdgeSet,
    GraphRef,
    GraphAdd,
    GraphMut,
    GraphFull,
    MultiEdge,
    Guarantee,
)]
#[gryf_crate]
pub struct CastAsDirected<G> {
    #[graph]
    graph: G,
}

impl<G> GraphBase for CastAsDirected<G>
where
    G: GraphBase,
{
    type VertexId = G::VertexId;
    type EdgeId = G::EdgeId;
    type EdgeType = Directed;
}

impl<G> CastAsDirected<G>
where
    G: GraphBase,
{
    /// Cast a graph to a directed graph.
    ///
    /// # Panics
    ///
    /// Panics if the given graph is not directed.
    pub fn new(graph: G) -> Self {
        assert!(
            graph.is_directed(),
            "undirected graph casted to directed graph"
        );

        Self { graph }
    }
}

/// Cast a graph to an undirected graph.
#[derive(
    Debug,
    Neighbors,
    VertexSet,
    EdgeSet,
    GraphRef,
    GraphAdd,
    GraphMut,
    GraphFull,
    MultiEdge,
    Guarantee,
)]
#[gryf_crate]
pub struct CastAsUndirected<G> {
    #[graph]
    graph: G,
}

impl<G> GraphBase for CastAsUndirected<G>
where
    G: GraphBase,
{
    type VertexId = G::VertexId;
    type EdgeId = G::EdgeId;
    type EdgeType = Undirected;
}

impl<G> CastAsUndirected<G>
where
    G: GraphBase,
{
    /// Cast a graph to an undirected graph.
    ///
    /// # Panics
    ///
    /// Panics if the given graph is not undirected.
    pub fn new(graph: G) -> Self {
        assert!(
            !graph.is_directed(),
            "directed graph casted to undirected graph"
        );

        Self { graph }
    }
}