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

use crate::core::{GraphBase, Neighbors, VertexSet, marker::Directed};

use super::{Connected, dfs::dfs};

/// Builder for [`Connected`].
pub struct ConnectedBuilder<'a, G>
where
    G: GraphBase,
{
    graph: &'a G,
    between: Option<(&'a G::VertexId, &'a G::VertexId)>,
    strong: bool,
}

impl<G> Connected<G>
where
    G: GraphBase,
{
    #[doc = include_str!("../../../docs/include/algo.on.md")]
    pub fn on(graph: &G) -> ConnectedBuilder<'_, G> {
        ConnectedBuilder {
            graph,
            between: None,
            strong: false,
        }
    }
}

impl<'a, G> ConnectedBuilder<'a, G>
where
    G: GraphBase,
{
    /// Narrows the connectivity check to only these two vertices.
    pub fn between(self, from: &'a G::VertexId, to: &'a G::VertexId) -> Self {
        Self {
            between: Some((from, to)),
            ..self
        }
    }
}

impl<'a, G> ConnectedBuilder<'a, G>
where
    G: GraphBase<EdgeType = Directed>,
{
    /// Instructs the algorithm to perform strong connectivity check on the
    /// directed graph.
    pub fn strong(self) -> Self {
        Self {
            strong: true,
            ..self
        }
    }
}

impl<'a, G> ConnectedBuilder<'a, G>
where
    G: GraphBase,
{
    #[doc = include_str!("../../../docs/include/algo.run.md")]
    pub fn run(self) -> Connected<G>
    where
        G: Neighbors + VertexSet,
    {
        dfs(self.graph, self.between, self.strong)
    }
}