summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/generic/pgf/graphdrawing/lua/pgf/gd/doc/ogdf/energybased/SpringEmbedderFR.lua
blob: ae3cf9c8ef8ea9352257e9c8ebbed3bf580addb7 (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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
-- 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           "SpringEmbedderFR"
summary       "The spring-embedder layout algorithm by Fruchterman and Reingold."

documentation [[
  The implementation used in SpringEmbedderFR is based on the following
  publication:

  Thomas M. J. Fruchterman, Edward M. Reingold: \emph{Graph Drawing by Force-directed
  Placement}. Software - Practice and Experience 21(11), pp. 1129--1164, 1991.
]]
--------------------------------------------------------------------------------


--------------------------------------------------------------------------------
key           "SpringEmbedderFR.iterations"
summary       "Sets the number of iterations."
--------------------------------------------------------------------------------


--------------------------------------------------------------------------------
key           "SpringEmbedderFR.noise"
summary       "Sets the parameter noise."
--------------------------------------------------------------------------------


--------------------------------------------------------------------------------
key           "SpringEmbedderFR.scaleFunctionFactor"
summary       "Sets the scale function factor."
--------------------------------------------------------------------------------


-- Local Variables:
-- mode:latex
-- End: