Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/graph/doc/circle_layout.html @ 45

Last change on this file since 45 was 29, checked in by landauf, 16 years ago

updated boost from 1_33_1 to 1_34_1
File size: 4.2 KB
Line 
1<html><!--
2  -- Copyright (c) 2004 Trustees of Indiana University
3  --
4  -- Distributed under the Boost Software License, Version 1.0.
5  -- (See accompanying file LICENSE_1_0.txt or copy at
6  -- http://www.boost.org/LICENSE_1_0.txt)
7  -->
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="../../../people/people.htm">People</a></td><td align="center"><a href="../../../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<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  <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                           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
13          <h2>Parameters</h2>
14IN: <tt>const VertexListGraph&amp; g</tt>
15<blockquote>
16  The graph object on which the algorithm will be applied.  The type
17  <tt>VertexListGraph</tt> must be a model of <a
18  href="VertexListGraph.html">Vertex List Graph</a>.<br>
19<b>Python</b>: The parameter is named <tt>graph</tt>.
20</blockquote>
21
22OUT: <tt>PositionMap position</tt>
23<blockquote>
24  This property map is used to store the position of each vertex.  The
25  type <tt>PositionMap</tt> must be a model of <a
26  href="../../property_map/WritablePropertyMap.html">Writable Property
27  Map</a>, with the graph's edge descriptor type as its key type. The
28  value type of this property map should be assignable from the
29  type <tt>Radius</tt>. <br>
30
31  <b>Python</b>: The position map must be a <tt>vertex_point2d_map</tt> for
32  the graph.<br>
33  <b>Python default</b>: <tt>graph.get_vertex_point2d_map("position")</tt>
34</blockquote>
35
36IN: <tt>Radius radius</tt>
37<blockquote>
38  This is the radius of the circle on which points will be layed
39  out. It must be compatible with <tt>double</tt>.<br>
40</blockquote>
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
44                           <TABLE>
45<TR valign=top>
46<TD nowrap>Copyright &copy 2004</TD><TD>
47<A HREF="../../../people/doug_gregor.html">Douglas Gregor</A>, Indiana University (dgregor -at- cs.indiana.edu</A>)<br>
48<A HREF=http://www.osl.iu.edu/~lums>Andrew Lumsdaine</A>,
49Indiana University (lums -at- osl.iu.edu)
50</TD></TR></TABLE>
51                           </body></html>
Note: See TracBrowser for help on using the repository browser.