fa2 0.3.0

Rust implementation of the Force Atlas 2 graph layout algorithm.
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

use crate::settings::FA2Settings;
use crate::traits::Float;

#[allow(clippy::too_many_arguments)]
#[inline]
pub fn apply_nodewise_forces<F: Float>(
    settings: &FA2Settings<F>,
    x: &mut F,
    y: &mut F,
    m: F,
    delta_x: F,
    delta_y: F,
    old_delta_x: F,
    old_delta_y: F,
    convergence: &mut F,
) -> F {
    let two = F::from(2.0).unwrap();

    let mut swinging =
        m * ((old_delta_x - delta_x).powi(2) + (old_delta_y - delta_y).powi(2)).sqrt();

    swinging = F::one() + swinging.sqrt();

    let traction = ((old_delta_x + delta_x).powi(2) + (old_delta_y + delta_y).powi(2)).sqrt() / two;

    let mut speed = *convergence * traction.ln_1p() / swinging;

    // Updating convergence
    *convergence = (speed * ((delta_x.powi(2) + delta_y.powi(2)) / swinging))
        .sqrt()
        .min(F::one());

    speed /= settings.slow_down;

    // Updating node position
    let new_x = *x + delta_x * speed;
    let new_y = *y + delta_y * speed;

    let movement = (*x - new_x).abs() + (*y - new_y).abs();

    *x = new_x;
    *y = new_y;

    movement
}

#[allow(clippy::too_many_arguments)]
#[inline]
pub fn apply_forces<F: Float>(
    settings: &FA2Settings<F>,
    xs: &mut [F],
    ys: &mut [F],
    ms: &[F],
    delta_xs: &[F],
    delta_ys: &[F],
    old_delta_xs: &[F],
    old_delta_ys: &[F],
    convergences: &mut [F],
) -> F {
    let mut total_movement = F::zero();

    for (i, convergence) in convergences.iter_mut().enumerate() {
        let x = &mut xs[i];
        let y = &mut ys[i];
        let m = ms[i];

        let delta_x = delta_xs[i];
        let delta_y = delta_ys[i];

        let old_delta_x = old_delta_xs[i];
        let old_delta_y = old_delta_ys[i];

        total_movement += apply_nodewise_forces(
            settings,
            x,
            y,
            m,
            delta_x,
            delta_y,
            old_delta_x,
            old_delta_y,
            convergence,
        );
    }

    total_movement
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_apply_forces() {
        let settings = FA2Settings::<f32>::default();

        let mut xs = [1.0, 2.0];
        let mut ys = [3.0, -5.0];
        let ms = [1.0, 1.5];
        let delta_xs = [1.0, -4.0];
        let delta_ys = [2.0, -5.0];
        let mut convergences = [1.0, 1.0];

        let total_movement = apply_forces(
            &settings,
            &mut xs,
            &mut ys,
            &ms,
            &delta_xs,
            &delta_ys,
            &[0.0, 0.0],
            &[0.0, 0.0],
            &mut convergences,
        );

        assert_eq!(total_movement, 4.0539246);
        assert_eq!(xs, [1.3007548, 0.599262]);
        assert_eq!(ys, [3.6015096, -6.750922]);
        assert_eq!(convergences, [0.776293, 1.0]);
    }
}