Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/graph/doc/bc_clustering.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 18 years ago

added boost
File size: 5.6 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta name="generator" content=
5"HTML Tidy for Mac OS X (vers 12 April 2005), see www.w3.org">
6<meta http-equiv="Content-Type" content=
7"text/html; charset=us-ascii">
8<title>Function betweenness_centrality_clustering</title>
9</head>
10<body>
11<div class="titlepage"></div>
12<div class="refnamediv">
13
14<IMG SRC="../../../boost.png" 
15     ALT="C++ Boost" width="277" height="86">
16
17<h1><img src="figs/python.gif" alt="(Python)"/><span class="refentrytitle">Function
18betweenness_centrality_clustering</span></h1>
19<p>boost::betweenness_centrality_clustering &mdash; Graph
20clustering based on edge betweenness centrality.</p>
21</div>
22<h2 xmlns:rev=
23"http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class=
24"refsynopsisdiv-title">Synopsis</h2>
25<div xmlns:rev=
26"http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class=
27"refsynopsisdiv">
28<pre class="synopsis">
29<span class="bold"><b>template</b></span>&lt;<span class=
30"bold"><b>typename</b></span> MutableGraph, <span class=
31"bold"><b>typename</b></span> Done, <span class=
32"bold"><b>typename</b></span> EdgeCentralityMap,
33         <span class=
34"bold"><b>typename</b></span> VertexIndexMap&gt; 
35  <span class="type"><span class=
36"bold"><b>void</b></span></span> betweenness_centrality_clustering(MutableGraph &amp; g, Done done,
37                                         EdgeCentralityMap edge_centrality,
38                                         VertexIndexMap vertex_index);
39<span class="bold"><b>template</b></span>&lt;<span class=
40"bold"><b>typename</b></span> MutableGraph, <span class=
41"bold"><b>typename</b></span> Done, <span class=
42"bold"><b>typename</b></span> EdgeCentralityMap&gt; 
43  <span class="type"><span class=
44"bold"><b>void</b></span></span> betweenness_centrality_clustering(MutableGraph &amp; g, Done done,
45                                         EdgeCentralityMap edge_centrality);
46<span class="bold"><b>template</b></span>&lt;<span class=
47"bold"><b>typename</b></span> MutableGraph, <span class=
48"bold"><b>typename</b></span> Done&gt; 
49  <span class="type"><span class=
50"bold"><b>void</b></span></span> betweenness_centrality_clustering(MutableGraph &amp; g, Done done);
51</pre></div>
52<div class="refsect1" lang="en"><a name="id822306" id=
53"id822306"></a>
54<h2>Description</h2>
55<p>This algorithm implements graph clustering based on edge
56betweenness centrality. It is an iterative algorithm, where in each
57step it compute the edge betweenness centrality (via <a href=
58"betweenness_centrality.html">brandes_betweenness_centrality</a>) and
59removes the edge with the maximum betweenness centrality. The
60<tt class="computeroutput">done</tt> function object determines
61when the algorithm terminates (the edge found when the algorithm
62terminates will not be removed).</p>
63
64<h2>Parameters</h2>
65IN: <tt>const Graph&amp; g</tt>
66<blockquote>
67  The graph object on which the algorithm will be applied.  The type
68  <tt>Graph</tt> must be a model of <a
69  href="VertexListGraph.html">Vertex List Graph</a> and <a
70  href="IncidenceGraph.html">Incidence Graph</a>. When an edge
71  centrality map is supplied, it must also model <a
72  href="EdgeListGraph.html">Edge List Graph</a> and <a
73  href="MutableGraph.html">MutableGraph</a>.<br>
74
75<b>Python</b>: The parameter is named <tt>graph</tt>.
76</blockquote>
77
78IN: <tt>Done done</tt>
79<blockquote>
80The function object that indicates termination of the algorithm.
81It must be a ternary function object thats accepts the maximum
82centrality, the descriptor of the edge that will be removed, and
83the graph <tt class="computeroutput">g</tt>.<br>
84<b>Python</b>: Any callable Python object will suffice.
85</blockquote>
86
87OUT/UTIL: <tt>EdgeCentralityMap edge_centrality_map</tt>
88<blockquote>
89  This property map is used to accumulate the betweenness centrality
90  of each edge, and is a secondary form of output for the
91  algorithm. The type <tt>EdgeCentralityMap</tt> must be a model of <a
92  href="../../property_map/ReadWritePropertyMap.html">Read/Write
93  Property Map</a>, with the graph's edge descriptor type as its key
94  type. The value type of this property map should be the same as the
95  value type of the <tt>CentralityMap</tt> property map.<br>
96
97  <b>Default:</b> a <tt>dummy_property_map</tt>, which requires no
98  work to compute and returns no answer.<br>
99  <b>Python</b>: The color map must be a <tt>edge_double_map</tt> for
100  the graph.<br>
101  <b>Python default</b>: <tt>graph.get_edge_double_map("centrality")</tt>
102</blockquote>
103
104IN: <tt>VertexIndexMap vertex_index</tt> 
105<blockquote>
106  This maps each vertex to an integer in the range <tt>[0,
107    num_vertices(g))</tt>. This is necessary for efficient updates of the
108  heap data structure when an edge is relaxed.  The type
109  <tt>VertexIndexMap</tt> must be a model of
110  <a href="../../property_map/ReadablePropertyMap.html">Readable Property Map</a>. The value type of the map must be an
111  integer type. The vertex descriptor type of the graph needs to be
112  usable as the key type of the map.<br>
113  <b>Default:</b> <tt>get(vertex_index, g)</tt><br>
114  <b>Python</b>: Unsupported parameter.
115</blockquote>
116
117<table xmlns:rev=
118"http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width=
119"100%">
120<tr>
121<td align="left"></td>
122<td align="right"></td>
123</tr>
124</table>
125<h3>Where Defined</h3>
126&lt;<a href=
127"../../../boost/graph/bc_clustering.hpp">boost/graph/bc_clustering.hpp</a>&gt;
128<hr>
129<table>
130<tr valign="top">
131<td nowrap>Copyright &copy; 2004</td>
132<td><a href="../../../people/doug_gregor.html">Douglas Gregor</a>,
133Indiana University (dgregor@cs.indiana.edu)<br>
134<a href="http://www.osl.iu.edu/~lums">Andrew Lumsdaine</a>, Indiana
135University (<a href=
136"mailto:lums@osl.iu.edu">lums@osl.iu.edu</a>)</td>
137</tr>
138</table>
139</body>
140</html>
Note: See TracBrowser for help on using the repository browser.