|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r75862 - trunk/libs/graph/doc
From: jewillco_at_[hidden]
Date: 2011-12-07 20:59:22
Author: jewillco
Date: 2011-12-07 20:59:21 EST (Wed, 07 Dec 2011)
New Revision: 75862
URL: http://svn.boost.org/trac/boost/changeset/75862
Log:
Added documentation for edge_predecessor_recorder and fixed several typos in other doc pages
Added:
trunk/libs/graph/doc/edge_predecessor_recorder.html
- copied, changed from r75860, /trunk/libs/graph/doc/predecessor_recorder.html
Text files modified:
trunk/libs/graph/doc/distance_recorder.html | 2
trunk/libs/graph/doc/edge_predecessor_recorder.html | 57 +++++++++++++++++++++------------------
trunk/libs/graph/doc/predecessor_recorder.html | 4 +-
trunk/libs/graph/doc/table_of_contents.html | 1
4 files changed, 35 insertions(+), 29 deletions(-)
Modified: trunk/libs/graph/doc/distance_recorder.html
==============================================================================
--- trunk/libs/graph/doc/distance_recorder.html (original)
+++ trunk/libs/graph/doc/distance_recorder.html 2011-12-07 20:59:21 EST (Wed, 07 Dec 2011)
@@ -153,7 +153,7 @@
<a href="./visitor_concepts.html">Visitor concepts</a>
<p>
The following are other event visitors: <a
- href="./distance_recorder.html"><tt>predecessor_recorder</tt></a>,
+ href="./predecessor_recorder.html"><tt>predecessor_recorder</tt></a>,
<a href="./time_stamper.html"><tt>time_stamper</tt></a>,
and property_writer.
Copied: trunk/libs/graph/doc/edge_predecessor_recorder.html (from r75860, /trunk/libs/graph/doc/predecessor_recorder.html)
==============================================================================
--- /trunk/libs/graph/doc/predecessor_recorder.html (original)
+++ trunk/libs/graph/doc/edge_predecessor_recorder.html 2011-12-07 20:59:21 EST (Wed, 07 Dec 2011)
@@ -7,7 +7,7 @@
http://www.boost.org/LICENSE_1_0.txt)
-->
<Head>
-<Title>Boost Graph Library: predecessor_recorder</Title>
+<Title>Boost Graph Library: edge_predecessor_recorder</Title>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
ALINK="#ff0000">
<IMG SRC="../../../boost.png"
@@ -17,21 +17,26 @@
<H1>
<pre>
-predecessor_recorder<PredecessorMap, EventTag>
+edge_predecessor_recorder<PredEdgeMap, EventTag>
</pre>
</H1>
This is an EventVisitor that records
-the predecessor (or parent) of a vertex in a predecessor property
+the predecessor (or parent) edge of a vertex in a property
map. This is particularly useful in graph search algorithms where
recording the predecessors is an efficient way to encode the search
-tree that was traversed during the search. The predecessor recorder is
+tree that was traversed during the search. The edge predecessor recorder is
typically used with the <tt>on_tree_edge</tt> or
-<tt>on_relax_edge</tt> events and cannot be used with vertex events.
+<tt>on_relax_edge</tt> events and cannot be used with vertex events. This
+visitor is meant to be used instead of <a
+href="predecessor_recorder.html"><tt>predecessor_recorder</tt></a> when a
+graph has parallel edges and it is necessary to know which incoming edge a
+search algorithm
+used to get to a particular vertex.
<p>
-<tt>predecessor_recorder</tt> can be used with graph algorithms by
-wrapping it with the algorithm specific adaptor, such as <a
+<tt>edge_predecessor_recorder</tt> can be used with graph algorithms by
+wrapping it with an algorithm-specific adaptor, such as <a
href="./bfs_visitor.html"><tt>bfs_visitor</tt></a> and <a
href="./dfs_visitor.html"><tt>dfs_visitor</tt></a>. Also, this event
visitor can be combined with other event visitors using
@@ -39,18 +44,19 @@
<p>
Algorithms such as Dijkstra's and breadth-first search will not assign
-a predecessor to the source vertex (which is the root of the search
+a predecessor edge to the source vertex (which is the root of the search
tree). It is often useful to initialize the source vertex's
-predecessor to itself, thereby identifying the root vertex as the only
-vertex which is its own parent. When using an algorithm like
+predecessor to a special value, thereby identifying the root vertex.
+When using an algorithm like
depth-first search that creates a forest (multiple search trees) it
-is useful to intialize the predecessor of every vertex to itself. This
+is useful to do the same for every vertex. This
way all the root nodes can be distinguished.
-<h3>Example</h3>
+<!-- <h3>Example</h3>
See the example for bfs_visitor.
+-->
<h3>Model of</h3>
@@ -71,19 +77,18 @@
<th>Parameter</th><th>Description</th><th>Default</th>
</tr>
-<TR><TD><TT>PredecessorMap</TT></TD>
+<TR><TD><TT>PredEdgeMap</TT></TD>
<TD>
A <a
href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap</a>
-where the key type and the value type are the vertex descriptor type
-of the graph.
+where the key and value types are the vertex and edge descriptor types, respectively, of the graph.
</TD>
<TD> </TD>
</TR>
<TR><TD><TT>EventTag</TT></TD>
<TD>
-The tag to specify when the <tt>predecessor_recorder</tt> should be
+The tag to specify when the <tt>edge_predecessor_recorder</tt> should be
applied during the graph algorithm. <tt>EventTag</tt> must be an
edge event.
</TD>
@@ -101,7 +106,7 @@
</tr>
<tr>
-<td><tt>predecessor_recorder::event_filter</tt></td>
+<td><tt>edge_predecessor_recorder::event_filter</tt></td>
<td>
This will be the same type as the template parameter <tt>EventTag</tt>.
</td>
@@ -120,10 +125,10 @@
<tr>
<td><tt>
-predecessor_recorder(PredecessorMap pa);
+edge_predecessor_recorder(PredEdgeMap pa);
</tt></td>
<td>
-Construct a predecessor recorder object with predecessor property map
+Construct an edge predecessor recorder object with predecessor property map
<tt>pa</tt>.
</td>
</tr>
@@ -134,8 +139,8 @@
void operator()(Edge e, const Graph& g);
</tt></td>
<td>
-Given edge <i>e = (u,v)</i>, this records <i>u</i> as the
-predecessor (or parent) of <i>v</i>.
+Given edge <i>e = (u,v)</i>, this records <i>e</i> as the
+predecessor (or parent) edge of <i>v</i>.
</td>
</tr>
@@ -149,11 +154,11 @@
</tr>
<tr><td><tt>
-template <class PredecessorMap, class Tag><br>
-predecessor_recorder<PredecessorMap, Tag> <br>
-record_predecessors(PredecessorMap pa, Tag);
+template <class PredEdgeMap, class Tag><br>
+edge_predecessor_recorder<PredEdgeMap, Tag> <br>
+record_edge_predecessors(PredEdgeMap pa, Tag);
</tt></td><td>
-A convenient way to create a <tt>predecessor_recorder</tt>.
+A convenient way to create a <tt>edge_predecessor_recorder</tt>.
</td></tr>
</table>
@@ -184,7 +189,7 @@
</BODY>
</HTML>
-<!-- LocalWords: PredecessorMap EventTag EventVisitor map bfs dfs const
+<!-- LocalWords: PredEdgeMap EventTag EventVisitor map bfs dfs const
-->
<!-- LocalWords: EventVisitorList WritablePropertyMap Siek Univ Quan
-->
Modified: trunk/libs/graph/doc/predecessor_recorder.html
==============================================================================
--- trunk/libs/graph/doc/predecessor_recorder.html (original)
+++ trunk/libs/graph/doc/predecessor_recorder.html 2011-12-07 20:59:21 EST (Wed, 07 Dec 2011)
@@ -31,7 +31,7 @@
<p>
<tt>predecessor_recorder</tt> can be used with graph algorithms by
-wrapping it with the algorithm specific adaptor, such as <a
+wrapping it with an algorithm-specific adaptor, such as <a
href="./bfs_visitor.html"><tt>bfs_visitor</tt></a> and <a
href="./dfs_visitor.html"><tt>dfs_visitor</tt></a>. Also, this event
visitor can be combined with other event visitors using
@@ -44,7 +44,7 @@
predecessor to itself, thereby identifying the root vertex as the only
vertex which is its own parent. When using an algorithm like
depth-first search that creates a forest (multiple search trees) it
-is useful to intialize the predecessor of every vertex to itself. This
+is useful to initialize the predecessor of every vertex to itself. This
way all the root nodes can be distinguished.
Modified: trunk/libs/graph/doc/table_of_contents.html
==============================================================================
--- trunk/libs/graph/doc/table_of_contents.html (original)
+++ trunk/libs/graph/doc/table_of_contents.html 2011-12-07 20:59:21 EST (Wed, 07 Dec 2011)
@@ -90,6 +90,7 @@
<li>Event Visitors
<OL>
<LI>predecessor_recorder
+ <LI>edge_predecessor_recorder
<LI>distance_recorder
<LI>time_stamper
<LI>property_writer
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk