• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. Copyright (C) 2004-2009 The Trustees of Indiana University.
2   Use, modification and distribution is subject to the Boost Software
3   License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
4   http://www.boost.org/LICENSE_1_0.txt)
5
6===========================
7|Logo| Fruchterman Reingold
8===========================
9
10::
11
12    namespace graph { namespace distributed {
13
14      template<typename Graph, typename PositionMap,
15               typename AttractiveForce, typename RepulsiveForce,
16               typename ForcePairs, typename Cooling, typename DisplacementMap>
17      void
18      fruchterman_reingold_force_directed_layout
19      (const Graph&    g,
20       PositionMap     position,
21       typename property_traits<PositionMap>::value_type const& origin,
22       typename property_traits<PositionMap>::value_type const& extent,
23       AttractiveForce attractive_force,
24       RepulsiveForce  repulsive_force,
25       ForcePairs      force_pairs,
26       Cooling         cool,
27       DisplacementMap displacement)
28
29      template<typename Graph, typename PositionMap,
30               typename AttractiveForce, typename RepulsiveForce,
31               typename ForcePairs, typename Cooling, typename DisplacementMap>
32      void
33      fruchterman_reingold_force_directed_layout
34      (const Graph&    g,
35       PositionMap     position,
36       typename property_traits<PositionMap>::value_type const& origin,
37       typename property_traits<PositionMap>::value_type const& extent,
38       AttractiveForce attractive_force,
39       RepulsiveForce  repulsive_force,
40       ForcePairs      force_pairs,
41       Cooling         cool,
42       DisplacementMap displacement,
43       simple_tiling   tiling)
44    } }
45
46.. contents::
47
48Where Defined
49-------------
50<``boost/graph/distributed/fruchterman_reingold.hpp``>
51
52also accessible from
53
54<``boost/graph/fruchterman_reingold.hpp``>
55
56Parameters
57----------
58
59IN:  ``const Graph& g``
60  The graph type must be a model of `Distributed Graph`_.  The graph
61  type must also model the `Incidence Graph`_.
62
63OUT:  ``PositionMap position``
64
65IN:  ``property_traits<PositionMap>::value_type origin``
66
67IN:  ``property_traits<PositionMap>::value_type extent``
68
69IN:  ``AttractiveForce attractive_force``
70
71IN:  ``RepulsiveForce repulsive_force``
72
73IN:  ``ForcePairs force_pairs``
74
75IN:  ``Cooling cool``
76
77IN:  ``DisplacementMap displacement``
78
79..
80 Complexity
81 ----------
82
83..
84 Algorithm Description
85 ---------------------
86
87-----------------------------------------------------------------------------
88
89Copyright (C) 2009 The Trustees of Indiana University.
90
91Authors: Nick Edmonds and Andrew Lumsdaine
92
93.. |Logo| image:: pbgl-logo.png
94            :align: middle
95            :alt: Parallel BGL
96            :target: http://www.osl.iu.edu/research/pbgl
97
98.. _Distributed Graph: DistributedGraph.html
99.. _Incidence Graph: http://www.boost.org/libs/graph/doc/IncidenceGraph.html
100.. _Distributed Property Map: distributed_property_map.html
101