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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
use num_traits::abs;

use crate::core::vertex_ref::LocalVertexRef;
use crate::db::view_api::VertexViewOps;
use crate::{
    core::state::{accumulator_id::accumulators, compute_state::ComputeStateVec} ,
    db::{
        task::{
            context::Context,
            task::{ATask, Job, Step},
            task_runner::TaskRunner,
        },
        view_api::GraphViewOps,
    },
};
use std::collections::HashMap;

#[derive(Clone, Debug)]
struct PageRankState {
    score: f64,
    out_degree: usize,
}

impl PageRankState {
    fn new(num_vertices: usize) -> Self {
        Self {
            score: 1f64 / num_vertices as f64,
            out_degree: 0,
        }
    }

    fn reset(&mut self) {
        self.score = 0f64;
    }
}

#[allow(unused_variables)]
pub fn unweighted_page_rank<G: GraphViewOps>(
    g: &G,
    iter_count: usize,
    threads: Option<usize>,
    tol: Option<f64>,
    use_l2_norm: bool,
) -> HashMap<String, f64> {
    let n = g.num_vertices();
    let total_edges = g.num_edges();

    let mut ctx: Context<G, ComputeStateVec> = g.into();

    let tol: f64 = tol.unwrap_or_else(|| 0.000001f64);
    let damp = 0.85;
    let teleport_prob = (1f64 - damp) / n as f64;
    let factor = damp / n as f64;

    let max_diff = accumulators::sum::<f64>(2);

    let total_sink_contribution = accumulators::sum::<f64>(4);

    ctx.global_agg_reset(max_diff);

    ctx.global_agg_reset(total_sink_contribution);

    let step1 = ATask::new(move |s| {
        let out_degree = s.out_degree();
        let state: &mut PageRankState = s.get_mut();
        state.out_degree = out_degree;
        Step::Continue
    });

    let step2: ATask<G, ComputeStateVec, PageRankState, _> = ATask::new(move |s| {
        // reset score
        {
            let state: &mut PageRankState = s.get_mut();
            state.reset();
        }

        for t in s.in_neighbours() {
            let prev = t.prev();

            s.get_mut().score += prev.score / prev.out_degree as f64;
        }

        s.get_mut().score *= damp;

        s.get_mut().score += teleport_prob;
        Step::Continue
    });

    let step3 = ATask::new(move |s| {
        let state: &mut PageRankState = s.get_mut();

        if state.out_degree == 0 {
            let curr = s.prev().score;

            let ts_contrib = factor * curr;
            s.global_update(&total_sink_contribution, ts_contrib);
        }
        Step::Continue
    });

    let step4 = ATask::new(move |s| {
        //read total sink contribution
        let total_sink_contribution = s
            .read_global_state(&total_sink_contribution)
            .unwrap_or_default();
        // update local score with total sink contribution
        let state: &mut PageRankState = s.get_mut();
        state.score += total_sink_contribution;

        // update global max diff

        let curr = state.score;
        let prev = s.prev().score;

        let md = if use_l2_norm {
            f64::powi(abs(prev - curr) as f64, 2)
        } else {
            abs(prev - curr)
        };

        s.global_update(&max_diff, md);
        Step::Continue
    });

    let step5 = Job::Check(Box::new(move |state| {
        let max_diff_val = state.read(&max_diff);
        let cont = if use_l2_norm {
            let sum_d = f64::sqrt(max_diff_val as f64);
            (sum_d as f64) > tol * n as f64
        } else {
            (max_diff_val as f64) > tol * n as f64
        };
        if cont {
            Step::Continue
        } else {
            Step::Done
        }
    }));

    let mut runner: TaskRunner<G, _> = TaskRunner::new(ctx);

    let num_vertices = g.num_vertices();

    let out: HashMap<LocalVertexRef, f64> = runner.run(
        vec![Job::new(step1)],
        vec![Job::new(step2), Job::new(step3), Job::new(step4), step5],
        PageRankState::new(num_vertices),
        |g, _, _, local| {
            local
                .iter()
                .filter_map(|line| {
                    line.as_ref()
                        .map(|(v_ref, state)| (v_ref.clone(), state.score))
                })
                .collect::<HashMap<_, _>>()
        },
        threads,
        iter_count,
        None,
        None,
    );

    out.into_iter()
        .map(|(k, v)| (g.vertex_name(k), v))
        .collect()
}

#[cfg(test)]
mod page_rank_tests {
    use std::borrow::Borrow;

    use itertools::Itertools;
    use pretty_assertions::assert_eq;

    use crate::db::graph::Graph;

    use super::*;

    fn load_graph(n_shards: usize) -> Graph {
        let graph = Graph::new(n_shards);

        let edges = vec![(1, 2), (1, 4), (2, 3), (3, 1), (4, 1)];

        for (src, dst) in edges {
            graph.add_edge(0, src, dst, &vec![], None).unwrap();
        }
        graph
    }

    fn test_page_rank(n_shards: usize) {
        let graph = load_graph(n_shards);

        let results: HashMap<String, f64> = unweighted_page_rank(&graph, 1000, Some(1), None, true)
            .into_iter()
            .collect();

        assert_eq_f64(results.get("1"), Some(&0.38694), 5);
        assert_eq_f64(results.get("2"), Some(&0.20195), 5);
        assert_eq_f64(results.get("4"), Some(&0.20195), 5);
        assert_eq_f64(results.get("3"), Some(&0.20916), 5);
    }

    #[test]
    fn test_page_rank_1() {
        test_page_rank(1);
    }

    #[test]
    fn test_page_rank_2() {
        test_page_rank(2);
    }

    #[test]
    fn test_page_rank_3() {
        test_page_rank(3);
    }

    #[test]
    fn test_page_rank_4() {
        test_page_rank(4);
    }

    #[test]
    fn motif_page_rank() {
        let edges = vec![
            (1, 2, 1),
            (1, 3, 2),
            (1, 4, 3),
            (3, 1, 4),
            (3, 4, 5),
            (3, 5, 6),
            (4, 5, 7),
            (5, 6, 8),
            (5, 8, 9),
            (7, 5, 10),
            (8, 5, 11),
            (1, 9, 12),
            (9, 1, 13),
            (6, 3, 14),
            (4, 8, 15),
            (8, 3, 16),
            (5, 10, 17),
            (10, 5, 18),
            (10, 8, 19),
            (1, 11, 20),
            (11, 1, 21),
            (9, 11, 22),
            (11, 9, 23),
        ];

        let graph = Graph::new(4);

        for (src, dst, t) in edges {
            graph.add_edge(t, src, dst, &vec![], None).unwrap();
        }

        let results: HashMap<String, f64> = unweighted_page_rank(&graph, 1000, Some(4), None, true)
            .into_iter()
            .collect();

        assert_eq_f64(results.get("10"), Some(&0.072082), 5);
        assert_eq_f64(results.get("8"), Some(&0.136473), 5);
        assert_eq_f64(results.get("3"), Some(&0.15484), 5);
        assert_eq_f64(results.get("6"), Some(&0.07208), 5);
        assert_eq_f64(results.get("11"), Some(&0.06186), 5);
        assert_eq_f64(results.get("2"), Some(&0.03557), 5);
        assert_eq_f64(results.get("1"), Some(&0.11284), 5);
        assert_eq_f64(results.get("4"), Some(&0.07944), 5);
        assert_eq_f64(results.get("7"), Some(&0.01638), 5);
        assert_eq_f64(results.get("9"), Some(&0.06186), 5);
        assert_eq_f64(results.get("5"), Some(&0.19658), 5);
    }

    #[test]
    fn two_nodes_page_rank() {
        let edges = vec![(1, 2), (2, 1)];

        let graph = Graph::new(4);

        for (t, (src, dst)) in edges.into_iter().enumerate() {
            graph.add_edge(t as i64, src, dst, &vec![], None).unwrap();
        }

        let results: HashMap<String, f64> = unweighted_page_rank(&graph, 1000, Some(4), None, false)
            .into_iter()
            .collect();

        assert_eq_f64(results.get("1"), Some(&0.5), 3);
        assert_eq_f64(results.get("2"), Some(&0.5), 3);
    }

    #[test]
    fn three_nodes_page_rank_one_dangling() {
        let edges = vec![(1, 2), (2, 1), (2, 3)];

        let graph = Graph::new(4);

        for (t, (src, dst)) in edges.into_iter().enumerate() {
            graph.add_edge(t as i64, src, dst, &vec![], None).unwrap();
        }

        let results: HashMap<String, f64> = unweighted_page_rank(&graph, 10, Some(4), None, false)
            .into_iter()
            .collect();

        assert_eq_f64(results.get("1"), Some(&0.303), 3);
        assert_eq_f64(results.get("2"), Some(&0.393), 3);
        assert_eq_f64(results.get("3"), Some(&0.303), 3);
    }

    #[test]
    fn dangling_page_rank() {
        let edges = vec![
            (1, 2),
            (1, 3),
            (2, 3),
            (3, 1),
            (3, 2),
            (3, 4),
            // dangling from here
            (4, 5),
            (5, 6),
            (6, 7),
            (7, 8),
            (8, 9),
            (9, 10),
            (10, 11),
        ]
        .into_iter()
        .enumerate()
        .map(|(t, (src, dst))| (src, dst, t as i64))
        .collect_vec();

        let graph = Graph::new(4);

        for (src, dst, t) in edges {
            graph.add_edge(t, src, dst, &vec![], None).unwrap();
        }

        let results: HashMap<String, f64> = unweighted_page_rank(&graph, 1000, Some(4), None, true)
            .into_iter()
            .collect();

        assert_eq_f64(results.get("1"), Some(&0.055), 3);
        assert_eq_f64(results.get("2"), Some(&0.079), 3);
        assert_eq_f64(results.get("3"), Some(&0.113), 3);
        assert_eq_f64(results.get("4"), Some(&0.055), 3);
        assert_eq_f64(results.get("5"), Some(&0.070), 3);
        assert_eq_f64(results.get("6"), Some(&0.083), 3);
        assert_eq_f64(results.get("7"), Some(&0.093), 3);
        assert_eq_f64(results.get("8"), Some(&0.102), 3);
        assert_eq_f64(results.get("9"), Some(&0.110), 3);
        assert_eq_f64(results.get("10"), Some(&0.117), 3);
        assert_eq_f64(results.get("11"), Some(&0.122), 3);
    }

    fn assert_eq_f64<T: Borrow<f64> + PartialEq + std::fmt::Debug>(
        a: Option<T>,
        b: Option<T>,
        decimals: u8,
    ) {
        if a.is_none() || b.is_none() {
            assert_eq!(a, b);
        } else {
            let factor = 10.0_f64.powi(decimals as i32);
            match (a, b) {
                (Some(a), Some(b)) => {
                    let left = (a.borrow() * factor).round();
                    let right = (b.borrow() * factor).round();
                    assert_eq!(
                        left,
                        right,
                    );
                }
                _ => unreachable!(),
            }
        }
    }
}