ceph/src/boost/libs/graph_parallel/doc/html/fruchterman_reingold.html

   1 <?xml version="1.0" encoding="utf-8" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
   7 <title>Parallel BGL Fruchterman Reingold</title>
   8 <link rel="stylesheet" href="../../../../rst.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="logo-fruchterman-reingold">
  12 <h1 class="title"><a class="reference external" href="http://www.osl.iu.edu/research/pbgl"><img align="middle" alt="Parallel BGL" class="align-middle" src="pbgl-logo.png" /></a> Fruchterman Reingold</h1>
  13
  14 <!-- Copyright (C) 2004-2009 The Trustees of Indiana University.
  15 Use, modification and distribution is subject to the Boost Software
  16 License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  17 http://www.boost.org/LICENSE_1_0.txt) -->
  18 <pre class="literal-block">
  19 namespace graph { namespace distributed {
  20
  21   template&lt;typename Graph, typename PositionMap,
  22            typename AttractiveForce, typename RepulsiveForce,
  23            typename ForcePairs, typename Cooling, typename DisplacementMap&gt;
  24   void
  25   fruchterman_reingold_force_directed_layout
  26   (const Graph&amp;    g,
  27    PositionMap     position,
  28    typename property_traits&lt;PositionMap&gt;::value_type const&amp; origin,
  29    typename property_traits&lt;PositionMap&gt;::value_type const&amp; extent,
  30    AttractiveForce attractive_force,
  31    RepulsiveForce  repulsive_force,
  32    ForcePairs      force_pairs,
  33    Cooling         cool,
  34    DisplacementMap displacement)
  35
  36   template&lt;typename Graph, typename PositionMap,
  37            typename AttractiveForce, typename RepulsiveForce,
  38            typename ForcePairs, typename Cooling, typename DisplacementMap&gt;
  39   void
  40   fruchterman_reingold_force_directed_layout
  41   (const Graph&amp;    g,
  42    PositionMap     position,
  43    typename property_traits&lt;PositionMap&gt;::value_type const&amp; origin,
  44    typename property_traits&lt;PositionMap&gt;::value_type const&amp; extent,
  45    AttractiveForce attractive_force,
  46    RepulsiveForce  repulsive_force,
  47    ForcePairs      force_pairs,
  48    Cooling         cool,
  49    DisplacementMap displacement,
  50    simple_tiling   tiling)
  51 } }
  52 </pre>
  53 <div class="contents topic" id="contents">
  54 <p class="topic-title first">Contents</p>
  55 <ul class="simple">
  56 <li><a class="reference internal" href="#where-defined" id="id1">Where Defined</a></li>
  57 <li><a class="reference internal" href="#parameters" id="id2">Parameters</a></li>
  58 </ul>
  59 </div>
  60 <div class="section" id="where-defined">
  61 <h1><a class="toc-backref" href="#id1">Where Defined</a></h1>
  62 <p>&lt;<tt class="docutils literal"><span class="pre">boost/graph/distributed/fruchterman_reingold.hpp</span></tt>&gt;</p>
  63 <p>also accessible from</p>
  64 <p>&lt;<tt class="docutils literal"><span class="pre">boost/graph/fruchterman_reingold.hpp</span></tt>&gt;</p>
  65 </div>
  66 <div class="section" id="parameters">
  67 <h1><a class="toc-backref" href="#id2">Parameters</a></h1>
  68 <dl class="docutils">
  69 <dt>IN:  <tt class="docutils literal"><span class="pre">const</span> <span class="pre">Graph&amp;</span> <span class="pre">g</span></tt></dt>
  70 <dd>The graph type must be a model of <a class="reference external" href="DistributedGraph.html">Distributed Graph</a>.  The graph
  71 type must also model the <a class="reference external" href="http://www.boost.org/libs/graph/doc/IncidenceGraph.html">Incidence Graph</a>.</dd>
  72 </dl>
  73 <p>OUT:  <tt class="docutils literal"><span class="pre">PositionMap</span> <span class="pre">position</span></tt></p>
  74 <p>IN:  <tt class="docutils literal"><span class="pre">property_traits&lt;PositionMap&gt;::value_type</span> <span class="pre">origin</span></tt></p>
  75 <p>IN:  <tt class="docutils literal"><span class="pre">property_traits&lt;PositionMap&gt;::value_type</span> <span class="pre">extent</span></tt></p>
  76 <p>IN:  <tt class="docutils literal"><span class="pre">AttractiveForce</span> <span class="pre">attractive_force</span></tt></p>
  77 <p>IN:  <tt class="docutils literal"><span class="pre">RepulsiveForce</span> <span class="pre">repulsive_force</span></tt></p>
  78 <p>IN:  <tt class="docutils literal"><span class="pre">ForcePairs</span> <span class="pre">force_pairs</span></tt></p>
  79 <p>IN:  <tt class="docutils literal"><span class="pre">Cooling</span> <span class="pre">cool</span></tt></p>
  80 <p>IN:  <tt class="docutils literal"><span class="pre">DisplacementMap</span> <span class="pre">displacement</span></tt></p>
  81 <!-- Complexity
  82 - - - - - - - - - - -->
  83 <!-- Algorithm Description
  84 - - - - - - - - - - - - - - - - - - - - - -->
  85 <hr class="docutils" />
  86 <p>Copyright (C) 2009 The Trustees of Indiana University.</p>
  87 <p>Authors: Nick Edmonds and Andrew Lumsdaine</p>
  88 </div>
  89 </div>
  90 <div class="footer">
  91 <hr class="footer" />
  92 Generated on: 2009-05-31 00:21 UTC.
  93 Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
  94
  95 </div>
  96 </body>
  97 </html>