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
use std::collections::HashMap;
use std::default::Default;
use std::hash::Hash;

struct Damping(f64);

impl Damping {
    pub fn new(val: u8) -> Result<Damping, String> {
        if val >= 100 {
            return Err("{val} needs to be bellow 100".to_string());
        }

        Ok(Damping(val as f64 / 100_f64))
    }
}

#[derive(Clone)]
struct Edge(usize, usize);

#[derive(Clone)]
pub struct Node<T>
where
    T: Eq + Hash + Clone,
{
    id: T,
    /// List of links (the ids which are edges in `nodes`)
    incoming_edges: Vec<Edge>,
    /// Number of out links
    outgoing_edges: usize,
    score: f64,
}

impl<T> Node<T>
where
    T: Eq + Hash + Clone,
{
    pub fn id(&self) -> &T {
        &self.id
    }

    pub fn score(&self) -> f64 {
        self.score
    }
}

pub struct Pagerank<T>
where
    T: Eq + Hash + Clone,
{
    damping: Damping,
    nodes: Vec<Node<T>>,
    edges: usize,
    nodes_ids: HashMap<T, usize>,
    nodes_with_inconming_edges: Option<usize>,
    is_calculating: bool,
}

impl<T> Pagerank<T>
where
    T: Eq + Hash + Clone,
{
    pub fn new() -> Pagerank<T> {
        Pagerank::<T> {
            damping: Damping::new(15).unwrap(),
            nodes: Vec::new(),
            edges: 0,
            nodes_ids: HashMap::<T, usize>::new(),
            nodes_with_inconming_edges: None,
            is_calculating: false,
        }
    }

    pub fn set_damping_factor(
        &mut self,
        factor: u8,
    ) -> Result<(), String> {
        self.damping = Damping::new(factor)?;
        Ok(())
    }

    /// Adds an edge between two nodes
    pub fn add_edge(&mut self, source: T, target: T) {
        let source = self.get_node_id(source);
        let target = self.get_node_id(target);
        self._add_edge(Edge(source, target))
    }

    /// Private function to add an edge
    fn _add_edge(&mut self, edge: Edge) {
        self.nodes[edge.0].outgoing_edges += 1;
        self.nodes[edge.1].incoming_edges.push(edge);
        self.edges += 1;
    }

    /// Returns a copy of a node
    pub fn get_node(&mut self, name: T) -> Node<T> {
        let id = self.get_node_id(name);

        self.nodes[id].clone()
    }

    /// Returns the node_id for a given node name
    pub fn get_node_id(&mut self, name: T) -> usize {
        match self.nodes_ids.get(&name) {
            Some(&value) => value,
            _ => {
                let node = Node::<T> {
                    id: name.clone(),
                    incoming_edges: Vec::new(),
                    outgoing_edges: 0,
                    score: 0.15,
                };

                self.nodes.push(node);
                let id = self.nodes.len() - 1;

                self.nodes_ids.insert(name, id);

                id
            }
        }
    }

    /// Calculates PageRank with custom convergence
    pub fn calculate_with_convergence(
        &mut self,
        convergence: f64,
    ) -> i32 {
        let mut iterations = 0;

        loop {
            if self.calculate_step() < convergence {
                break;
            }
            iterations += 1;
        }

        iterations
    }

    /// Calculates pagerank with custom convergence
    pub fn calculate(&mut self) -> i32 {
        self.calculate_with_convergence(0.01)
    }

    /// Return all nodes, sorted by their pagerank
    pub fn nodes(&self) -> Vec<Node<T>> {
        let mut nodes = self.nodes.clone();

        nodes.sort_by(|a, b| b.score.partial_cmp(&a.score).unwrap());

        nodes
    }

    /// Calculates a single iteration of the PageRank
    pub fn calculate_step(&mut self) -> f64 {
        self.is_calculating = true;

        let mut current_iteration = self.nodes.clone();

        let nodes = &self.nodes;

        self.nodes
            .iter()
            .enumerate()
            .map(|(id, n)| {
                let score = n
                    .incoming_edges
                    .iter()
                    .map(|edge| {
                        nodes[edge.0].score
                            / nodes[edge.1].outgoing_edges as f64
                    })
                    .sum::<f64>();

                current_iteration[id].score =
                    self.damping.0 + (1f64 - self.damping.0) * score;
            })
            .for_each(drop);

        let convergence: f64 = self
            .nodes
            .iter()
            .enumerate()
            .map(|(id, n)| {
                let diff = n.score - current_iteration[id].score;
                diff * diff
            })
            .sum();

        self.nodes = current_iteration;

        convergence.sqrt() / self.len_with_incoming_edges() as f64
    }

    /// Len of all edges
    pub fn len_with_incoming_edges(&mut self) -> usize {
        if let Some(n) = self.nodes_with_inconming_edges {
            return n;
        }

        let total: usize = self
            .nodes
            .iter()
            .map(|r| if r.incoming_edges.is_empty() { 0 } else { 1 })
            .sum();

        if self.is_calculating {
            // it is calculating, save to remember the total
            self.nodes_with_inconming_edges = Some(total);
        }

        total
    }

    /// Return the number of vertices/nodes in the current graph
    pub fn len(&self) -> usize {
        self.nodes.len()
    }

    /// Returns the number of edges in the current graph
    pub fn len_edge(&self) -> usize {
        self.edges
    }

    pub fn is_empty(&self) -> bool {
        self.nodes.is_empty()
    }
}

impl<T> Default for Pagerank<T>
where
    T: Eq + Hash + Clone,
{
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use crate::Pagerank;

    #[test]
    fn test_two_nodes_are_created() {
        let mut pr = Pagerank::<&str>::new();
        pr.add_edge("foo", "bar");
        assert_eq!(2, pr.len())
    }

    #[test]
    fn test_links() {
        let mut pr = Pagerank::<&str>::new();
        pr.add_edge("foo", "bar");
        assert_eq!(0, pr.get_node_id("foo"));
        assert_eq!(1, pr.get_node_id("bar"));

        let n1 = pr.get_node("foo");
        let n2 = pr.get_node("bar");

        assert_eq!(0, n1.incoming_edges.len());
        assert_eq!(1, n1.outgoing_edges);
        assert_eq!(1, n2.incoming_edges.len());
        assert_eq!(0, n2.outgoing_edges);
    }

    #[test]
    fn test_default_score() {
        let mut pr = Pagerank::<&str>::new();
        pr.add_edge("foo", "bar");
        pr.add_edge("bar", "foo");
        pr.add_edge("xxx", "bar");
        pr.add_edge("yyy", "xxx");

        assert_eq!(0.15, pr.get_node("foo").score);
        assert_eq!(0.15, pr.get_node("bar").score);
        assert_eq!(0.15, pr.get_node("xxx").score);
        assert_eq!(0.15, pr.get_node("yyy").score);
    }

    #[test]
    fn test_iteration() {
        let mut pr = Pagerank::<&str>::new();
        pr.add_edge("foo", "bar");
        pr.add_edge("bar", "foo");
        pr.add_edge("xxx", "bar");
        pr.add_edge("yyy", "xxx");

        pr.calculate_step();

        assert_eq!(0.27749999999999997, pr.get_node("foo").score);
        assert_eq!(0.405, pr.get_node("bar").score);
        assert_eq!(0.27749999999999997, pr.get_node("xxx").score);
        assert_eq!(0.15, pr.get_node("yyy").score);
    }

    #[test]
    fn test_iterations() {
        let mut pr = Pagerank::<&str>::new();
        pr.add_edge("foo", "bar");
        pr.add_edge("bar", "foo");
        pr.add_edge("xxx", "bar");
        pr.add_edge("yyy", "xxx");

        assert_eq!(true, pr.calculate_step() > pr.calculate_step());
        pr.calculate_step();

        assert_eq!(0.6784874999999999, pr.get_node("foo").score);
        assert_eq!(0.8059875, pr.get_node("bar").score);
        assert_eq!(0.27749999999999997, pr.get_node("xxx").score);
        assert_eq!(0.15, pr.get_node("yyy").score);
    }

    #[test]
    fn test_full_run() {
        let mut pr = Pagerank::<&str>::new();
        pr.add_edge("foo", "bar");
        pr.add_edge("bar", "foo");
        pr.add_edge("xxx", "bar");
        pr.add_edge("yyy", "xxx");

        assert_eq!(16, pr.calculate());

        assert_eq!(1.6152071803888868, pr.get_node("foo").score);
        assert_eq!(1.7427071803888865, pr.get_node("bar").score);
        assert_eq!(0.27749999999999997, pr.get_node("xxx").score);
        assert_eq!(0.15, pr.get_node("yyy").score);
    }
}