fruchterman_reingold.rst 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  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. |Logo| Fruchterman Reingold
  7. ===========================
  8. ::
  9. namespace graph { namespace distributed {
  10. template<typename Graph, typename PositionMap,
  11. typename AttractiveForce, typename RepulsiveForce,
  12. typename ForcePairs, typename Cooling, typename DisplacementMap>
  13. void
  14. fruchterman_reingold_force_directed_layout
  15. (const Graph& g,
  16. PositionMap position,
  17. typename property_traits<PositionMap>::value_type const& origin,
  18. typename property_traits<PositionMap>::value_type const& extent,
  19. AttractiveForce attractive_force,
  20. RepulsiveForce repulsive_force,
  21. ForcePairs force_pairs,
  22. Cooling cool,
  23. DisplacementMap displacement)
  24. template<typename Graph, typename PositionMap,
  25. typename AttractiveForce, typename RepulsiveForce,
  26. typename ForcePairs, typename Cooling, typename DisplacementMap>
  27. void
  28. fruchterman_reingold_force_directed_layout
  29. (const Graph& g,
  30. PositionMap position,
  31. typename property_traits<PositionMap>::value_type const& origin,
  32. typename property_traits<PositionMap>::value_type const& extent,
  33. AttractiveForce attractive_force,
  34. RepulsiveForce repulsive_force,
  35. ForcePairs force_pairs,
  36. Cooling cool,
  37. DisplacementMap displacement,
  38. simple_tiling tiling)
  39. } }
  40. .. contents::
  41. Where Defined
  42. -------------
  43. <``boost/graph/distributed/fruchterman_reingold.hpp``>
  44. also accessible from
  45. <``boost/graph/fruchterman_reingold.hpp``>
  46. Parameters
  47. ----------
  48. IN: ``const Graph& g``
  49. The graph type must be a model of `Distributed Graph`_. The graph
  50. type must also model the `Incidence Graph`_.
  51. OUT: ``PositionMap position``
  52. IN: ``property_traits<PositionMap>::value_type origin``
  53. IN: ``property_traits<PositionMap>::value_type extent``
  54. IN: ``AttractiveForce attractive_force``
  55. IN: ``RepulsiveForce repulsive_force``
  56. IN: ``ForcePairs force_pairs``
  57. IN: ``Cooling cool``
  58. IN: ``DisplacementMap displacement``
  59. ..
  60. Complexity
  61. ----------
  62. ..
  63. Algorithm Description
  64. ---------------------
  65. -----------------------------------------------------------------------------
  66. Copyright (C) 2009 The Trustees of Indiana University.
  67. Authors: Nick Edmonds and Andrew Lumsdaine
  68. .. |Logo| image:: pbgl-logo.png
  69. :align: middle
  70. :alt: Parallel BGL
  71. :target: http://www.osl.iu.edu/research/pbgl
  72. .. _Distributed Graph: DistributedGraph.html
  73. .. _Incidence Graph: http://www.boost.org/libs/graph/doc/IncidenceGraph.html
  74. .. _Distributed Property Map: distributed_property_map.html