doc/html/boost/graph_traits__idp112840672.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct graph_traits&lt;mpi::graph_communicator&gt;</title>
   5 <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../mpi/reference.html#header.boost.mpi.graph_communicator_hpp" title="Header &lt;boost/mpi/graph_communicator.hpp&gt;">
   9 <link rel="prev" href="mpi/get_idp212832304.html" title="Function get">
  10 <link rel="next" href="mpi/group.html" title="Class group">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
  15 <td align="center"><a href="../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="mpi/get_idp212832304.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mpi/reference.html#header.boost.mpi.graph_communicator_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mpi/group.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.graph_traits__idp112840672"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct graph_traits&lt;mpi::graph_communicator&gt;</span></h2>
  29 <p>boost::graph_traits&lt;mpi::graph_communicator&gt; &#8212; Traits structure that allows a communicator with graph topology to be view as a graph by the Boost Graph Library. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../mpi/reference.html#header.boost.mpi.graph_communicator_hpp" title="Header &lt;boost/mpi/graph_communicator.hpp&gt;">boost/mpi/graph_communicator.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">struct</span> <a class="link" href="graph_traits__idp112840672.html" title="Struct graph_traits&lt;mpi::graph_communicator&gt;">graph_traits</a><span class="special">&lt;</span><span class="identifier">mpi</span><span class="special">::</span><span class="identifier">graph_communicator</span><span class="special">&gt;</span> <span class="special">{</span>
  36   <span class="comment">// types</span>
  37   <span class="keyword">typedef</span> <span class="keyword">int</span>                        <a name="boost.graph_traits__idp112840672.vertex_descriptor"></a><span class="identifier">vertex_descriptor</span><span class="special">;</span>
  38   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">&gt;</span>      <a name="boost.graph_traits__idp112840672.edge_descriptor"></a><span class="identifier">edge_descriptor</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">directed_tag</span>               <a name="boost.graph_traits__idp112840672.directed_category"></a><span class="identifier">directed_category</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">disallow_parallel_edge_tag</span> <a name="boost.graph_traits__idp112840672.edge_parallel_category"></a><span class="identifier">edge_parallel_category</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                <a name="boost.graph_traits__idp112840672.out_edge_iterator"></a><span class="identifier">out_edge_iterator</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="keyword">int</span>                        <a name="boost.graph_traits__idp112840672.degree_size_type"></a><span class="identifier">degree_size_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                <a name="boost.graph_traits__idp112840672.adjacency_iterator"></a><span class="identifier">adjacency_iterator</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">counting_iterator</span><span class="special">&lt;</span> <span class="keyword">int</span> <span class="special">&gt;</span>   <a name="boost.graph_traits__idp112840672.vertex_iterator"></a><span class="identifier">vertex_iterator</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="keyword">int</span>                        <a name="boost.graph_traits__idp112840672.vertices_size_type"></a><span class="identifier">vertices_size_type</span><span class="special">;</span>
  46   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                <a name="boost.graph_traits__idp112840672.edge_iterator"></a><span class="identifier">edge_iterator</span><span class="special">;</span>
  47   <span class="keyword">typedef</span> <span class="keyword">int</span>                        <a name="boost.graph_traits__idp112840672.edges_size_type"></a><span class="identifier">edges_size_type</span><span class="special">;</span>
  48
  49   <span class="comment">// <a class="link" href="graph_traits__idp112840672.html#idp209757888-bb">public static functions</a></span>
  50   <span class="keyword">static</span> <span class="identifier">vertex_descriptor</span> <a class="link" href="graph_traits__idp112840672.html#idp209758448-bb"><span class="identifier">null_vertex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  51 <span class="special">}</span><span class="special">;</span></pre></div>
  52 <div class="refsect1">
  53 <a name="idp340185472"></a><h2>Description</h2>
  54 <p>The specialization of <code class="computeroutput">graph_traits</code> for an MPI communicator allows a communicator with graph topology to be viewed as a graph. An MPI communicator with graph topology meets the requirements of the Graph, Incidence Graph, Adjacency Graph, Vertex List Graph, and Edge List Graph concepts from the Boost Graph Library. </p>
  55 <div class="refsect2">
  56 <a name="idp340187168"></a><h3>
  57 <a name="idp209757888-bb"></a><code class="computeroutput">graph_traits</code> public static functions</h3>
  58 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  59 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">vertex_descriptor</span> <a name="idp209758448-bb"></a><span class="identifier">null_vertex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns a vertex descriptor that can never refer to any valid vertex. </li></ol></div>
  60 </div>
  61 </div>
  62 </div>
  63 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  64 <td align="left"></td>
  65 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2007 Douglas Gregor,
  66       Matthias Troyer, Trustees of Indiana University<p>
  67         Distributed under the Boost Software License, Version 1.0. (See accompanying
  68         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">
  69         http://www.boost.org/LICENSE_1_0.txt </a>)
  70       </p>
  71 </div></td>
  72 </tr></table>
  73 <hr>
  74 <div class="spirit-nav">
  75 <a accesskey="p" href="mpi/get_idp212832304.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mpi/reference.html#header.boost.mpi.graph_communicator_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="mpi/group.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
  76 </div>
  77 </body>
  78 </html>