Subject: [Boost-commit] svn:boost r53372 - trunk/libs/graph_parallel/doc
From: ngedmond_at_[hidden]
Date: 2009-05-28 19:24:46
Author: ngedmond
Date: 2009-05-28 19:24:45 EDT (Thu, 28 May 2009)
New Revision: 53372
URL: http://svn.boost.org/trac/boost/changeset/53372
Log:
Documented fruchterman-reingold as well as possible without actually understanding how it works.
Text files modified:
trunk/libs/graph_parallel/doc/fruchterman_reingold.rst | 78 ++++++++++++++++++++++++++++++++++++++++
1 files changed, 78 insertions(+), 0 deletions(-)
Modified: trunk/libs/graph_parallel/doc/fruchterman_reingold.rst
==============================================================================
--- trunk/libs/graph_parallel/doc/fruchterman_reingold.rst (original)
+++ trunk/libs/graph_parallel/doc/fruchterman_reingold.rst 2009-05-28 19:24:45 EDT (Thu, 28 May 2009)
@@ -7,6 +7,80 @@
|Logo| Fruchterman Reingold
===========================
+::
+ namespace graph { namespace distributed {
+
+ template<typename Graph, typename PositionMap,
+ typename AttractiveForce, typename RepulsiveForce,
+ typename ForcePairs, typename Cooling, typename DisplacementMap>
+ void
+ fruchterman_reingold_force_directed_layout
+ (const Graph& g,
+ PositionMap position,
+ typename property_traits<PositionMap>::value_type const& origin,
+ typename property_traits<PositionMap>::value_type const& extent,
+ AttractiveForce attractive_force,
+ RepulsiveForce repulsive_force,
+ ForcePairs force_pairs,
+ Cooling cool,
+ DisplacementMap displacement)
+
+ template<typename Graph, typename PositionMap,
+ typename AttractiveForce, typename RepulsiveForce,
+ typename ForcePairs, typename Cooling, typename DisplacementMap>
+ void
+ fruchterman_reingold_force_directed_layout
+ (const Graph& g,
+ PositionMap position,
+ typename property_traits<PositionMap>::value_type const& origin,
+ typename property_traits<PositionMap>::value_type const& extent,
+ AttractiveForce attractive_force,
+ RepulsiveForce repulsive_force,
+ ForcePairs force_pairs,
+ Cooling cool,
+ DisplacementMap displacement,
+ simple_tiling tiling)
+ } }
+
+.. contents::
+
+Where Defined
+-------------
+<``boost/graph/distributed/fruchterman_reingold.hpp``>
+
+also accessible from
+
+<``boost/graph/fruchterman_reingold.hpp``>
+
+Parameters
+----------
+
+IN: ``const Graph& g``
+ The graph type must be a model of `Distributed Graph`_. The graph
+ type must also model the `Incidence Graph`_.
+
+OUT: ``PositionMap position``
+
+IN: ``property_traits<PositionMap>::value_type origin``
+
+IN: ``property_traits<PositionMap>::value_type extent``
+
+IN: ``AttractiveForce attractive_force``
+
+IN: ``RepulsiveForce repulsive_force``
+
+IN: ``ForcePairs force_pairs``
+
+IN: ``Cooling cool``
+
+IN: ``DisplacementMap displacement``
+
+Complexity
+----------
+
+Algorithm Description
+---------------------
+
-----------------------------------------------------------------------------
@@ -18,3 +92,7 @@
:align: middle
:alt: Parallel BGL
:target: http://www.osl.iu.edu/research/pbgl
+
+.. _Distributed Graph: DistributedGraph.html
+.. _Incidence Graph: http://www.boost.org/libs/graph/doc/IncidenceGraph.html
+.. _Distributed Property Map: distributed_property_map.html
\ No newline at end of file