Skip to content

Commit d520c5f

Browse files
committed
Improve/cleanup references
1 parent 69cf10f commit d520c5f

File tree

5 files changed

+13
-26
lines changed

5 files changed

+13
-26
lines changed

src/buchheim.jl

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ export Buchheim, buchheim
66
buchheim(adj_matrix; kwargs...)
77
buchheim(adj_list; kwargs...)
88
9-
Using the algorithm proposed in the paper,
10-
["Improving Walker's Algorithm to Run in Linear Time"](http://dirk.jivas.de/papers/buchheim02improving.pdf)
11-
by Christoph Buchheim, Michael Junger, Sebastian Leipert
9+
Using the algorithm proposed by Buchheim, Junger and Leipert (2002,
10+
[doi 10.1007/3-540-36151-0_32](https://doi.org/10.1007/3-540-36151-0_32)).
1211
1312
Takes adjacency matrix or list representation of given tree
1413
and returns coordinates of the nodes.

src/sfdp.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ export SFDP, sfdp
44
SFDP(; kwargs...)(adj_matrix)
55
sfdp(adj_matrix; kwargs...)
66
7-
Using the Spring-Electric [model suggested by Yifan Hu](http://yifanhu.net/PUB/graph_draw_small.pdf).
7+
Using the Spring-Electric model suggested by Hu (2005, The Mathematica Journal,
8+
[pdf](http://yifanhu.net/PUB/graph_draw_small.pdf)).
9+
810
Forces are calculated as:
911
1012
f_attr(i,j) = ‖xi - xj‖ ² / K , i<->j

src/spectral.jl

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ export Spectral, spectral
66
Spectral(; kwargs...)(adj_matrix)
77
spectral(adj_matrix; kwargs...)
88
9-
This algorithm uses the technique of Spectral Graph Drawing, which is an
10-
under-appreciated method of graph layouts; easier, simpler, and faster than the
11-
more common spring-based methods. For reference see [Yehuda Koren,
12-
2002](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.3.2055&rep=rep1&type=pdf).
9+
This algorithm uses the technique of Spectral Graph Drawing.
10+
For reference see Koren (2003,
11+
[doi 10.1007/3-540-45071-8_50](https://doi.org/10.1007/3-540-45071-8_50)).
1312
1413
Takes adjacency matrix representation of a network and returns coordinates of
1514
the nodes.

src/spring.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ export Spring, spring
44
Spring(; kwargs...)(adj_matrix)
55
spring(adj_matrix; kwargs...)
66
7-
Use the spring/repulsion model of Fruchterman and Reingold (1991) with
7+
Use the spring/repulsion model of Fruchterman and Reingold (1991,
8+
[doi 10.1002/spe.4380211102](https://doi.org/10.1002/spe.4380211102)) with
89
910
- Attractive force: `f_a(d) = d^2 / k`
1011
- Repulsive force: `f_r(d) = -k^2 / d`

src/stress.jl

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ export Stress, stress
1010
Compute graph layout using stress majorization. Takes adjacency matrix
1111
representation of a network and returns coordinates of the nodes.
1212
13+
The main equation to solve is (8) in Gansner, Koren and North (2005,
14+
[doi 10.1007/978-3-540-31843-9_25](https://doi.org/10.1007/978-3-540-31843-9_25)).
15+
1316
## Inputs:
1417
- `adj_matrix`: Matrix of pairwise distances.
1518
@@ -51,23 +54,6 @@ representation of a network and returns coordinates of the nodes.
5154
- `(true, false, false)` : only pin certain coordinates
5255
5356
- `seed=1`: Seed for random initial positions.
54-
55-
## Reference:
56-
The main equation to solve is (8) of:
57-
58-
@incollection{
59-
author = {Emden R Gansner and Yehuda Koren and Stephen North},
60-
title = {Graph Drawing by Stress Majorization}
61-
year={2005},
62-
isbn={978-3-540-24528-5},
63-
booktitle={Graph Drawing},
64-
seriesvolume={3383},
65-
series={Lecture Notes in Computer Science},
66-
editor={Pach, J\'anos},
67-
doi={10.1007/978-3-540-31843-9_25},
68-
publisher={Springer Berlin Heidelberg},
69-
pages={239--250},
70-
}
7157
"""
7258
@addcall struct Stress{Dim,Ptype,IT<:Union{Symbol,Int},FT<:AbstractFloat,M<:AbstractMatrix} <:
7359
IterativeLayout{Dim,Ptype}

0 commit comments

Comments
 (0)