|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r56494 - sandbox-branches/birbacher/fix_documentation/libs/graph/doc
From: frank.birbacher_at_[hidden]
Date: 2009-09-30 15:54:11
Author: birbacher
Date: 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
New Revision: 56494
URL: http://svn.boost.org/trac/boost/changeset/56494
Log:
several fixes of documentation of Boost.Graph
Text files modified:
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/AStarVisitor.html | 10 +++++-----
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/BFSVisitor.html | 4 ++--
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/BellmanFordVisitor.html | 4 ++--
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/DFSVisitor.html | 2 +-
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/EventVisitorList.html | 4 ++--
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/bellman_visitor.html | 4 ++--
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/bfs_visitor.html | 4 ++--
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/dfs_visitor.html | 4 ++--
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/dijkstra_visitor.html | 4 ++--
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/distance_recorder.html | 4 ++--
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/predecessor_recorder.html | 12 ++++++------
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/property_writer.html | 6 +++---
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/time_stamper.html | 6 +++---
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/tsp_tour_len_visitor.html | 2 +-
sandbox-branches/birbacher/fix_documentation/libs/graph/doc/visitor_concepts.html | 2 ++
15 files changed, 37 insertions(+), 35 deletions(-)
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/AStarVisitor.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/AStarVisitor.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/AStarVisitor.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -118,7 +118,7 @@
<td><tt>vis.examine_vertex(u, g)</tt></td>
<td><tt>void</tt></td>
<td>
-This is invoked on a vertex as it is popped from the queue (i.e. it
+This is invoked on a vertex as it is popped from the queue (i.e., it
has the lowest cost on the OPEN list). This happens immediately before
<tt>examine_edge()</tt> is invoked on each of the out-edges of vertex
<tt>u</tt>.
@@ -160,7 +160,7 @@
<td><tt>vis.edge_not_relaxed(e, g)</tt></td>
<td><tt>void</tt></td>
<td>
-Upon examination, if an edge is not relaxed (see above), then this
+Upon examination, if an edge is not relaxed (see above) then this
method is invoked.
</td>
</tr>
@@ -171,7 +171,7 @@
<td><tt>void</tt></td>
<td>
This is invoked when a vertex that is on the CLOSED list is
-``rediscovered'' via a more efficient path, and is re-added to the
+``rediscovered'' via a more efficient path and is re-added to the
OPEN list.
</td>
</tr>
@@ -181,8 +181,8 @@
<td><tt>vis.finish_vertex(u, g)</tt></td>
<td><tt>void</tt></td>
<td>
-This is invoked on a vertex when it is added to the CLOSED list, which
-happens after all of its out edges have been examined.
+This is invoked on a vertex when it is added to the CLOSED list. This
+happens after all of its out-edges have been examined.
</td>
</tr>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/BFSVisitor.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/BFSVisitor.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/BFSVisitor.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -140,7 +140,7 @@
<td><tt>vis.gray_target(e, g)</tt></td>
<td><tt>void</tt></td>
<td>
-This is invoked on the subset of non-tree edges who's target vertex is
+This is invoked on the subset of non-tree edges whose target vertex is
colored gray at the time of examination. The color gray indicates
that the vertex is currently in the queue.
</td>
@@ -151,7 +151,7 @@
<td><tt>vis.black_target(e, g)</tt></td>
<td><tt>void</tt></td>
<td>
-This is invoked on the subset of non-tree edges who's target vertex is
+This is invoked on the subset of non-tree edges whose target vertex is
colored black at the time of examination. The color black indicates
that the vertex has been removed from the queue.
</td>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/BellmanFordVisitor.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/BellmanFordVisitor.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/BellmanFordVisitor.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -116,8 +116,8 @@
<td><tt>vis.edge_minimized(e, g)</tt></td>
<td><tt>void</tt></td>
<td>
-After the <tt>num_vertices(g)</tt> iterations through the edge set
-of the graph is complete, one last iteration is made to test whether
+After <tt>num_vertices(g)</tt> iterations through the edge set
+of the graph are completed, one last iteration is made to test whether
each edge was minimized. If the edge is minimized then this function
is invoked.
</td>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/DFSVisitor.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/DFSVisitor.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/DFSVisitor.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -157,7 +157,7 @@
This is invoked on vertex <tt>u</tt> after <tt>finish_vertex</tt> has
been called for all the vertices in the DFS-tree rooted at vertex
<tt>u</tt>. If vertex <tt>u</tt> is a leaf in the DFS-tree, then
-the <tt>finish_vertex</tt> function is call on <tt>u</tt> after
+the <tt>finish_vertex</tt> function is called on <tt>u</tt> after
all the out-edges of <tt>u</tt> have been examined.
</td>
</tr>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/EventVisitorList.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/EventVisitorList.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/EventVisitorList.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -19,7 +19,7 @@
An EventVisitorList is either an <a
href="./EventVisitor.html">EventVisitor</a>, or a list of
-EventVisitor's combined using <tt>std::pair</tt>. Each graph algorithm
+EventVisitors combined using <tt>std::pair</tt>. Each graph algorithm
defines visitor adaptors that convert an EventVisitorList into the
particular kind of visitor needed by the algorithm.
@@ -91,7 +91,7 @@
color.begin());
</pre>
-For creating a list of more than two event visitors, nest calls to
+For creating a list of more than two event visitors you can nest calls to
<tt>std::make_pair</tt> in the following way:
<pre>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/bellman_visitor.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/bellman_visitor.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/bellman_visitor.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -22,7 +22,7 @@
</H1>
This class is an adapter that converts a list of <a
-href="./EventVisitor.html">EventVisitor</a>'s (constructed using
+href="./EventVisitor.html">EventVisitor</a>s (constructed using
<tt>std::pair</tt>) into a <a
href="./BellmanFordVisitor.html">BellmanFordVisitor</a>.
@@ -63,7 +63,7 @@
This class implements all of the member functions required by <a
href="./BellmanFordVisitor.html">BellmanFordVisitor</a>. In each function the
appropriate event is dispatched to the <a
-href="./EventVisitor.html">EventVisitor</a>'s in the EventVisitorList.
+href="./EventVisitor.html">EventVisitor</a> in the EventVisitorList.
<h3>Non-Member Functions</h3>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/bfs_visitor.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/bfs_visitor.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/bfs_visitor.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -22,7 +22,7 @@
</H1>
This class is an adapter that converts a list of <a
-href="./EventVisitor.html">EventVisitor</a>'s (constructed using
+href="./EventVisitor.html">EventVisitor</a>s (constructed using
<tt>std::pair</tt>) into a BFSVisitor.
@@ -80,7 +80,7 @@
This class implements all of the member functions required by <a
href="./BFSVisitor.html">BFSVisitor</a>. In each function the
appropriate event is dispatched to the <a
-href="./EventVisitor.html">EventVisitor</a>'s in the EventVisitorList.
+href="./EventVisitor.html">EventVisitor</a> in the EventVisitorList.
<h3>Non-Member Functions</h3>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/dfs_visitor.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/dfs_visitor.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/dfs_visitor.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -22,7 +22,7 @@
</H1>
This class is an adapter that converts a list of <a
-href="./EventVisitor.html">EventVisitor</a>'s (constructed using
+href="./EventVisitor.html">EventVisitor</a>s (constructed using
<tt>std::pair</tt>) into a DFSVisitor.
@@ -63,7 +63,7 @@
This class implements all of the member functions required by <a
href="./DFSVisitor.html">DFSVisitor</a>. In each function the
appropriate event is dispatched to the <a
-href="./EventVisitor.html">EventVisitor</a>'s in the EventVisitorList.
+href="./EventVisitor.html">EventVisitor</a> in the EventVisitorList.
<h3>Non-Member Functions</h3>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/dijkstra_visitor.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/dijkstra_visitor.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/dijkstra_visitor.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -22,7 +22,7 @@
</H1>
This class is an adapter that converts a list of <a
-href="./EventVisitor.html">EventVisitor</a>'s (constructed using
+href="./EventVisitor.html">EventVisitor</a>s (constructed using
<tt>std::pair</tt>) into a <a
href="./DijkstraVisitor.html">DijkstraVisitor</a>.
@@ -77,7 +77,7 @@
This class implements all of the member functions required by <a
href="./DijkstraVisitor.html">DijkstraVisitor</a>. In each
function the appropriate event is dispatched to the <a
-href="./EventVisitor.html">EventVisitor</a>'s in the EventVisitorList.
+href="./EventVisitor.html">EventVisitor</a> in the EventVisitorList.
<h3>Non-Member Functions</h3>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/distance_recorder.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/distance_recorder.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/distance_recorder.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -27,7 +27,7 @@
source vertex during a graph search. When applied to edge <i>e =
(u,v)</i>, the distance of <i>v</i> is recorded to be one more than
the distance of <i>u</i>. The distance recorder is typically used with
-the <tt>on_tree_edge</tt> or <tt>on_relax_edge</tt> events, and
+the <tt>on_tree_edge</tt> or <tt>on_relax_edge</tt> events and
cannot be used with vertex events.
<p>
@@ -64,7 +64,7 @@
<TR><TD><TT>DistanceMap</TT></TD>
<TD>
A <a
-href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap</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.
</TD>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/predecessor_recorder.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/predecessor_recorder.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/predecessor_recorder.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -27,7 +27,7 @@
recording the predecessors is an efficient way to encode the search
tree that was traversed during the search. The 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.
<p>
<tt>predecessor_recorder</tt> can be used with graph algorithms by
@@ -40,12 +40,12 @@
<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
-tree). Often times it is useful to initialize the source vertex's
+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
-depth-first search that creates a forest (multiple search trees), it
-is useful to intialize the predecessor of every vertex to itself, so
-that all the root nodes can be distinguished.
+depth-first search that creates a forest (multiple search trees) it
+is useful to intialize the predecessor of every vertex to itself. This
+way all the root nodes can be distinguished.
<h3>Example</h3>
@@ -74,7 +74,7 @@
<TR><TD><TT>PredecessorMap</TT></TD>
<TD>
A <a
-href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap</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.
</TD>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/property_writer.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/property_writer.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/property_writer.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -74,9 +74,9 @@
<TR><TD><TT>PropertyMap</TT></TD>
<TD>
A <a
-href="../../property_map/doc/ReadablePropertyMap.html">ReadablePropertyMap</a>,
+href="../../property_map/doc/ReadablePropertyMap.html">ReadablePropertyMap</a>
where the <tt>key_type</tt> is the vertex descriptor type or edge
-descriptor of the graph (depending on the kind of event tag), and
+descriptor of the graph (depending on the kind of event tag) and
the <tt>value_type</tt> of the property is convertible
to the <tt>value_type</tt> of the <tt>OutputIterator</tt>.
</TD>
@@ -85,7 +85,7 @@
<TR><TD><TT>OutputIterator</TT></TD>
<TD>
-The iterator type used to write out the property values, which must be
+The iterator type used to write out the property values which must be
a model of <a
href="http://www.sgi.com/tech/stl/OutputIterator.html">OutputIterator</a>.
</TD>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/time_stamper.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/time_stamper.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/time_stamper.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -74,9 +74,9 @@
<TR><TD><TT>TimeMap</TT></TD>
<TD>
A <a
-href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap</a>,
+href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap</a>
where the <tt>key_type</tt> is the vertex descriptor type or edge
-descriptor of the graph (depending on the kind of event tag), and
+descriptor of the graph (depending on the kind of event tag) and
where the <tt>TimeT</tt> type is convertible to the
<tt>value_type</tt> of the time property map.
</TD>
@@ -85,7 +85,7 @@
<TR><TD><TT>TimeT</TT></TD>
<TD>
-The type for the time counter, which should be convertible to the
+The type for the time counter which should be convertible to the
<tt>value_type</tt> of the time property map
</TD>
<TD> </TD>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/tsp_tour_len_visitor.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/tsp_tour_len_visitor.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/tsp_tour_len_visitor.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -102,7 +102,7 @@
tsp_tour_len_visitor<OutputIterator><br>
make_tsp_tour_len_visitor(Graph const& g, OutIter iter, Length& l, WeightMap map)
</tt></td><td>
-Returns a tour_len_visitor that records the TSP tour in the OutputIterator parameter and the tour's length in the Length parameter.
+Returns a tour_len_visitor that records the TSP tour in the OutputIterator parameter and the length of the tour in the Length parameter.
</td></tr>
</table>
Modified: sandbox-branches/birbacher/fix_documentation/libs/graph/doc/visitor_concepts.html
==============================================================================
--- sandbox-branches/birbacher/fix_documentation/libs/graph/doc/visitor_concepts.html (original)
+++ sandbox-branches/birbacher/fix_documentation/libs/graph/doc/visitor_concepts.html 2009-09-30 15:54:09 EDT (Wed, 30 Sep 2009)
@@ -40,6 +40,8 @@
<li> Bellman Ford Visitor
<li> A* Visitor
<li> Event Visitor
+ <li> Planar Face Visitor
+ <li> TSP Tour Visitor
</ul>
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