raphtory 0.17.0

raphtory, a temporal graph library
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

//! Varying degree calculations for the entire graph.
//! The degree of a node is the number of edges connected to it.
//!
//! There are two types of degree: in-degree and out-degree.
//! In-degree is the number of edges that point to a node.
//! Out-degree is the number of edges that point away from a node.
//!
//! This library provides the following degree calculations:
//! - max_out_degree - The maximum out degree of any node in the graph.
//! - max_in_degree - The maximum in degree of any node in the graph.
//! - min_out_degree - The minimum out degree of any node in the graph.
//! - min_in_degree - The minimum in degree of any node in the graph.
//! - average_degree - The average degree of all nodes in the graph.
//!
//!
//! # Examples
//!
//! ```rust
//! use raphtory::algorithms::metrics::degree::*;
//! use raphtory::prelude::*;
//!
//! let g = Graph::new();
//! let windowed_graph = g.window(0, 7);
//! let vs = vec![
//!     (1, 1, 2),
//!     (2, 1, 3),
//!     (3, 2, 1),
//!     (4, 3, 2),
//!     (5, 1, 4),
//!     (6, 4, 5),
//! ];
//!
//! for (t, src, dst) in &vs {
//!     g.add_edge(*t, *src, *dst, NO_PROPS, None);
//! }
//!
//! print!("Max out degree: {:?}", max_out_degree(&windowed_graph));
//! print!("Max in degree: {:?}", max_in_degree(&windowed_graph));
//! print!("Min out degree: {:?}", min_out_degree(&windowed_graph));
//! print!("Min in degree: {:?}", min_in_degree(&windowed_graph));
//! print!("Max degree: {:?}", min_degree(&windowed_graph));
//! print!("Min degree: {:?}", max_degree(&windowed_graph));
//! print!("Average degree: {:?}", average_degree(&windowed_graph));
//! ```
//!
use crate::{db::api::view::*, prelude::*};
use rayon::prelude::*;

/// The largest degree
pub fn max_degree<'graph, G: GraphViewOps<'graph>>(graph: &G) -> usize {
    graph.nodes().degree().max().unwrap_or(0)
}

/// The minimum degree of any node in the graph
pub fn min_degree<'graph, G: GraphViewOps<'graph>>(graph: &'graph G) -> usize {
    graph.nodes().degree().min().unwrap_or(0)
}

/// The maximum out degree of any node in the graph.
pub fn max_out_degree<'graph, G: GraphViewOps<'graph>>(graph: &'graph G) -> usize {
    graph.nodes().out_degree().max().unwrap_or(0)
}

/// The maximum in degree of any node in the graph.
pub fn max_in_degree<'graph, G: GraphViewOps<'graph>>(graph: &'graph G) -> usize {
    graph.nodes().in_degree().max().unwrap_or(0)
}

/// The minimum out degree of any node in the graph.
pub fn min_out_degree<'graph, G: GraphViewOps<'graph>>(graph: &'graph G) -> usize {
    graph.nodes().out_degree().min().unwrap_or(0)
}

/// The minimum in degree of any node in the graph.
pub fn min_in_degree<'graph, G: GraphViewOps<'graph>>(graph: &'graph G) -> usize {
    graph.nodes().in_degree().min().unwrap_or(0)
}

/// The average degree of all nodes in the graph.
pub fn average_degree<'graph, G: GraphViewOps<'graph>>(graph: &'graph G) -> f64 {
    let (deg_sum, count) = graph
        .nodes()
        .degree()
        .par_iter_values()
        .fold_with((0usize, 0usize), |(deg_sum, count), deg| {
            (deg_sum + deg, count + 1)
        })
        .reduce_with(|(deg_sum1, count1), (deg_sum2, count2)| {
            (deg_sum1 + deg_sum2, count1 + count2)
        })
        .unwrap_or((0, 1));

    deg_sum as f64 / count as f64
}