DistributedEdgeListGraph.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  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. <!-- Copyright (C) 2004-2008 The Trustees of Indiana University.
  14. Use, modification and distribution is subject to the Boost Software
  15. License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  16. http://www.boost.org/LICENSE_1_0.txt) -->
  17. <div class="contents topic" id="contents">
  18. <p class="topic-title first">Contents</p>
  19. <ul class="simple">
  20. <li><a class="reference internal" href="#description" id="id1">Description</a></li>
  21. <li><a class="reference internal" href="#notation" id="id2">Notation</a></li>
  22. <li><a class="reference internal" href="#refinement-of" id="id3">Refinement of</a></li>
  23. <li><a class="reference internal" href="#associated-types" id="id4">Associated types</a></li>
  24. <li><a class="reference internal" href="#valid-expressions" id="id5">Valid Expressions</a></li>
  25. <li><a class="reference internal" href="#models" id="id6">Models</a></li>
  26. </ul>
  27. </div>
  28. <div class="section" id="description">
  29. <h1><a class="toc-backref" href="#id1">Description</a></h1>
  30. <p>A Distributed Edge List Graph is a graph whose vertices are
  31. distributed across multiple processes or address spaces. The
  32. <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
  33. 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
  34. the local set (and size of the local set) of vertices.</p>
  35. </div>
  36. <div class="section" id="notation">
  37. <h1><a class="toc-backref" href="#id2">Notation</a></h1>
  38. <dl class="docutils">
  39. <dt>G</dt>
  40. <dd>A type that models the Distributed Edge List Graph concept.</dd>
  41. <dt>g</dt>
  42. <dd>An object of type <tt class="docutils literal"><span class="pre">G</span></tt>.</dd>
  43. </dl>
  44. </div>
  45. <div class="section" id="refinement-of">
  46. <h1><a class="toc-backref" href="#id3">Refinement of</a></h1>
  47. <blockquote>
  48. <ul class="simple">
  49. <li><a class="reference external" href="http://www.boost.org/libs/graph/doc/Graph.html">Graph</a></li>
  50. </ul>
  51. </blockquote>
  52. </div>
  53. <div class="section" id="associated-types">
  54. <h1><a class="toc-backref" href="#id4">Associated types</a></h1>
  55. <table border="1" class="docutils">
  56. <colgroup>
  57. <col width="18%" />
  58. <col width="44%" />
  59. <col width="38%" />
  60. </colgroup>
  61. <tbody valign="top">
  62. <tr><td>Edge
  63. descriptor type</td>
  64. <td><tt class="docutils literal"><span class="pre">graph_traits&lt;G&gt;::edge_descriptor</span></tt></td>
  65. <td>Must model the
  66. <a class="reference external" href="GlobalDescriptor.html">Global Descriptor</a> concept.</td>
  67. </tr>
  68. <tr><td>Edge iterator
  69. type</td>
  70. <td><tt class="docutils literal"><span class="pre">graph_traits&lt;G&gt;::edge_iterator</span></tt></td>
  71. <td>Iterates over edges stored
  72. locally. The value type must be
  73. <tt class="docutils literal"><span class="pre">edge_descriptor</span></tt>.</td>
  74. </tr>
  75. <tr><td>Edges size
  76. type</td>
  77. <td><tt class="docutils literal"><span class="pre">graph_traits&lt;G&gt;::edges_size_type</span></tt></td>
  78. <td>The unsigned integral type used
  79. to store the number of edges
  80. in the local subgraph.</td>
  81. </tr>
  82. </tbody>
  83. </table>
  84. </div>
  85. <div class="section" id="valid-expressions">
  86. <h1><a class="toc-backref" href="#id5">Valid Expressions</a></h1>
  87. <table border="1" class="docutils">
  88. <colgroup>
  89. <col width="17%" />
  90. <col width="22%" />
  91. <col width="23%" />
  92. <col width="39%" />
  93. </colgroup>
  94. <thead valign="bottom">
  95. <tr><th class="head">Name</th>
  96. <th class="head">Expression</th>
  97. <th class="head">Type</th>
  98. <th class="head">Semantics</th>
  99. </tr>
  100. </thead>
  101. <tbody valign="top">
  102. <tr><td>Local edge set</td>
  103. <td><tt class="docutils literal"><span class="pre">edges(g)</span></tt></td>
  104. <td><tt class="docutils literal"><span class="pre">std::pair&lt;</span></tt>
  105. <tt class="docutils literal"><span class="pre">edge_iterator,</span></tt>
  106. <tt class="docutils literal"><span class="pre">edge_iterator&gt;</span></tt></td>
  107. <td>Returns an iterator range
  108. providing access to the local
  109. edges in the graph.</td>
  110. </tr>
  111. <tr><td>Number of local
  112. edges.</td>
  113. <td><tt class="docutils literal"><span class="pre">num_edges(g)</span></tt></td>
  114. <td><tt class="docutils literal"><span class="pre">edges_size_type</span></tt></td>
  115. <td>Returns the number of edges
  116. stored locally in the graph.</td>
  117. </tr>
  118. </tbody>
  119. </table>
  120. </div>
  121. <div class="section" id="models">
  122. <h1><a class="toc-backref" href="#id6">Models</a></h1>
  123. <blockquote>
  124. <ul class="simple">
  125. <li><a class="reference external" href="distributed_adjacency_list.html">Distributed adjacency list</a></li>
  126. </ul>
  127. </blockquote>
  128. <hr class="docutils" />
  129. <p>Copyright (C) 2005 The Trustees of Indiana University.</p>
  130. <p>Authors: Douglas Gregor and Andrew Lumsdaine</p>
  131. </div>
  132. </div>
  133. <div class="footer">
  134. <hr class="footer" />
  135. Generated on: 2009-05-31 00:21 UTC.
  136. 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.
  137. </div>
  138. </body>
  139. </html>