ceph/src/boost/libs/graph/doc/dijkstra_visitor.html

   1 <HTML>
   2 <!--
   3      Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
   4
   5      Distributed under the Boost Software License, Version 1.0.
   6      (See accompanying file LICENSE_1_0.txt or copy at
   7      http://www.boost.org/LICENSE_1_0.txt)
   8   -->
   9 <Head>
  10 <Title>Boost Graph Library: dijkstra_visitor</Title>
  11 <BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
  12         ALINK="#ff0000">
  13 <IMG SRC="../../../boost.png"
  14      ALT="C++ Boost" width="277" height="86">
  15
  16 <BR Clear>
  17
  18 <H1>
  19 <pre>
  20 dijkstra_visitor&lt;EventVisitorList&gt;
  21 </pre>
  22 </H1>
  23
  24 This class is an adapter that converts a list of <a
  25 href="./EventVisitor.html">EventVisitor</a>s (constructed using
  26 <tt>std::pair</tt>) into a <a
  27 href="./DijkstraVisitor.html">DijkstraVisitor</a>.
  28
  29
  30 <h3>Example</h3>
  31
  32 This is an excerpt from <a
  33 href="../example/dave.cpp"><tt>examples/dave.cpp</tt></a>
  34 where the <tt>copy_graph</tt> single-event visitor
  35 is used to create a copy the shortest-paths search-tree calculated
  36 by Dijkstra's algorithm.
  37
  38 <pre>
  39 boost::dijkstra_shortest_paths
  40   (G, vertex(a, G),
  41    distance_map(make_iterator_property_map(distance.begin(), vertex_id, distance[0])).
  42    predecessor_map(make_iterator_property_map(parent.begin(), vertex_id, parent[0])).
  43    visitor(make_dijkstra_visitor(copy_graph(G_copy, on_examine_edge()))));
  44 </pre>
  45
  46
  47 <h3>Model of</h3>
  48
  49 <a href="./DijkstraVisitor.html">Dijkstra Visitor</a>
  50
  51 <H3>Template Parameters</H3>
  52
  53 <P>
  54 <TABLE border>
  55 <TR>
  56 <th>Parameter</th><th>Description</th><th>Default</th>
  57 </tr>
  58
  59 <TR><TD><TT>EventVisitorList</TT></TD>
  60 <TD>
  61 A list of <a href="./EventVisitor.html">EventVisitor</a>'s created
  62 with <tt>std::pair</tt>.
  63 </TD>
  64 <TD><TT><a href="./null_visitor.html"><tt>null_visitor</tt></a></TT></TD>
  65 </TR>
  66
  67 </table>
  68
  69 <H3>Where Defined</H3>
  70
  71 <P>
  72 <a href="../../../boost/graph/dijkstra_shortest_paths.hpp">
  73 <TT>boost/graph/dijkstra_shortest_paths.hpp</TT></a>
  74
  75 <h3>Member Functions</h3>
  76
  77 This class implements all of the member functions required by <a
  78 href="./DijkstraVisitor.html">DijkstraVisitor</a>. In each
  79 function the appropriate event is dispatched to the <a
  80 href="./EventVisitor.html">EventVisitor</a> in the EventVisitorList.
  81
  82 <h3>Non-Member Functions</h3>
  83
  84 <table border>
  85 <tr>
  86 <th>Function</th><th>Description</th>
  87 </tr>
  88
  89 <tr><td><tt>
  90 template &lt;class EventVisitorList&gt;<br>
  91 dijkstra_visitor&lt;EventVisitorList&gt;<br>
  92 make_dijkstra_visitor(EventVisitorList ev_list);
  93 </tt></td><td>
  94 Returns the event visitor list adapted to be a Dijkstra Visitor.
  95 </td></tr>
  96
  97 </table>
  98
  99 <h3>See Also</h3>
 100
 101 <a href="./visitor_concepts.html">Visitor concepts</a>
 102 <p>
 103 The following are event visitors: <a
 104  href="./predecessor_recorder.html"><tt>predecessor_recorder</tt></a>,
 105 <a href="./distance_recorder.html"><tt>distance_recorder</tt></a>
 106 <a href="./time_stamper.html"><tt>time_stamper</tt></a>,
 107 and <a href="./property_writer.html"><tt>property_writer</tt></a>.
 108
 109
 110 <br>
 111 <HR>
 112 <TABLE>
 113 <TR valign=top>
 114 <TD nowrap>Copyright &copy; 2000-2001</TD><TD>
 115 <A HREF="http://www.boost.org/people/jeremy_siek.htm">Jeremy Siek</A>,
 116 Indiana University (<A
 117 HREF="mailto:jsiek@osl.iu.edu">jsiek@osl.iu.edu</A>)<br>
 118 <A HREF="http://www.boost.org/people/liequan_lee.htm">Lie-Quan Lee</A>, Indiana University (<A HREF="mailto:llee@cs.indiana.edu">llee@cs.indiana.edu</A>)<br>
 119 <A HREF="http://www.osl.iu.edu/~lums">Andrew Lumsdaine</A>,
 120 Indiana University (<A
 121 HREF="mailto:lums@osl.iu.edu">lums@osl.iu.edu</A>)
 122 </TD></TR></TABLE>
 123
 124 </BODY>
 125 </HTML>