mirror of
https://github.com/boostorg/graph.git
synced 2026-01-29 07:32:21 +00:00
201 lines
4.7 KiB
HTML
201 lines
4.7 KiB
HTML
<HTML>
|
|
<!--
|
|
-- Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
|
|
--
|
|
-- Permission to use, copy, modify, distribute and sell this software
|
|
-- and its documentation for any purpose is hereby granted without fee,
|
|
-- provided that the above copyright notice appears in all copies and
|
|
-- that both that copyright notice and this permission notice appear
|
|
-- in supporting documentation. We make no
|
|
-- representations about the suitability of this software for any
|
|
-- purpose. It is provided "as is" without express or implied warranty.
|
|
-->
|
|
<Head>
|
|
<Title>Boost Graph Library: Uniform Cost Visitor</Title>
|
|
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
|
|
ALINK="#ff0000">
|
|
<IMG SRC="../../../c++boost.gif"
|
|
ALT="C++ Boost" width="277" height="86">
|
|
|
|
<BR Clear>
|
|
|
|
<H1>Uniform Cost Visitor Concept</H1>
|
|
|
|
This concept defines the visitor interface for <a
|
|
href="./uniform_cost_search.html"><tt>uniform_cost_search()</tt></a>
|
|
and related algorithms. The user can create a class that matches this
|
|
interface, and then pass objects of the class into
|
|
<tt>uniform_cost_search()</tt> to augment the actions taken during the
|
|
search.
|
|
|
|
<h3>Refinement of</h3>
|
|
|
|
<a href="../../utility/CopyConstructible.html">Copy Constructible</a>
|
|
(copying a visitor should be a lightweight operation).
|
|
|
|
|
|
<h3>Notation</h3>
|
|
|
|
<Table>
|
|
<TR>
|
|
<TD><tt>V</tt></TD>
|
|
<TD>A type that is a model of Uniform Cost Visitor.</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><tt>vis</tt></TD>
|
|
<TD>An object of type <tt>V</tt>.</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><tt>G</tt></TD>
|
|
<TD>A type that is a model of Graph.</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><tt>g</tt></TD>
|
|
<TD>An object of type <tt>G</tt>.</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><tt>e</tt></TD>
|
|
<TD>An object of type <tt>boost::graph_traits<G>::edge_descriptor</tt>.</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><tt>s,u,v</tt></TD>
|
|
<TD>An object of type <tt>boost::graph_traits<G>::vertex_descriptor</tt>.</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><tt>DistanceMap</tt></TD>
|
|
<TD>A type that is a model of <a href="../../property_map/ReadWritePropertyMap.html">ReadWritePropertyMap</a>.</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><tt>d</tt></TD>
|
|
<TD>An object of type <tt>DistanceMap</tt>.</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><tt>WeightMap</tt></TD>
|
|
<TD>A type that is a model of <a href="../../property_map/ReadWritePropertyMap.html">ReadablePropertyMap</a>.</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><tt>w</tt></TD>
|
|
<TD>An object of type <tt>DistanceMap</tt>.</TD>
|
|
</TR>
|
|
|
|
</table>
|
|
|
|
<h3>Associated Types</h3>
|
|
|
|
none
|
|
<p>
|
|
|
|
<h3>Valid Expressions</h3>
|
|
|
|
<table border>
|
|
<tr>
|
|
<th>Name</th><th>Expression</th><th>Return Type</th><th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Initialize Vertex</td>
|
|
<td><tt>vis.initialize_vertex(u, g)</tt></td>
|
|
<td><tt>void</tt></td>
|
|
<td>
|
|
This is invoked one each vertex of the graph when it is initialized.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Start Vertex</td>
|
|
<td><tt>vis.start_vertex(u, g)</tt></td>
|
|
<td><tt>void</tt></td>
|
|
<td>
|
|
This is invoked on the source vertex at the beginning of the algorithm.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Discover Vertex</td>
|
|
<td><tt>vis.discover_vertex(u, g)</tt></td>
|
|
<td><tt>void</tt></td>
|
|
<td>
|
|
This is invoked when a vertex is encountered for the first time.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Examine Edge</td>
|
|
<td><tt>vis.examine_edge(e, g)</tt></td>
|
|
<td><tt>void</tt></td>
|
|
<td>
|
|
This is invoked on every out-edge of each vertex after it is discovered.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Edge Relaxed</td>
|
|
<td><tt>vis.edge_relaxed(e, g)</tt></td>
|
|
<td><tt>void</tt></td>
|
|
<td>
|
|
Upon examination, if the following condition holds then the edge
|
|
is relaxed (its distance is reduced), and this method is invoked.<br>
|
|
<tt>
|
|
tie(u,v) = incident(e, g);<br>
|
|
D d_u = get(d, u), d_v = get(d, v);<br>
|
|
W w_e = get(w, e);<br>
|
|
assert(compare(combine(d_u, w_e), d_v));<br>
|
|
</tt>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Edge Not Relaxed</td>
|
|
<td><tt>vis.edge_not_relaxed(e, g)</tt></td>
|
|
<td><tt>void</tt></td>
|
|
<td>
|
|
Upon examination, if the edge is not relaxed (see above) then
|
|
this method is invoked.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Finish Vertex</td>
|
|
<td><tt>vis.finish_vertex(u, g)</tt></td>
|
|
<td><tt>void</tt></td>
|
|
<td>
|
|
This invoked on a vertex after all of its out edges have been added to the
|
|
search tree and all of the adjacent vertices have been discovered
|
|
(but before their out-edges have been examined).
|
|
</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<h3>Models</h3>
|
|
|
|
<ul>
|
|
<li><a href="./ucs_visitor.html"><tt>ucs_visitor</tt></a>
|
|
</ul>
|
|
|
|
<br>
|
|
<HR>
|
|
<TABLE>
|
|
<TR valign=top>
|
|
<TD nowrap>Copyright © 2000</TD><TD>
|
|
<A HREF="../../../people/jeremy_siek.htm">Jeremy Siek</A>,
|
|
Univ.of Notre Dame (<A
|
|
HREF="mailto:jsiek@lsc.nd.edu">jsiek@lsc.nd.edu</A>)<br>
|
|
<A HREF="../../../people/liequan_lee.htm">Lie-Quan Lee</A>, Univ.of Notre Dame (<A HREF="mailto:llee1@lsc.nd.edu">llee1@lsc.nd.edu</A>)<br>
|
|
<A HREF=http://www.lsc.nd.edu/~lums>Andrew Lumsdaine</A>,
|
|
Univ.of Notre Dame (<A
|
|
HREF="mailto:lums@lsc.nd.edu">lums@lsc.nd.edu</A>)
|
|
</TD></TR></TABLE>
|
|
|
|
</BODY>
|
|
</HTML>
|