fruchterman_reingold.html 5.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  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. <!-- Copyright (C) 2004-2009 The Trustees of Indiana University.
  14. Use, modification and distribution is subject to the Boost Software
  15. License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  16. http://www.boost.org/LICENSE_1_0.txt) -->
  17. <pre class="literal-block">
  18. namespace graph { namespace distributed {
  19. template&lt;typename Graph, typename PositionMap,
  20. typename AttractiveForce, typename RepulsiveForce,
  21. typename ForcePairs, typename Cooling, typename DisplacementMap&gt;
  22. void
  23. fruchterman_reingold_force_directed_layout
  24. (const Graph&amp; g,
  25. PositionMap position,
  26. typename property_traits&lt;PositionMap&gt;::value_type const&amp; origin,
  27. typename property_traits&lt;PositionMap&gt;::value_type const&amp; extent,
  28. AttractiveForce attractive_force,
  29. RepulsiveForce repulsive_force,
  30. ForcePairs force_pairs,
  31. Cooling cool,
  32. DisplacementMap displacement)
  33. template&lt;typename Graph, typename PositionMap,
  34. typename AttractiveForce, typename RepulsiveForce,
  35. typename ForcePairs, typename Cooling, typename DisplacementMap&gt;
  36. void
  37. fruchterman_reingold_force_directed_layout
  38. (const Graph&amp; g,
  39. PositionMap position,
  40. typename property_traits&lt;PositionMap&gt;::value_type const&amp; origin,
  41. typename property_traits&lt;PositionMap&gt;::value_type const&amp; extent,
  42. AttractiveForce attractive_force,
  43. RepulsiveForce repulsive_force,
  44. ForcePairs force_pairs,
  45. Cooling cool,
  46. DisplacementMap displacement,
  47. simple_tiling tiling)
  48. } }
  49. </pre>
  50. <div class="contents topic" id="contents">
  51. <p class="topic-title first">Contents</p>
  52. <ul class="simple">
  53. <li><a class="reference internal" href="#where-defined" id="id1">Where Defined</a></li>
  54. <li><a class="reference internal" href="#parameters" id="id2">Parameters</a></li>
  55. </ul>
  56. </div>
  57. <div class="section" id="where-defined">
  58. <h1><a class="toc-backref" href="#id1">Where Defined</a></h1>
  59. <p>&lt;<tt class="docutils literal"><span class="pre">boost/graph/distributed/fruchterman_reingold.hpp</span></tt>&gt;</p>
  60. <p>also accessible from</p>
  61. <p>&lt;<tt class="docutils literal"><span class="pre">boost/graph/fruchterman_reingold.hpp</span></tt>&gt;</p>
  62. </div>
  63. <div class="section" id="parameters">
  64. <h1><a class="toc-backref" href="#id2">Parameters</a></h1>
  65. <dl class="docutils">
  66. <dt>IN: <tt class="docutils literal"><span class="pre">const</span> <span class="pre">Graph&amp;</span> <span class="pre">g</span></tt></dt>
  67. <dd>The graph type must be a model of <a class="reference external" href="DistributedGraph.html">Distributed Graph</a>. The graph
  68. type must also model the <a class="reference external" href="http://www.boost.org/libs/graph/doc/IncidenceGraph.html">Incidence Graph</a>.</dd>
  69. </dl>
  70. <p>OUT: <tt class="docutils literal"><span class="pre">PositionMap</span> <span class="pre">position</span></tt></p>
  71. <p>IN: <tt class="docutils literal"><span class="pre">property_traits&lt;PositionMap&gt;::value_type</span> <span class="pre">origin</span></tt></p>
  72. <p>IN: <tt class="docutils literal"><span class="pre">property_traits&lt;PositionMap&gt;::value_type</span> <span class="pre">extent</span></tt></p>
  73. <p>IN: <tt class="docutils literal"><span class="pre">AttractiveForce</span> <span class="pre">attractive_force</span></tt></p>
  74. <p>IN: <tt class="docutils literal"><span class="pre">RepulsiveForce</span> <span class="pre">repulsive_force</span></tt></p>
  75. <p>IN: <tt class="docutils literal"><span class="pre">ForcePairs</span> <span class="pre">force_pairs</span></tt></p>
  76. <p>IN: <tt class="docutils literal"><span class="pre">Cooling</span> <span class="pre">cool</span></tt></p>
  77. <p>IN: <tt class="docutils literal"><span class="pre">DisplacementMap</span> <span class="pre">displacement</span></tt></p>
  78. <!-- Complexity
  79. - - - - - - - - - - -->
  80. <!-- Algorithm Description
  81. - - - - - - - - - - - - - - - - - - - - - -->
  82. <hr class="docutils" />
  83. <p>Copyright (C) 2009 The Trustees of Indiana University.</p>
  84. <p>Authors: Nick Edmonds and Andrew Lumsdaine</p>
  85. </div>
  86. </div>
  87. <div class="footer">
  88. <hr class="footer" />
  89. Generated on: 2009-05-31 00:21 UTC.
  90. 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.
  91. </div>
  92. </body>
  93. </html>