]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <HTML> |
2 | <!-- | |
3 | Copyright (c) 2005, 2010 Trustees of Indiana University | |
4 | ||
5 | Distributed under the Boost Software License, Version 1.0. | |
6 | (See accompanying file LICENSE_1_0.txt or copy at | |
7 | http://www.boost.org/LICENSE_1_0.txt) | |
8 | --> | |
9 | <Head> | |
10 | <Title>Boost Graph Library: Random Graph Layout</Title> | |
11 | <BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" | |
12 | ALINK="#ff0000"> | |
13 | <IMG SRC="../../../boost.png" | |
14 | ALT="C++ Boost" width="277" height="86"> | |
15 | ||
16 | <BR Clear> | |
17 | ||
18 | <TT>random_graph_layout</TT> | |
19 | </H1> | |
20 | ||
21 | ||
22 | <P> | |
23 | <PRE> | |
24 | <i>// non-named parameter version</i> | |
25 | template<typename Graph, typename PositionMap, typename Topology> | |
26 | void | |
27 | random_graph_layout(const Graph& g, PositionMap position_map, | |
28 | const Topology& space); | |
29 | </PRE> | |
30 | ||
31 | <P> This algorithm places the points of the graph at random | |
32 | locations within a given space. </p> | |
33 | ||
34 | <h3>Where Defined</h3> | |
35 | ||
36 | <a href="../../../boost/graph/random_layout.hpp"><tt>boost/graph/random_layout.hpp</tt></a> | |
37 | ||
38 | <h3>Parameters</h3> | |
39 | ||
40 | IN: <tt>const Graph& g</tt> | |
41 | <blockquote> | |
42 | The graph object on which the algorithm will be applied. | |
43 | The type <tt>Graph</tt> must be a model of | |
44 | <a href="./VertexAndEdgeListGraph.html">Vertex And Edge List Graph</a>. | |
45 | </blockquote> | |
46 | ||
47 | IN/OUT: <tt>PositionMap position</tt> | |
48 | <blockquote> | |
49 | The property map that stores the position of each vertex. The type | |
50 | <tt>PositionMap</tt> must be a model of <a | |
51 | href="../../property_map/doc/LvaluePropertyMap.html">Lvalue Property | |
52 | Map</a> such that the vertex descriptor type of <tt>Graph</tt> is | |
53 | convertible to its key type. Its value type must be | |
54 | <tt>Topology::point_type</tt>, representing the coordinates of the vertex. | |
55 | </blockquote> | |
56 | ||
57 | IN: <tt>const Topology& space</tt> | |
58 | <blockquote> | |
59 | The topology used to lay out the vertices. This parameter describes both the | |
60 | size and shape of the layout area and provides a random number generator used | |
61 | to create random positions within the space. Topologies are described in | |
62 | more detail (with a list of BGL-provided topologies) <a | |
63 | href="topology.html">in separate documentation</a>. | |
64 | </blockquote> | |
65 | ||
66 | <H3>Complexity</H3> | |
67 | <P> The time complexity is <i>O(|V|)</i>. | |
68 | ||
69 | <br> | |
70 | <HR> | |
71 | <TABLE> | |
72 | <TR valign=top> | |
73 | <TD nowrap>Copyright © 2004, 2010</TD><TD> | |
74 | <A HREF="http://www.boost.org/people/doug_gregor.html">Doug Gregor</A>, Indiana University | |
75 | </TD></TR></TABLE> | |
76 | ||
77 | </BODY> | |
78 | </HTML> |