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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use crate::{
    adapt::transpose::TransposeRef,
    core::{
        GraphRef,
        base::EdgeReference,
        id::{CompactIdMap, IdType, Virtual},
        weight::{GetWeight, Weight},
    },
};

use super::{Error, ShortestPaths};

pub fn bellman_ford<V, E, G, W, F>(
    graph: &G,
    source: G::VertexId,
    goal: Option<G::VertexId>,
    edge_weight: F,
) -> Result<ShortestPaths<W, G>, Error>
where
    G: GraphRef<V, E>,
    W: Weight,
    F: GetWeight<E, W>,
{
    let vertex_map = graph.vertex_id_map();

    let mut dist = vec![W::inf(); vertex_map.len()];
    let mut pred = vec![Virtual::sentinel(); vertex_map.len()];

    dist[vertex_map.to_virt(source.clone()).unwrap().as_usize()] = W::zero();

    let mut terminated_early = false;

    // Try to relax edges |V| - 1 times.
    for _ in 1..graph.vertex_count() {
        let mut relaxed = false;

        for edge in graph.edges() {
            if let Some((next_dist, u, v)) = process_edge(&edge, &edge_weight, &vertex_map, &dist) {
                // Relax if better.
                dist[v.as_usize()] = next_dist;
                pred[v.as_usize()] = u;
                relaxed = true;
            }

            if !graph.is_directed() {
                // For undirected graph, we need to consider also the other
                // "direction" of the edge.
                if let Some((next_dist, u, v)) =
                    process_edge(&TransposeRef::new(edge), &edge_weight, &vertex_map, &dist)
                {
                    dist[v.as_usize()] = next_dist;
                    pred[v.as_usize()] = u;
                    relaxed = true;
                }
            }
        }

        // If no distance was improved, then subsequent iterations would not
        // improve as well. So we can terminate early.
        if !relaxed {
            terminated_early = true;
            break;
        }
    }

    // Check for negative cycles. If the main loop was terminated early, then
    // the absence of cycle is guaranteed.
    if !terminated_early {
        for edge in graph.edges() {
            if process_edge(&edge, &edge_weight, &vertex_map, &dist).is_some() {
                // Could be still relaxed, there is a negative cycle.
                return Err(Error::NegativeCycle);
            }

            if !graph.is_directed()
                && process_edge(&TransposeRef::new(edge), &edge_weight, &vertex_map, &dist)
                    .is_some()
            {
                return Err(Error::NegativeCycle);
            }
        }
    }

    if let Some(goal) = goal
        && dist[vertex_map.to_virt(goal).unwrap().as_usize()] == W::inf()
    {
        return Err(Error::GoalNotReached);
    }

    let dist = dist
        .into_iter()
        .enumerate()
        .filter_map(|(i, d)| {
            if d != W::inf() {
                vertex_map.to_real(Virtual::from(i)).map(|u| (u, d))
            } else {
                None
            }
        })
        .collect();

    let pred = pred
        .into_iter()
        .enumerate()
        .filter_map(|(i, p)| {
            if !p.is_sentinel() {
                Some((
                    vertex_map.to_real(Virtual::from(i)).unwrap(),
                    vertex_map.to_real(p).unwrap(),
                ))
            } else {
                None
            }
        })
        .collect();

    Ok(ShortestPaths { source, dist, pred })
}

#[inline(always)]
fn process_edge<VI, EI, ER, E, W, F>(
    edge: &ER,
    edge_weight: &F,
    vertex_map: &CompactIdMap<VI>,
    dist: &[W],
) -> Option<(W, Virtual<VI>, Virtual<VI>)>
where
    VI: IdType,
    EI: IdType,
    ER: EdgeReference<VI, EI, E>,
    W: Weight,
    F: GetWeight<E, W>,
{
    let u = vertex_map.to_virt(edge.from().clone()).unwrap();

    let short_dist = &dist[u.as_usize()];
    if short_dist == &W::inf() {
        return None;
    }

    let v = vertex_map.to_virt(edge.to().clone()).unwrap();

    let edge_dist = edge_weight.get(edge.attr());
    let next_dist = short_dist.clone() + edge_dist;

    if next_dist < dist[v.as_usize()] {
        Some((next_dist, u, v))
    } else {
        None
    }
}