summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/ControlIteration.lua
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/ControlIteration.lua')
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/ControlIteration.lua134
1 files changed, 71 insertions, 63 deletions
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/ControlIteration.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/ControlIteration.lua
index b8d96630cdf..b845d9d1f89 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/ControlIteration.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/force/ControlIteration.lua
@@ -30,34 +30,38 @@ declare {
type = "number",
initial = "500",
- summary = [["
- Limits the number of iterations of algorithms for force-based
- layouts to \meta{number}.
+ summary = [["
+ Limits the number of iterations of algorithms for force-based
+ layouts to \meta{number}.
+ "]],
+ documentation = [["
+ Depending on the characteristics of the input graph and the parameters
+ chosen for the algorithm, minimizing the system energy may require
+ many iterations.
+
+ In these situations it may come in handy to limit the number of
+ iterations. This feature can also be useful to draw the same graph
+ after different iterations and thereby demonstrate how the spring or
+ spring-electrical algorithm improves the drawing step by step.
+
+ The examples shows two drawings generated using two
+ different |iteration| limits.
"]],
- documentation = [["
- Depending on the characteristics of the input graph and the parameters
- chosen for the algorithm, minimizing the system energy may require
- many iterations.
-
- In these situations it may come in handy to limit the number of
- iterations. This feature can also be useful to draw the same graph
- after different iterations and thereby demonstrate how the spring or
- spring-electrical algorithm improves the drawing step by step.
-
- The examples shows two drawings generated using two
- different |iteration| limits.
- "]],
- examples = {[["
- \tikz \graph [spring layout, iterations=10] { subgraph K_n [n=4] };
- "]],[["
- \tikz \graph [spring layout, iterations=500] { subgraph K_n [n=4] };
- "]],[["
- \tikz \graph [spring electrical layout, iterations=10]
- { subgraph K_n [n=4] };
- "]],[["
- \tikz \graph [spring electrical layout, iterations=500]
- { subgraph K_n [n=4] };
- "]]
+ examples = {
+ [["
+ \tikz \graph [spring layout, iterations=10] { subgraph K_n [n=4] };
+ "]],
+ [["
+ \tikz \graph [spring layout, iterations=500] { subgraph K_n [n=4] };
+ "]],
+ [["
+ \tikz \graph [spring electrical layout, iterations=10]
+ { subgraph K_n [n=4] };
+ "]],
+ [["
+ \tikz \graph [spring electrical layout, iterations=500]
+ { subgraph K_n [n=4] };
+ "]]
}
}
@@ -68,11 +72,11 @@ declare {
type = "length",
initial = "0",
- summary = [["
- This parameter specifies the amount by which nodes will be
- displaced in each iteration, initially. If set to |0| (which is the
- default), an appropriate value is computed automatically.
- "]]
+ summary = [["
+ This parameter specifies the amount by which nodes will be
+ displaced in each iteration, initially. If set to |0| (which is the
+ default), an appropriate value is computed automatically.
+ "]]
}
---
@@ -82,28 +86,30 @@ declare {
type = "number",
initial = "0.95",
- summary = [["
- This parameter helps in controlling how layouts evolve over
- time. It is used to gradually reduce the step size
- between one iteration to the next.
+ summary = [["
+ This parameter helps in controlling how layouts evolve over
+ time. It is used to gradually reduce the step size
+ between one iteration to the next.
"]],
documentation = [["
- A small positive cooling factor
- $\ge 0$ means that the movement of nodes is quickly or abruptly
- reduced, while a large cooling factor $\le 1$ allows for a smoother
- step by step layout refinement at the cost of more iterations. The
- following example demonstrates how a smaller cooling factor may
- result in a less balanced drawing. By default, Hu2006 spring,
- Hu2006 spring electrical, and Walshaw2000 spring electrical use a
- cooling factor of |0.95|.
+ A small positive cooling factor
+ $\ge 0$ means that the movement of nodes is quickly or abruptly
+ reduced, while a large cooling factor $\le 1$ allows for a smoother
+ step by step layout refinement at the cost of more iterations. The
+ following example demonstrates how a smaller cooling factor may
+ result in a less balanced drawing. By default, Hu2006 spring,
+ Hu2006 spring electrical, and Walshaw2000 spring electrical use a
+ cooling factor of |0.95|.
"]],
- examples = {[["
- \tikz \graph [spring layout, cooling factor=0.1]
- { a -> b -> c -> a };
- "]],[["
- \tikz \graph [spring layout, cooling factor=0.5]
- { a -> b -> c -> a };
- "]]
+ examples = {
+ [["
+ \tikz \graph [spring layout, cooling factor=0.1]
+ { a -> b -> c -> a };
+ "]],
+ [["
+ \tikz \graph [spring layout, cooling factor=0.5]
+ { a -> b -> c -> a };
+ "]]
}
}
@@ -114,19 +120,21 @@ declare {
type = "number",
initial = "0.01",
- summary = [["
- All spring and spring-electrical algorithms implemented in the
- thesis terminate as soon as the maximum movement of any node drops
- below $k \cdot \meta{tolerance}$. This tolerance factor can be changed
- with the convergence tolerance option:
+ summary = [["
+ All spring and spring-electrical algorithms implemented in the
+ thesis terminate as soon as the maximum movement of any node drops
+ below $k \cdot \meta{tolerance}$. This tolerance factor can be changed
+ with the convergence tolerance option:
"]],
- examples = {[["
- \tikz \graph [spring layout, convergence tolerance=0.001]
- { { [clique] 1, 2 } -- 3 -- 4 -- { 5, 6, 7 } };
- "]],[["
- \tikz \graph [spring layout, convergence tolerance=1.0]
- { { [clique] 1, 2 } -- 3 -- 4 -- { 5, 6, 7 } };
- "]]
+ examples = {
+ [["
+ \tikz \graph [spring layout, convergence tolerance=0.001]
+ { { [clique] 1, 2 } -- 3 -- 4 -- { 5, 6, 7 } };
+ "]],
+ [["
+ \tikz \graph [spring layout, convergence tolerance=1.0]
+ { { [clique] 1, 2 } -- 3 -- 4 -- { 5, 6, 7 } };
+ "]]
}
}