ceph/src/boost/libs/graph_parallel/doc/html/DistributedEdgeListGraph.html

   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">
   4 <head>
   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 Edge List Graph</title>
   8 <link rel="stylesheet" href="../../../../rst.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="logo-concept-distributed-edge-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 Edge List Graph</h1>
  13
  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>
  20 <ul class="simple">
  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>
  27 </ul>
  28 </div>
  29 <div class="section" id="description">
  30 <h1><a class="toc-backref" href="#id1">Description</a></h1>
  31 <p>A Distributed Edge 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/EdgeListGraph.html">Edge List Graph</a> concept, but return only
  35 the local set (and size of the local set) of vertices.</p>
  36 </div>
  37 <div class="section" id="notation">
  38 <h1><a class="toc-backref" href="#id2">Notation</a></h1>
  39 <dl class="docutils">
  40 <dt>G</dt>
  41 <dd>A type that models the Distributed Edge List Graph concept.</dd>
  42 <dt>g</dt>
  43 <dd>An object of type <tt class="docutils literal"><span class="pre">G</span></tt>.</dd>
  44 </dl>
  45 </div>
  46 <div class="section" id="refinement-of">
  47 <h1><a class="toc-backref" href="#id3">Refinement of</a></h1>
  48 <blockquote>
  49 <ul class="simple">
  50 <li><a class="reference external" href="http://www.boost.org/libs/graph/doc/Graph.html">Graph</a></li>
  51 </ul>
  52 </blockquote>
  53 </div>
  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">
  57 <colgroup>
  58 <col width="18%" />
  59 <col width="44%" />
  60 <col width="38%" />
  61 </colgroup>
  62 <tbody valign="top">
  63 <tr><td>Edge
  64 descriptor type</td>
  65 <td><tt class="docutils literal"><span class="pre">graph_traits&lt;G&gt;::edge_descriptor</span></tt></td>
  66 <td>Must model the
  67 <a class="reference external" href="GlobalDescriptor.html">Global Descriptor</a> concept.</td>
  68 </tr>
  69 <tr><td>Edge iterator
  70 type</td>
  71 <td><tt class="docutils literal"><span class="pre">graph_traits&lt;G&gt;::edge_iterator</span></tt></td>
  72 <td>Iterates over edges stored
  73 locally. The value type must be
  74 <tt class="docutils literal"><span class="pre">edge_descriptor</span></tt>.</td>
  75 </tr>
  76 <tr><td>Edges size
  77 type</td>
  78 <td><tt class="docutils literal"><span class="pre">graph_traits&lt;G&gt;::edges_size_type</span></tt></td>
  79 <td>The unsigned integral type used
  80 to store the number of edges
  81 in the local subgraph.</td>
  82 </tr>
  83 </tbody>
  84 </table>
  85 </div>
  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">
  89 <colgroup>
  90 <col width="17%" />
  91 <col width="22%" />
  92 <col width="23%" />
  93 <col width="39%" />
  94 </colgroup>
  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>
 100 </tr>
 101 </thead>
 102 <tbody valign="top">
 103 <tr><td>Local edge set</td>
 104 <td><tt class="docutils literal"><span class="pre">edges(g)</span></tt></td>
 105 <td><tt class="docutils literal"><span class="pre">std::pair&lt;</span></tt>
 106 <tt class="docutils literal"><span class="pre">edge_iterator,</span></tt>
 107 <tt class="docutils literal"><span class="pre">edge_iterator&gt;</span></tt></td>
 108 <td>Returns an iterator range
 109 providing access to the local
 110 edges in the graph.</td>
 111 </tr>
 112 <tr><td>Number of local
 113 edges.</td>
 114 <td><tt class="docutils literal"><span class="pre">num_edges(g)</span></tt></td>
 115 <td><tt class="docutils literal"><span class="pre">edges_size_type</span></tt></td>
 116 <td>Returns the number of edges
 117 stored locally in the graph.</td>
 118 </tr>
 119 </tbody>
 120 </table>
 121 </div>
 122 <div class="section" id="models">
 123 <h1><a class="toc-backref" href="#id6">Models</a></h1>
 124 <blockquote>
 125 <ul class="simple">
 126 <li><a class="reference external" href="distributed_adjacency_list.html">Distributed adjacency list</a></li>
 127 </ul>
 128 </blockquote>
 129 <hr class="docutils" />
 130 <p>Copyright (C) 2005 The Trustees of Indiana University.</p>
 131 <p>Authors: Douglas Gregor and Andrew Lumsdaine</p>
 132 </div>
 133 </div>
 134 <div class="footer">
 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.
 138
 139 </div>
 140 </body>
 141 </html>