Version_1_18_3/boost/libs/graph/docs/dfs_visitor.html

   1 <HTML>
   2 <!--
   3   -- Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
   4   --
   5   -- Permission to use, copy, modify, distribute and sell this software
   6   -- and its documentation for any purpose is hereby granted without fee,
   7   -- provided that the above copyright notice appears in all copies and
   8   -- that both that copyright notice and this permission notice appear
   9   -- in supporting documentation.  We make no
  10   -- representations about the suitability of this software for any
  11   -- purpose.  It is provided "as is" without express or implied warranty.
  12   -->
  13 <Head>
  14 <Title>Boost Graph Library: dfs_visitor</Title>
  15 <BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
  16         ALINK="#ff0000">
  17 <IMG SRC="../../../c++boost.gif"
  18      ALT="C++ Boost" width="277" height="86">
  19
  20 <BR Clear>
  21
  22 <H1>
  23 <pre>
  24 dfs_visitor&lt;EventVisitorList&gt;
  25 </pre>
  26 </H1>
  27
  28 This class is an adapter that converts a list of <a
  29 href="./EventVisitor.html">EventVisitor</a>'s (constructed using
  30 <tt>std::pair</tt>) into a <a href="./DFSVisitor.html">DFSVisitor</a>.
  31
  32
  33 <h3>Example</h3>
  34
  35 See the example for <a href="./EventVisitor.html">EventVisitor</a>.
  36
  37 <h3>Model of</h3>
  38
  39 <a href="./DFSVisitor.html">DFSVisitor</a>
  40
  41 <H3>Template Parameters</H3>
  42
  43 <P>
  44 <TABLE border>
  45 <TR>
  46 <th>Parameter</th><th>Description</th><th>Default</th>
  47 </tr>
  48
  49 <TR><TD><TT>EventVisitorList</TT></TD>
  50 <TD>
  51 A list of <a href="./EventVisitor.html">EventVisitor</a>'s created
  52 with <tt>std::pair</tt>.
  53 </TD>
  54 <TD><TT><a href="./null_visitor.html"><tt>null_visitor</tt></a></TT></TD>
  55 </TR>
  56
  57 </table>
  58
  59 <H3>Where Defined</H3>
  60
  61 <P>
  62 <a href="../../../boost/graph/depth_first_search.hpp">
  63 <TT>boost/graph/depth_first_search.hpp</TT></a>
  64
  65 <h3>Member Functions</h3>
  66
  67 This class implements all of the member functions required by <a
  68 href="./DFSVisitor.html">DFSVisitor</a>. In each function the
  69 appropriate event is dispatched to the <a
  70 href="./EventVisitor.html">EventVisitor</a>'s in the EventVisitorList.
  71
  72 <h3>Non-Member Functions</h3>
  73
  74 <table border>
  75 <tr>
  76 <th>Function</th><th>Description</th>
  77 </tr>
  78
  79 <tr><td><tt>
  80 template &lt;class EventVisitorList&gt;<br>
  81 dfs_visitor&lt;EventVisitorList&gt;<br>
  82 make_dfs_visitor(EventVisitorList ev_list);
  83 </tt></td><td>
  84 Returns the event visitor list adapted to be a DFS visitor.
  85 </td></tr>
  86
  87 </table>
  88
  89 <h3>See Also</h3>
  90
  91 <a href="./visitor_concepts.html">Visitor concepts</a>
  92 <p>
  93 The following are event visitors: <a
  94  href="./predecessor_recorder.html"><tt>predecessor_recorder</tt></a>,
  95 <a href="./distance_recorder.html"><tt>distance_recorder</tt></a>,
  96 <a href="./time_stamper.html"><tt>time_stamper</tt></a>,
  97 and <a href="./property_writer.html"><tt>property_writer</tt></a>.
  98
  99
 100 <br>
 101 <HR>
 102 <TABLE>
 103 <TR valign=top>
 104 <TD nowrap>Copyright &copy 2000</TD><TD>
 105 <A HREF=http://www.boost.org/people/jeremy_siek.htm>Jeremy Siek</A>,
 106 Univ.of Notre Dame (<A
 107 HREF="mailto:jsiek@lsc.nd.edu">jsiek@lsc.nd.edu</A>)<br>
 108 <A HREF=http://www.lsc.nd.edu/~llee1>Lie-Quan Lee</A>, Univ.of Notre Dame (<A HREF="mailto:llee1@lsc.nd.edu">llee1@lsc.nd.edu</A>)<br>
 109 <A HREF=http://www.lsc.nd.edu/~lums>Andrew Lumsdaine</A>,
 110 Univ.of Notre Dame (<A
 111 HREF="mailto:lums@lsc.nd.edu">lums@lsc.nd.edu</A>)
 112 </TD></TR></TABLE>
 113
 114 </BODY>
 115 </HTML>