summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/layered/CoffmanGrahamRanking.lua
blob: fd13e9bd4b31d819f0ba419252bd69f4d00977df (plain)
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
-- Copyright 2013 by Till Tantau
--
-- This file may be distributed an/or modified
--
-- 1. under the LaTeX Project Public License and/or
-- 2. under the GNU Public License
--
-- See the file doc/generic/pgf/licenses/LICENSE for more information

-- @release $Header$


local key           = require 'pgf.gd.doc'.key
local documentation = require 'pgf.gd.doc'.documentation
local summary       = require 'pgf.gd.doc'.summary
local example       = require 'pgf.gd.doc'.example


--------------------------------------------------------------------
key           "CoffmanGrahamRanking"
summary       "The ranking algorithm due to Coffman and Graham."
documentation
[[
|CoffmanGrahamRanking| implements a node ranking algorithm 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.
]]
--------------------------------------------------------------------


--------------------------------------------------------------------
key          "CoffmanGrahamRanking.width"
summary      "A mysterious width parameter..."
--------------------------------------------------------------------