Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 75 Pull Requests 0 Wiki
Tree: 0ad4e6b698
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
graph
/
doc
/
circle_layout.html

circle_layout.html 4.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 
  1. <html><!--
    2. 

  2.      Copyright (c) 2004 Trustees of Indiana University
    3. 

  3.     
    4. 

  4.      Distributed under the Boost Software License, Version 1.0.
    5. 

  5.      (See accompanying file LICENSE_1_0.txt or copy at
    6. 

  6.      http://www.boost.org/LICENSE_1_0.txt)
    7. 

  7.   -->
    8. 

  8. <head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Function template circle_graph_layout</title></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table cellpadding="2" width="100%"><td valign="top"><img src="../../../boost.png" alt="boost.png (6897 bytes)" width="277" height="86"></td><td align="center"><a href="../../../index.htm">Home</a></td><td align="center"><a href="../../libraries.htm">Libraries</a></td><td align="center"><a href="http://www.boost.org/people/people.htm">People</a></td><td align="center"><a href="http://www.boost.org/more/faq.htm">FAQ</a></td><td align="center"><a href="../../../more/index.htm">More</a></td></table><hr><div class="refentry" lang="en"><a name="id103562-bb"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><img src="figs/python.gif" alt="(Python)"/><span class="refentrytitle">Function template circle_graph_layout</span></h2><p>boost::circle_graph_layout &#8212; Layout the graph with the vertices at the points of a regular n-polygon. </p></div><h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2><div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">
    9. 

  9. <span class="bold"><b>template</b></span>&lt;<span class="bold"><b>typename</b></span> VertexListGraph, <span class="bold"><b>typename</b></span> PositionMap, <span class="bold"><b>typename</b></span> Radius&gt; 
    10. 

  10.   <span class="type"><span class="bold"><b>void</b></span></span> circle_graph_layout(<span class="bold"><b>const</b></span> VertexListGraph &amp; g, PositionMap position, 
    11. 

  11.                            Radius radius);</pre></div><div class="refsect1" lang="en"><a name="id821794"></a><h2>Where Defined</h2><a href="../../../boost/graph/circle_layout.hpp">boost/graph/circle_layout.hpp</a><h2>Description</h2><p>The distance from the center of the polygon to each point is determined by the <tt class="computeroutput">radius</tt>  parameter. The <tt class="computeroutput">position</tt>  parameter must be an Lvalue Property Map whose value type is a class type containing <tt class="computeroutput">x</tt>  and <tt class="computeroutput">y</tt>  members that will be set to the <tt class="computeroutput">x</tt>  and <tt class="computeroutput">y</tt>  coordinates. 
    12. 

  12. 

  13.           <h2>Parameters</h2>
    14. 

  14. IN: <tt>const VertexListGraph&amp; g</tt>
    15. 

  15. <blockquote>
    16. 

  16.   The graph object on which the algorithm will be applied.  The type
    17. 

  17.   <tt>VertexListGraph</tt> must be a model of <a
    18. 

  18.   href="VertexListGraph.html">Vertex List Graph</a>.<br>
    19. 

  19. <b>Python</b>: The parameter is named <tt>graph</tt>.
    20. 

  20. </blockquote>
    21. 

  21. 

  22. OUT: <tt>PositionMap position</tt>
    23. 

  23. <blockquote>
    24. 

  24.   This property map is used to store the position of each vertex.  The
    25. 

  25.   type <tt>PositionMap</tt> must be a model of <a
    26. 

  26.   href="../../property_map/doc/WritablePropertyMap.html">Writable Property
    27. 

  27.   Map</a>, with the graph's edge descriptor type as its key type. The
    28. 

  28.   value type of this property map should be assignable from the
    29. 

  29.   type <tt>Radius</tt>. <br>
    30. 

  30. 

  31.   <b>Python</b>: The position map must be a <tt>vertex_point2d_map</tt> for
    32. 

  32.   the graph.<br>
    33. 

  33.   <b>Python default</b>: <tt>graph.get_vertex_point2d_map("position")</tt>
    34. 

  34. </blockquote>
    35. 

  35. 

  36. IN: <tt>Radius radius</tt>
    37. 

  37. <blockquote>
    38. 

  38.   This is the radius of the circle on which points will be layed
    39. 

  39.   out. It must be compatible with <tt>double</tt>.<br>
    40. 

  40. </blockquote>
    41. 

  41. 

  42. </p></div></div><table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr><td align="left"></td><td align="right"><small></small></td></tr></table><hr>
    43. 

  43. 

  44.                            <TABLE>
    45. 

  45. <TR valign=top>
    46. 

  46. <TD nowrap>Copyright &copy; 2004</TD><TD>
    47. 

  47. <A HREF="http://www.boost.org/people/doug_gregor.html">Douglas Gregor</A>, Indiana University (dgregor -at- cs.indiana.edu</A>)<br>
    48. 

  48. <A HREF="https://homes.cs.washington.edu/~al75">Andrew Lumsdaine</A>,
    49. 

  49. Indiana University (lums -at- osl.iu.edu)
    50. 

  50. </TD></TR></TABLE>
    51. 

  51.                            </body></html>
    52.