forceatlas2 0.8.0

fast force-directed generic n-dimension graph layout
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

//! Traits and implementations about the forces used in the layout.
//!
//! You typically do not need to use this directly.

pub(crate) mod attraction;
pub(crate) mod gravity;
pub(crate) mod repulsion;

use crate::{edge::*, layout::*, node::*, util::*};

/// Attraction force, that pulls neighbors together
pub trait Attraction<T: Coord, const N: usize, E, O, Id> {
	/// Select an implementation depending on the settings
	fn choose_attraction(settings: &Settings<T>) -> fn(&mut Layout<T, N, E, O, Id>);
}

/// Gravity force, that pulls every node to the center
pub trait Gravity<T: Coord, const N: usize, E, O, Id> {
	/// Select an implementation depending on the settings
	fn choose_gravity(settings: &Settings<T>) -> fn(&mut Layout<T, N, E, O, Id>);
}

/// Repulsion force, that makes every node repell each other
pub trait Repulsion<T: Coord, const N: usize, E, O, Id> {
	/// Select an implementation depending on the settings
	fn choose_repulsion(settings: &Settings<T>) -> fn(&mut Layout<T, N, E, O, Id>);
}

impl<T: Coord, const N: usize, E: Edges<T, Id>, O: Nodes<T, N, Id>, Id> Attraction<T, N, E, O, Id>
	for Layout<T, N, E, O, Id>
{
	#[allow(clippy::collapsible_else_if)]
	fn choose_attraction(settings: &Settings<T>) -> fn(&mut Layout<T, N, E, O, Id>) {
		if settings.prevent_overlapping.is_some() {
			if settings.lin_log {
				attraction::apply_attraction_log_po
			} else {
				attraction::apply_attraction_po
			}
		} else {
			if settings.lin_log {
				attraction::apply_attraction_log
			} else {
				attraction::apply_attraction
			}
		}
	}
}

impl<T: Coord + Send + Sync, const N: usize, E, O: Nodes<T, N, Id>, Id: Sync>
	Gravity<T, N, E, O, Id> for Layout<T, N, E, O, Id>
{
	fn choose_gravity(settings: &Settings<T>) -> fn(&mut Layout<T, N, E, O, Id>) {
		if settings.kg.is_zero() {
			return |_| {};
		}
		if settings.strong_gravity {
			gravity::apply_gravity_sg
		} else {
			gravity::apply_gravity
		}
	}
}

impl<T: Coord + Send + Sync, E, O: Nodes<T, 2, Id>, Id: Sync> Repulsion<T, 2, E, O, Id>
	for Layout<T, 2, E, O, Id>
{
	fn choose_repulsion(settings: &Settings<T>) -> fn(&mut Layout<T, 2, E, O, Id>) {
		if settings.prevent_overlapping.is_some() {
			repulsion::apply_repulsion_2d_po
		} else {
			repulsion::apply_repulsion_2d
		}
	}
}

impl<T: Coord + Send + Sync, E, O: Nodes<T, 3, Id>, Id: Sync> Repulsion<T, 3, E, O, Id>
	for Layout<T, 3, E, O, Id>
{
	fn choose_repulsion(settings: &Settings<T>) -> fn(&mut Layout<T, 3, E, O, Id>) {
		if settings.prevent_overlapping.is_some() {
			repulsion::apply_repulsion_3d_po
		} else {
			repulsion::apply_repulsion_3d
		}
	}
}