1 <?xml version=
"1.0" encoding=
"utf-8" ?>
2 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en" lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=utf-8" />
6 <meta name=
"generator" content=
"Docutils 0.6: http://docutils.sourceforge.net/" />
7 <title>Parallel BGL Concept Distributed Vertex List Graph
</title>
8 <link rel=
"stylesheet" href=
"../../../../rst.css" type=
"text/css" />
11 <div class=
"document" id=
"logo-concept-distributed-vertex-list-graph">
12 <h1 class=
"title"><a class=
"reference external" href=
"http://www.osl.iu.edu/research/pbgl"><img align=
"middle" alt=
"Parallel BGL" class=
"align-middle" src=
"pbgl-logo.png" /></a> Concept Distributed Vertex List Graph
</h1>
14 <!-- Copyright (C) 2004-2008 The Trustees of Indiana University.
15 Use, modification and distribution is subject to the Boost Software
16 License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
17 http://www.boost.org/LICENSE_1_0.txt) -->
18 <div class=
"contents topic" id=
"contents">
19 <p class=
"topic-title first">Contents
</p>
21 <li><a class=
"reference internal" href=
"#description" id=
"id1">Description
</a></li>
22 <li><a class=
"reference internal" href=
"#notation" id=
"id2">Notation
</a></li>
23 <li><a class=
"reference internal" href=
"#refinement-of" id=
"id3">Refinement of
</a></li>
24 <li><a class=
"reference internal" href=
"#associated-types" id=
"id4">Associated types
</a></li>
25 <li><a class=
"reference internal" href=
"#valid-expressions" id=
"id5">Valid Expressions
</a></li>
26 <li><a class=
"reference internal" href=
"#models" id=
"id6">Models
</a></li>
29 <div class=
"section" id=
"description">
30 <h1><a class=
"toc-backref" href=
"#id1">Description
</a></h1>
31 <p>A Distributed Vertex List Graph is a graph whose vertices are
32 distributed across multiple processes or address spaces. The
33 <tt class=
"docutils literal"><span class=
"pre">vertices
</span></tt> and
<tt class=
"docutils literal"><span class=
"pre">num_vertices
</span></tt> functions retain the same
34 signatures as in the
<a class=
"reference external" href=
"http://www.boost.org/libs/graph/doc/VertexListGraph.html">Vertex List Graph
</a> concept, but return only
35 the local set (and size of the local set) of vertices.
</p>
37 <div class=
"section" id=
"notation">
38 <h1><a class=
"toc-backref" href=
"#id2">Notation
</a></h1>
41 <dd>A type that models the Distributed Vertex List Graph concept.
</dd>
43 <dd>An object of type
<tt class=
"docutils literal"><span class=
"pre">G
</span></tt>.
</dd>
46 <div class=
"section" id=
"refinement-of">
47 <h1><a class=
"toc-backref" href=
"#id3">Refinement of
</a></h1>
50 <li><a class=
"reference external" href=
"http://www.boost.org/libs/graph/doc/Graph.html">Graph
</a></li>
54 <div class=
"section" id=
"associated-types">
55 <h1><a class=
"toc-backref" href=
"#id4">Associated types
</a></h1>
56 <table border=
"1" class=
"docutils">
65 <td><tt class=
"docutils literal"><span class=
"pre">graph_traits
<G
>::vertex_descriptor
</span></tt></td>
67 <a class=
"reference external" href=
"GlobalDescriptor.html">Global Descriptor
</a> concept.
</td>
69 <tr><td>Vertex iterator
71 <td><tt class=
"docutils literal"><span class=
"pre">graph_traits
<G
>::vertex_iterator
</span></tt></td>
72 <td>Iterates over vertices stored
73 locally. The value type must be
74 <tt class=
"docutils literal"><span class=
"pre">vertex_descriptor
</span></tt>.
</td>
78 <td><tt class=
"docutils literal"><span class=
"pre">graph_traits
<G
>::vertices_size_type
</span></tt></td>
79 <td>The unsigned integral type used
80 to store the number of vertices
81 in the local subgraph.
</td>
86 <div class=
"section" id=
"valid-expressions">
87 <h1><a class=
"toc-backref" href=
"#id5">Valid Expressions
</a></h1>
88 <table border=
"1" class=
"docutils">
95 <thead valign=
"bottom">
96 <tr><th class=
"head">Name
</th>
97 <th class=
"head">Expression
</th>
98 <th class=
"head">Type
</th>
99 <th class=
"head">Semantics
</th>
103 <tr><td>Local vertex set
</td>
104 <td><tt class=
"docutils literal"><span class=
"pre">vertices(g)
</span></tt></td>
105 <td><tt class=
"docutils literal"><span class=
"pre">std::pair
<</span></tt>
106 <tt class=
"docutils literal"><span class=
"pre">vertex_iterator,
</span></tt>
107 <tt class=
"docutils literal"><span class=
"pre">vertex_iterator
></span></tt></td>
108 <td>Returns an iterator range
109 providing access to the local
110 vertices in the graph.
</td>
112 <tr><td>Number of local
114 <td><tt class=
"docutils literal"><span class=
"pre">num_vertices(g)
</span></tt></td>
115 <td><tt class=
"docutils literal"><span class=
"pre">vertices_size_type
</span></tt></td>
116 <td>Returns the number of vertices
117 stored locally in the graph.
</td>
122 <div class=
"section" id=
"models">
123 <h1><a class=
"toc-backref" href=
"#id6">Models
</a></h1>
126 <li><a class=
"reference external" href=
"distributed_adjacency_list.html">Distributed adjacency list
</a></li>
129 <hr class=
"docutils" />
130 <p>Copyright (C)
2005 The Trustees of Indiana University.
</p>
131 <p>Authors: Douglas Gregor and Andrew Lumsdaine
</p>
135 <hr class=
"footer" />
136 Generated on:
2009-
05-
31 00:
21 UTC.
137 Generated by
<a class=
"reference external" href=
"http://docutils.sourceforge.net/">Docutils
</a> from
<a class=
"reference external" href=
"http://docutils.sourceforge.net/rst.html">reStructuredText
</a> source.