summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-04-08 17:23:59 +0000
committerKarl Berry <karl@freefriends.org>2019-04-08 17:23:59 +0000
commit9da8ac113f97e68e91e3a1ef26467f9814eb4312 (patch)
treef36b76c9a982931638dde95501c51072185dec56 /Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered
parente919fa4b004d0ef401808c337d7def5fa259da0f (diff)
pgf revert to previous release (r49607, committed 5jan19)
git-svn-id: svn://tug.org/texlive/trunk@50867 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered')
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/CoffmanGrahamRanking.lua4
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastHierarchyLayout.lua14
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastSimpleHierarchyLayout.lua28
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/GreedyCycleRemoval.lua4
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/LongestPathRanking.lua18
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/OptimalRanking.lua6
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SiftingHeuristic.lua6
-rw-r--r--Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SugiyamaLayout.lua55
8 files changed, 68 insertions, 67 deletions
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/CoffmanGrahamRanking.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/CoffmanGrahamRanking.lua
index fd13e9bd4b3..e2c09f21242 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/CoffmanGrahamRanking.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/CoffmanGrahamRanking.lua
@@ -21,10 +21,10 @@ key "CoffmanGrahamRanking"
summary "The ranking algorithm due to Coffman and Graham."
documentation
[[
-|CoffmanGrahamRanking| implements a node ranking algorithm based on
+|CoffmanGrahamRanking| implements a node ranking algorithmn based on
the Coffman--Graham scheduling algorithm, which can be used as first
phase in |SugiyamaLayout|. The aim of the algorithm is to ensure that
-the height of the ranking (the number of layers) is kept small.
+the height of the ranking (the number of layers) is kept small.
]]
--------------------------------------------------------------------
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastHierarchyLayout.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastHierarchyLayout.lua
index a7baad7e109..4d45270a01f 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastHierarchyLayout.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastHierarchyLayout.lua
@@ -23,21 +23,21 @@ documentation
[[
This class implements a hierarchy layout algorithm, that is, it
layouts hierarchies with a given order of nodes on each
-layer. It is used as a third phase of the Sugiyama algorithm.
+layer. It is used as a third phase of the Sugiyama algorithm.
All edges of the layout will have at most two
bends. Additionally, for each edge having exactly two bends, the
segment between them is drawn vertically. This applies in
particular to the long edges arising in the first phase of the
-Sugiyama algorithm.
+Sugiyama algorithm.
The implementation is based on:
-%
+
\begin{itemize}
- \item
- Christoph Buchheim, Michael Jünger, Sebastian Leipert: A Fast
- Layout Algorithm for k-Level Graphs. \emph{Proc. Graph
- Drawing 2000}, volume 1984 of LNCS, pages 229--240, 2001.
+\item
+ Christoph Buchheim, Michael Jünger, Sebastian Leipert: A Fast
+ Layout Algorithm for k-Level Graphs. \emph{Proc. Graph
+ Drawing 2000}, volumne 1984 of LNCS, pages 229--240, 2001.
\end{itemize}
]]
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastSimpleHierarchyLayout.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastSimpleHierarchyLayout.lua
index 4af6daa6207..719e6035699 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastSimpleHierarchyLayout.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/FastSimpleHierarchyLayout.lua
@@ -24,31 +24,29 @@ documentation
[[
This class implements a hierarchy layout algorithm, that is, it
layouts hierarchies with a given order of nodes on each
-layer. It is used as a third phase of the Sugiyama algorithm.
+layer. It is used as a third phase of the Sugiyama algorithm.
The algorithm runs in three phases:
-%
\begin{enumerate}
- \item Alignment (4x)
- \item Horizontal Compactation (4x)
- \item Balancing
+\item Alignment (4x)
+\item Horizontal Compactation (4x)
+\item Balancing
\end{enumerate}
-%
The alignment and horizontal compactification phases are calculated
downward, upward, left-to-right and right-to-left. The four
-resulting layouts are combined in a balancing step.
+resulting layouts are combined in a balancing step.
Warning: The implementation is known to not always produce a
correct layout. Therefore this Algorithm is for testing purpose
-only.
+only.
The implementation is based on:
-%
+
\begin{itemize}
- \item
- Ulrik Brandes, Boris Köpf: Fast and Simple Horizontal
- Coordinate Assignment. \emph{LNCS} 2002, Volume 2265/2002,
- pp. 33--36
+\item
+ Ulrik Brandes, Boris Köpf: Fast and Simple Horizontal
+ Coordinate Assignment. \emph{LNCS} 2002, Volume 2265/2002,
+ pp. 33--36
\end{itemize}
]]
@@ -64,7 +62,7 @@ example
--------------------------------------------------------------------
key "FastSimpleHierarchyLayout.layerDistance"
-summary "Distance between the centers of nodes of two consecutive layers."
+summary "Distance between the cetners of nodes of two consecutive layers."
documentation
[[
@@ -82,7 +80,7 @@ example
--------------------------------------------------------------------
key "FastSimpleHierarchyLayout.siblingDistance"
-summary "Distance between the centers of nodes of sibling nodes."
+summary "Distance between the cetners of nodes of sibling nodes."
documentation
[[
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/GreedyCycleRemoval.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/GreedyCycleRemoval.lua
index d2f1d8eeeaf..788baece4ff 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/GreedyCycleRemoval.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/GreedyCycleRemoval.lua
@@ -21,7 +21,7 @@ key "GreedyCycleRemoval"
summary "Greedy algorithm for computing a maximal acyclic subgraph."
documentation
[[
- The algorithm applies a greedy heuristic to compute a maximal
- acyclic subgraph and works in linear-time.
+The algorithm applies a greedy heuristic to compute a maximal
+acyclic subgraph and works in linear-time.
]]
--------------------------------------------------------------------
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/LongestPathRanking.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/LongestPathRanking.lua
index 3d98fbe9c6a..e81bb2e1c30 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/LongestPathRanking.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/LongestPathRanking.lua
@@ -21,11 +21,11 @@ key "LongestPathRanking"
summary "The longest-path ranking algorithm."
documentation
[[
- |LongestPathRanking| implements the well-known longest-path ranking
- algorithm, which can be used as first phase in |SugiyamaLayout|. The
- implementation contains a special optimization for reducing edge
- lengths, as well as special treatment of mixed-upward graphs (for
- instance, \textsc{uml} class diagrams).
+|LongestPathRanking| implements the well-known longest-path ranking
+algorithm, which can be used as first phase in |SugiyamaLayout|. The
+implementation contains a special optimization for reducing edge
+lengths, as well as special treatment of mixed-upward graphs (for
+instance, \textsc{uml} class diagrams).
]]
--------------------------------------------------------------------
@@ -47,10 +47,10 @@ summary "If set to true, multi-edges will span at least two layers."
key "LongestPathRanking.optimizeEdgeLength"
summary
[[
- If set to true the ranking algorithm tries to reduce edge
- length even if this might increase the height of the layout. Choose
- false, if the longest-path ranking known from the literature should be
- used.
+If set to true the ranking algorithm tries to reduce edge
+length even if this might increase the height of the layout. Choose
+false, if the longest-path ranking known from the literature should be
+used.
]]
--------------------------------------------------------------------
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/OptimalRanking.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/OptimalRanking.lua
index 25a8dd5262b..64eb7eadd80 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/OptimalRanking.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/OptimalRanking.lua
@@ -21,9 +21,9 @@ key "OptimalRanking"
summary "The optimal ranking algorithm."
documentation
[[
- The |OptimalRanking| implements the LP-based algorithm for
- computing a node ranking with minimal edge lengths, which can
- be used as first phase in |SugiyamaLayout|.
+The |OptimalRanking| implements the LP-based algorithm for
+computing a node ranking with minimal edge lengths, which can
+be used as first phase in |SugiyamaLayout|.
]]
--------------------------------------------------------------------
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SiftingHeuristic.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SiftingHeuristic.lua
index d0815a5b761..f54f0c33462 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SiftingHeuristic.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SiftingHeuristic.lua
@@ -25,10 +25,10 @@ summary "The sifting heuristic for 2-layer crossing minimization."
--------------------------------------------------------------------
key "SiftingHeuristic.strategy"
-summary "Sets a so-called ``sifting strategy''."
+summary "Sets a so-called ``sifting strategy.''"
documentation
[[
- The following values are permissible: |left_to_right|, |desc_degree|,
- and |random|.
+The following values are permissible: |left_to_right|, |desc_degree|,
+and |random|.
]]
--------------------------------------------------------------------
diff --git a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SugiyamaLayout.lua b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SugiyamaLayout.lua
index ab9d9ee77f7..ef68a1db0db 100644
--- a/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SugiyamaLayout.lua
+++ b/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/SugiyamaLayout.lua
@@ -20,18 +20,19 @@ local example = require 'pgf.gd.doc'.example
key "SugiyamaLayout"
summary "The OGDF implementation of the Sugiyama algorithm."
-documentation [[
- This layout represents a customizable implementation of Sugiyama's
- layout algorithm. The implementation used in |SugiyamaLayout| is based
- on the following publications:
-
- \begin{itemize}
- \item Emden R. Gansner, Eleftherios Koutsofios, Stephen
- C. North, Kiem-Phong Vo: A technique for drawing directed
- graphs. \emph{IEEE Trans. Software Eng.} 19(3):214--230, 1993.
- \item Georg Sander: \emph{Layout of compound directed graphs.}
- Technical Report, Universität des Saarlandes, 1996.
- \end{itemize}
+documentation
+[[
+This layout represents a customizable implementation of Sugiyama's
+layout algorithm. The implementation used in |SugiyamaLayout| is based
+on the following publications:
+
+\begin{itemize}
+\item Emden R. Gansner, Eleftherios Koutsofios, Stephen
+ C. North, Kiem-Phong Vo: A technique for drawing directed
+ graphs. \emph{IEEE Trans. Software Eng.} 19(3):214--230, 1993.
+\item Georg Sander: \emph{Layout of compound directed graphs.}
+ Technical Report, Universität des Saarlandes, 1996.
+\end{itemize}
]]
example
@@ -39,14 +40,14 @@ example
\tikz \graph [SugiyamaLayout] { a -- {b,c,d} -- e -- a };
]]
-example
+example
[[
\tikz \graph [SugiyamaLayout, grow=right] {
a -- {b,c,d} -- e -- a
};
]]
-example
+example
[[
\tikz [nodes={text height=.7em, text depth=.2em,
draw=black!20, thick, fill=white, font=\footnotesize},
@@ -67,7 +68,7 @@ example
{ "USG 2.0" -> "USG 3.0", "PWB 2.0", "Unix/TS 1.0" } -> "Unix/TS 3.0";
{ "Unix/TS++", "CB Unix 3", "Unix/TS 3.0" } ->
"TS 4.0" -> "System V.0" -> "System V.2" -> "System V.3";
- };
+ };
]]
--------------------------------------------------------------------------------
@@ -76,10 +77,10 @@ example
--------------------------------------------------------------------------------
key "SugiyamaLayout.runs"
summary "Determines, how many times the crossing minimization is repeated."
-documentation
+documentation
[[
Each repetition (except for the first) starts with
-randomly permuted nodes on each layer. Deterministic behavior can
+randomly permuted nodes on each layer. Deterministic behaviour can
be achieved by setting |SugiyamaLayout.runs| to 1.
]]
--------------------------------------------------------------------------------
@@ -88,11 +89,12 @@ be achieved by setting |SugiyamaLayout.runs| to 1.
--------------------------------------------------------------------------------
key "SugiyamaLayout.transpose"
-documentation [[
- Determines whether the transpose step is performed
- after each 2-layer crossing minimization; this step tries to
- reduce the number of crossings by switching neighbored nodes on
- a layer.
+documentation
+[[
+Determines whether the transpose step is performed
+after each 2-layer crossing minimization; this step tries to
+reduce the number of crossings by switching neighbored nodes on
+a layer.
]]
--------------------------------------------------------------------------------
@@ -100,10 +102,11 @@ documentation [[
--------------------------------------------------------------------------------
key "SugiyamaLayout.fails"
-documentation [[
- The number of times that the number of crossings may
- not decrease after a complete top-down bottom-up traversal,
- before a run is terminated.
+documentation
+[[
+The number of times that the number of crossings may
+not decrease after a complete top-down bottom-up traversal,
+before a run is terminated.
]]
--------------------------------------------------------------------------------