From dababea605b482798ca2ca4537de45c37ddda044 Mon Sep 17 00:00:00 2001 From: Andrew Sutton Date: Mon, 15 Mar 2010 11:00:35 +0000 Subject: [PATCH] Reviewed and applied patch from #4004. Removed one ", which" change since the resulting change made the trailing clause read as if it applied to the wrong type. [SVN r60610] --- doc/AStarVisitor.html | 10 +++++----- doc/BFSVisitor.html | 4 ++-- doc/BellmanFordVisitor.html | 4 ++-- doc/DFSVisitor.html | 2 +- doc/EventVisitorList.html | 4 ++-- doc/bc_clustering.html | 2 +- doc/bellman_visitor.html | 4 ++-- doc/bfs_visitor.html | 4 ++-- doc/dfs_visitor.html | 4 ++-- doc/dijkstra_visitor.html | 4 ++-- doc/distance_recorder.html | 4 ++-- doc/predecessor_recorder.html | 12 ++++++------ doc/property_writer.html | 4 ++-- doc/time_stamper.html | 6 +++--- doc/tsp_tour_len_visitor.html | 2 +- doc/visitor_concepts.html | 2 ++ 16 files changed, 37 insertions(+), 35 deletions(-) diff --git a/doc/AStarVisitor.html b/doc/AStarVisitor.html index da99a8ed..81fa6129 100644 --- a/doc/AStarVisitor.html +++ b/doc/AStarVisitor.html @@ -118,7 +118,7 @@ OPEN list. vis.examine_vertex(u, g) void -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 examine_edge() is invoked on each of the out-edges of vertex u. @@ -160,7 +160,7 @@ assert(compare(combine(d_u, w_e), d_s)); vis.edge_not_relaxed(e, g) void -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. @@ -171,7 +171,7 @@ method is invoked. void 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. @@ -181,8 +181,8 @@ OPEN list. vis.finish_vertex(u, g) void -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. diff --git a/doc/BFSVisitor.html b/doc/BFSVisitor.html index 2390a294..5333a9df 100644 --- a/doc/BFSVisitor.html +++ b/doc/BFSVisitor.html @@ -140,7 +140,7 @@ edges for undirected graphs. vis.gray_target(e, g) void -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. @@ -151,7 +151,7 @@ that the vertex is currently in the queue. vis.black_target(e, g) void -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. diff --git a/doc/BellmanFordVisitor.html b/doc/BellmanFordVisitor.html index 96462288..4bfbdfd9 100644 --- a/doc/BellmanFordVisitor.html +++ b/doc/BellmanFordVisitor.html @@ -116,8 +116,8 @@ this method is invoked. vis.edge_minimized(e, g) void -After the num_vertices(g) iterations through the edge set -of the graph is complete, one last iteration is made to test whether +After num_vertices(g) 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. diff --git a/doc/DFSVisitor.html b/doc/DFSVisitor.html index 7ba1c342..f81f616f 100644 --- a/doc/DFSVisitor.html +++ b/doc/DFSVisitor.html @@ -157,7 +157,7 @@ undirected graph this method is never called. This is invoked on vertex u after finish_vertex has been called for all the vertices in the DFS-tree rooted at vertex u. If vertex u is a leaf in the DFS-tree, then -the finish_vertex function is call on u after +the finish_vertex function is called on u after all the out-edges of u have been examined. diff --git a/doc/EventVisitorList.html b/doc/EventVisitorList.html index c4dd24f7..09e8e9cc 100644 --- a/doc/EventVisitorList.html +++ b/doc/EventVisitorList.html @@ -19,7 +19,7 @@ An EventVisitorList is either an EventVisitor, or a list of -EventVisitor's combined using std::pair. Each graph algorithm +EventVisitors combined using std::pair. Each graph algorithm defines visitor adaptors that convert an EventVisitorList into the particular kind of visitor needed by the algorithm. @@ -91,7 +91,7 @@ Now we can pass the resulting visitor object into color.begin()); -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 std::make_pair in the following way: 
diff --git a/doc/bc_clustering.html b/doc/bc_clustering.html
index 14fefb4b..261dfa0b 100644
--- a/doc/bc_clustering.html
+++ b/doc/bc_clustering.html
@@ -61,7 +61,7 @@ clustering based on edge betweenness centrality.

 
Description

 
This algorithm implements graph clustering based on edge
 betweenness centrality. It is an iterative algorithm, where in each
-step it compute the edge betweenness centrality (via brandes_betweenness_centrality) and
 removes the edge with the maximum betweenness centrality. The
 done function object determines
diff --git a/doc/bellman_visitor.html b/doc/bellman_visitor.html
index bd6eb9b5..72dae162 100644
--- a/doc/bellman_visitor.html
+++ b/doc/bellman_visitor.html
@@ -22,7 +22,7 @@ bellman_visitor<EventVisitorList>
 
 
 This class is an adapter that converts a list of EventVisitor's (constructed using
+href="./EventVisitor.html">EventVisitors (constructed using
 std::pair) into a BellmanFordVisitor.
 
@@ -63,7 +63,7 @@ with std::pair.
 This class implements all of the member functions required by BellmanFordVisitor. In each function the
 appropriate event is dispatched to the EventVisitor's in the EventVisitorList.
+href="./EventVisitor.html">EventVisitor in the EventVisitorList.
 
 
Non-Member Functions

 
diff --git a/doc/bfs_visitor.html b/doc/bfs_visitor.html
index 751a742a..b175ac96 100644
--- a/doc/bfs_visitor.html
+++ b/doc/bfs_visitor.html
@@ -22,7 +22,7 @@ bfs_visitor<EventVisitorList>
 
 
 This class is an adapter that converts a list of EventVisitor's (constructed using
+href="./EventVisitor.html">EventVisitors (constructed using
 std::pair) into a BFSVisitor.
 
 
@@ -80,7 +80,7 @@ with std::pair.
 This class implements all of the member functions required by BFSVisitor. In each function the
 appropriate event is dispatched to the EventVisitor's in the EventVisitorList.
+href="./EventVisitor.html">EventVisitor in the EventVisitorList.
 
 
Non-Member Functions

 
diff --git a/doc/dfs_visitor.html b/doc/dfs_visitor.html
index 9c3fb1a2..990117c6 100644
--- a/doc/dfs_visitor.html
+++ b/doc/dfs_visitor.html
@@ -22,7 +22,7 @@ dfs_visitor<EventVisitorList>
 
 
 This class is an adapter that converts a list of EventVisitor's (constructed using
+href="./EventVisitor.html">EventVisitors (constructed using
 std::pair) into a DFSVisitor.
 
 
@@ -63,7 +63,7 @@ with std::pair.
 This class implements all of the member functions required by DFSVisitor. In each function the
 appropriate event is dispatched to the EventVisitor's in the EventVisitorList.
+href="./EventVisitor.html">EventVisitor in the EventVisitorList.
 
 
Non-Member Functions

 
diff --git a/doc/dijkstra_visitor.html b/doc/dijkstra_visitor.html
index 80b00af9..1e7ec036 100644
--- a/doc/dijkstra_visitor.html
+++ b/doc/dijkstra_visitor.html
@@ -22,7 +22,7 @@ dijkstra_visitor<EventVisitorList>
 
 
 This class is an adapter that converts a list of EventVisitor's (constructed using
+href="./EventVisitor.html">EventVisitors (constructed using
 std::pair) into a DijkstraVisitor.
 
@@ -77,7 +77,7 @@ with std::pair.
 This class implements all of the member functions required by DijkstraVisitor. In each
 function the appropriate event is dispatched to the EventVisitor's in the EventVisitorList.
+href="./EventVisitor.html">EventVisitor in the EventVisitorList.
 
 
Non-Member Functions

 
diff --git a/doc/distance_recorder.html b/doc/distance_recorder.html
index e10e3f57..fe7cd559 100644
--- a/doc/distance_recorder.html
+++ b/doc/distance_recorder.html
@@ -27,7 +27,7 @@ href="property_map.html">property map) from some
 source vertex during a graph search. When applied to edge e =
 (u,v), the distance of v is recorded to be one more than
 the distance of u. The distance recorder is typically used with
-the on_tree_edge or on_relax_edge events, and
+the on_tree_edge or on_relax_edge events and
 cannot be used with vertex events.
 
 

@@ -64,7 +64,7 @@ See the example for bfs_visitor.
 DistanceMap
 
 A WritablePropertyMap,
+href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap
 where the key type and the value type are the vertex descriptor type
 of the graph.
 
diff --git a/doc/predecessor_recorder.html b/doc/predecessor_recorder.html
index ab1d4d47..75fe44a6 100644
--- a/doc/predecessor_recorder.html
+++ b/doc/predecessor_recorder.html
@@ -27,7 +27,7 @@ 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
 typically used with the on_tree_edge or
-on_relax_edge events, and cannot be used with vertex events.
+on_relax_edge events and cannot be used with vertex events.
 
 

 predecessor_recorder can be used with graph algorithms by
@@ -40,12 +40,12 @@ visitor can be combined with other event visitors using
 

 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.
 
 
 
Example

@@ -74,7 +74,7 @@ See the example for bfs_visitor.
 PredecessorMap
 
 A WritablePropertyMap,
+href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap
 where the key type and the value type are the vertex descriptor type
 of the graph.
 
diff --git a/doc/property_writer.html b/doc/property_writer.html
index a53ef0ab..fce17995 100644
--- a/doc/property_writer.html
+++ b/doc/property_writer.html
@@ -74,9 +74,9 @@ href="../example/dave.cpp">examples/dave.cpp.
 PropertyMap
 
 A ReadablePropertyMap,
+href="../../property_map/doc/ReadablePropertyMap.html">ReadablePropertyMap
 where the key_type 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 value_type of the property is convertible
 to the value_type of the OutputIterator.
 
diff --git a/doc/time_stamper.html b/doc/time_stamper.html
index 6689af28..e2f69f23 100644
--- a/doc/time_stamper.html
+++ b/doc/time_stamper.html
@@ -74,9 +74,9 @@ The following example shows the usage of the time_stamper.
 TimeMap
 
 A WritablePropertyMap,
+href="../../property_map/doc/WritablePropertyMap.html">WritablePropertyMap
 where the key_type 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 TimeT type is convertible to the
 value_type of the time property map.
 
@@ -85,7 +85,7 @@ where the TimeT type is convertible to the
 
 TimeT
 
-The type for the time counter, which should be convertible to the
+The type for the time counter which should be convertible to the
 value_type of the time property map
 
  
diff --git a/doc/tsp_tour_len_visitor.html b/doc/tsp_tour_len_visitor.html
index 8136ad14..4363a3ae 100644
--- a/doc/tsp_tour_len_visitor.html
+++ b/doc/tsp_tour_len_visitor.html
@@ -102,7 +102,7 @@ template <typename Graph, typename WeightMap, typename OutputIterator, typena
 tsp_tour_len_visitor<OutputIterator>

 make_tsp_tour_len_visitor(Graph const& g, OutIter iter, Length& l, WeightMap map)
 
-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.
 
 
 
diff --git a/doc/visitor_concepts.html b/doc/visitor_concepts.html
index 4053282b..b68bd69c 100644
--- a/doc/visitor_concepts.html
+++ b/doc/visitor_concepts.html
@@ -40,6 +40,8 @@ the following visitor concepts:
   
  •  Bellman Ford Visitor
   
  •  A* Visitor
   
  •  Event Visitor
+  
  •  Planar Face Visitor
+  
  •  TSP Tour Visitor