simplegraph 0.2.2

A simple graph implementation
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

/*!
 * Update a graph's arcs and weights.
 */

use super::GraphType;

/**
 * This trait provide a common interface
 * to create and update a graph.
 */
pub trait Graph<N> {
    /**
     * Initialize a new directed or undirecte graph with the
     * given number of nodes.
     */
    fn new(node_count: usize, gtype: GraphType) -> Self;

    /**
     * Create a new arc from ```src``` to ```dst``` (and from ```dst``` to ```src``` if the graph is undirected)
     * and associtate with this new arc the cost [num_traits::Num::zero()](https://docs.rs/num/latest/num/traits/trait.Zero.html)
     */
    fn add_new_default_arc(&mut self, src: usize, dst: usize);

    /**
     * Create a new arc from ```src``` to ```dst``` (and from ```dst``` to ```src``` if the graph is undirected)
     * and associtate with this new arc the cost weight
     */
    fn add_new_arc(&mut self, src: usize, dst: usize, weight: N);

    /**
     * Update all arcs weight using the given callback function.
     * At each function call the first argument is the index
     * of the source node, the second is the index of the
     * destination node and the third is the current weight
     * of the arc.
     * Note: in undirect graph the arc (i, j) is equivalent to the node
     * (j, i) and the implementation should, for efficiency and reduce
     * mistakes, call *f* for just one arc.
     */
    fn update_all_arcs_weight<F>(&mut self, f: F)
    where
        F: Fn(usize, usize, N) -> N;

    /**
     * Update all nodes weights using the given callback
     * function. The first argument to each call is the
     * index of the node and the second is its current weight.
     *
     */
    fn update_all_nodes_weight<F>(&mut self, f: F)
    where
        F: Fn(usize, N) -> N;
}