summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/jedi/doc.lua
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/jedi/doc.lua')
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/jedi/doc.lua164
1 files changed, 89 insertions, 75 deletions
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/jedi/doc.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/jedi/doc.lua
index 620c035d523..19baca73336 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/jedi/doc.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/jedi/doc.lua
@@ -19,17 +19,17 @@ key "maximum step"
summary
[[
-This option determines the maximum ditance every vertex is allowed to travel
-in one iteration.
+This option determines the maximum distance every vertex is allowed to travel
+in one iteration.
]]
documentation
[[
-No matter how large the forces influencing a vertex, the effect
-on the drawing should be limited to avoid vertices "jumping" from one side of
-the canvas to each other due to a strong force pulling them further than their
-ideal destination. The amount of space a vertex is allowed to travel in one
-iteration is limited by the \lstinline{maximum step} parameter. It is $5000$
+No matter how large the forces influencing a vertex, the effect
+on the drawing should be limited to avoid vertices "jumping" from one side of
+the canvas to each other due to a strong force pulling them further than their
+ideal destination. The amount of space a vertex is allowed to travel in one
+iteration is limited by the \lstinline{maximum step} parameter. It is $5000$
by default. That means by default, this parameter should not get in your way.
]]
@@ -40,7 +40,7 @@ example
\graph[social degree layout, iterations = 2, maximum time = 2, maximum step = 6pt, coarsen = false]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
example
@@ -49,7 +49,7 @@ example
\graph[social degree layout, iterations = 2, maximum time = 2, maximum step = 12pt, coarsen = false]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
--------------------------------------------------------------------
@@ -61,13 +61,15 @@ example
key "speed"
summary
-[[ This is a factor every calculated step is multiplied by.]]
+[[
+This is a factor every calculated step is multiplied by.
+]]
documentation
[[
The speed is the distance a vertex travels if it is influenced by a force of
-$1$N$\cdot\gamma$. The speed is only a factor that will influence the total
-amount every vertex can move: Half the speed makes half the movement, twice
+$1$N$\cdot\gamma$. The speed is only a factor that will influence the total
+amount every vertex can move: Half the speed makes half the movement, twice
the speed doubles the distance traveled.
]]
@@ -77,7 +79,7 @@ example
\graph[social degree layout, iterations = 1, maximum time = 1, maximum step = 100, speed = 0.2, coarsen = false]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
example
@@ -86,7 +88,7 @@ example
\graph[social degree layout, iterations = 1, maximum time= 1, maximum step = 100, speed = 0.4, coarsen = false]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
--------------------------------------------------------------------
@@ -96,17 +98,19 @@ example
key "maximum time"
summary
-[[ The highest amount of virtual time the algorithm is allowed to take.]]
+[[
+The highest amount of virtual time the algorithm is allowed to take.
+]]
documentation
[[
-This option is part of the virtual time construct of Jedi. The virtual time
-concept allows graph drawing algorithm engineers to switch forces on and of
-after a relative or absolute amount of time has elapsed. If the iterations
-stay the same, doubling the maximum time has the same effect as doubling the
-speed: Vertices move faster, but it is possible they miss their intended
-destination. Also increasing the iterations changes the "resolution" of the
-graph drawing algorithm: More steps are simulated in the same time.
+This option is part of the virtual time construct of Jedi. The virtual time
+concept allows graph drawing algorithm engineers to switch forces on and of
+after a relative or absolute amount of time has elapsed. If the iterations
+stay the same, doubling the maximum time has the same effect as doubling the
+speed: Vertices move faster, but it is possible they miss their intended
+destination. Also increasing the iterations changes the "resolution" of the
+graph drawing algorithm: More steps are simulated in the same time.
]]
example
@@ -115,7 +119,7 @@ example
\graph[social degree layout, iterations = 20, maximum time = 100, coarsen = false, maximum step = 0.5, gravity = 2]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
example
@@ -124,29 +128,31 @@ example
\graph[social degree layout, iterations = 20, maximum time = 200, coarsen = false, maximum step = 0.5, gravity = 2]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
--------------------------------------------------------------------
-
+
--------------------------------------------------------------------
key "find equilibrium"
summary
-[[ If this option is |true|, the framework checks the vertex movment to detect
-low movement near the equilibrium and stop the algorithm]]
+[[
+If this option is |true|, the framework checks the vertex movement to detect
+low movement near the equilibrium and stop the algorithm.
+]]
documentation
[[
-Since we often do not know how many iterations are enough, the framework will
-detect when the vertices (almost) stop moving and stop the algorithm. After
-each iteration, the framework adds up the net force influencing all the
-vertices. If it falls below the threshold |epsilon|, the algorithm
-will ignore the left over iterations and terminate. You can disable this
-behavior by setting this parameter to |false|. Allowing the framework to find
-the equilibrium usually saves you time, while allowing more iterations (or a
- lower threshold) generates higher quality drawings.
+Since we often do not know how many iterations are enough, the framework will
+detect when the vertices (almost) stop moving and stop the algorithm. After
+each iteration, the framework adds up the net force influencing all the
+vertices. If it falls below the threshold |epsilon|, the algorithm
+will ignore the left over iterations and terminate. You can disable this
+behavior by setting this parameter to |false|. Allowing the framework to find
+the equilibrium usually saves you time, while allowing more iterations (or a
+lower threshold) generates higher quality drawings.
]]
example
@@ -155,7 +161,7 @@ example
\graph[social degree layout, iterations = 300, maximum time = 300, coarsen = false, maximum step = 10, epsilon = 10]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
example
@@ -164,7 +170,7 @@ example
\graph[social degree layout, iterations = 300, maximum time = 300, maximum step = 10, find equilibrium = false]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
--------------------------------------------------------------------
@@ -174,13 +180,15 @@ example
key "epsilon"
summary
-[[ The threshold for the |find equilibrium| option.]]
+[[
+The threshold for the |find equilibrium| option.
+]]
documentation
[[
-This key specifies the threshold for the |find equilibrium| option. The lower
-epsilon, the longer the graph drawing algorithm will take, but the closer the
-resulting drawing will be to the true energy minimum.
+This key specifies the threshold for the |find equilibrium| option. The lower
+epsilon, the longer the graph drawing algorithm will take, but the closer the
+resulting drawing will be to the true energy minimum.
]]
example
@@ -189,7 +197,7 @@ example
\graph[social degree layout, iterations = 200, maximum time = 200, maximum step = 10, coarsen = false, epsilon = 2]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
example
@@ -198,7 +206,7 @@ example
\graph[social degree layout, iterations = 200, maximum time = 200, maximum step = 10, epsilon = 12, coarsen = false]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
--------------------------------------------------------------------
@@ -208,15 +216,17 @@ example
key "snap to grid"
summary
-[[ This option enables the post-processing step |snap to grid|.]]
+[[
+This option enables the post-processing step |snap to grid|.
+]]
documentation
[[
-This key is the on/off-switch for the grid forces. The |snap to grid| option
-triggers a form of post-processing were all vertices are pulled to the closest
-point on a virtual grid. Please note that there is no repulsive force between
-the vertices, so it is possible that two vertices are pulled to the same grid
-point. The grid size is determined by the parameters |grid x length| and
+This key is the on/off-switch for the grid forces. The |snap to grid| option
+triggers a form of post-processing were all vertices are pulled to the closest
+point on a virtual grid. Please note that there is no repulsive force between
+the vertices, so it is possible that two vertices are pulled to the same grid
+point. The grid size is determined by the parameters |grid x length| and
|grid y length|.
]]
@@ -226,7 +236,7 @@ example
\graph[social degree layout, iterations = 100, maximum time = 100, maximum step = 10]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
example
@@ -235,7 +245,7 @@ example
\graph[social degree layout, iterations = 100, maximum time = 100, snap to grid =true, grid x length = 5mm, grid y length = 5mm, maximum step = 10]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
--------------------------------------------------------------------
@@ -245,13 +255,15 @@ example
key "grid x length"
summary
-[[ This option determines the cell size in $x$ direction for the |snap to grid|
-option.]]
+[[
+This option determines the cell size in $x$ direction for the |snap to grid|
+option.
+]]
documentation
[[
-The size of the cells of the virtual grid can be configured by the user. This
-key allows a configuration of the horizontal cell width.
+The size of the cells of the virtual grid can be configured by the user. This
+key allows a configuration of the horizontal cell width.
]]
example
@@ -260,7 +272,7 @@ example
\graph[social degree layout, iterations = 100, maximum time = 100, snap to grid =true, grid x length = 5mm, grid y length = 5mm, maximum step = 10]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
example
@@ -269,7 +281,7 @@ example
\graph[social degree layout, iterations = 100, maximum time = 100, snap to grid =true, grid x length = 9mm, grid y length = 5mm, maximum step = 10]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
--------------------------------------------------------------------
@@ -279,8 +291,10 @@ example
key "grid y length"
summary
-[[ This option determines the cell size in $x$ direction for the |snap to grid|
-option.]]
+[[
+This option determines the cell size in $x$ direction for the |snap to grid|
+option.
+]]
documentation
[[
@@ -293,7 +307,7 @@ example
\graph[social degree layout, iterations = 100, maximum time = 100, snap to grid =true, grid x length = 5mm, grid y length = 5mm, maximum step = 10]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
example
@@ -302,7 +316,7 @@ example
\graph[social degree layout, iterations = 100, maximum time = 100, snap to grid =true, grid x length = 5mm, grid y length = 9mm, maximum step = 10]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
--------------------------------------------------------------------
@@ -312,18 +326,18 @@ key "mass"
summary
[[
- The mass of a vertex determines how fast it can move. Vertices
- with higher mass move slower.
+ The mass of a vertex determines how fast it can move. Vertices
+ with higher mass move slower.
]]
documentation
[[
- The mass of a vertex determines how fast this vertex
- moves. Mass is directly inverse proportional to the distance the vertex
- moves. In contrast to the global speed factor, mass usually only affects a
- single vertex. A vertex with a higher mass will move slower if affected by
- the same mass than a vertex with a lower mass. By default, each vertex has a
- mass of $1$.
+ The mass of a vertex determines how fast this vertex
+ moves. Mass is directly inverse proportional to the distance the vertex
+ moves. In contrast to the global speed factor, mass usually only affects a
+ single vertex. A vertex with a higher mass will move slower if affected by
+ the same mass than a vertex with a lower mass. By default, each vertex has a
+ mass of $1$.
]]
example
@@ -332,7 +346,7 @@ example
\graph[social degree layout, iterations = 100, maximum time = 100, maximum displacement per step = 10]{
a1 -- {a2, a3, a4, a5},
b1 -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
example
@@ -341,7 +355,7 @@ example
\graph[social degree layout, iterations = 100, maximum time = 100, maximum displacement per step = 10]{
a1 -- {a2, a3, a4, a5},
b1[mass = 4] -- {b2 -- {b3, b4}, b5}
- };
+ };
]]
--------------------------------------------------------------------
@@ -351,13 +365,13 @@ key "coarsening weight"
summary
[[
- The coarsening weight of a vertex determines when it will be
- coarsened.
+ The coarsening weight of a vertex determines when it will be
+ coarsened.
]]
documentation
[[
- Vertices with higher coarsening weight are considered more important and
- will be coarsened later, or not at all.
+ Vertices with higher coarsening weight are considered more important and
+ will be coarsened later, or not at all.
]]
--------------------------------------------------------------------