
BoostCommit : 
Subject: [Boostcommit] svn:boost r56109  in trunk/libs/graph: doc quickbook/concepts
From: jewillco_at_[hidden]
Date: 20090908 13:13:11
Author: jewillco
Date: 20090908 13:13:10 EDT (Tue, 08 Sep 2009)
New Revision: 56109
URL: http://svn.boost.org/trac/boost/changeset/56109
Log:
Applied unapplied parts of bug 3426; fixes #3426
Text files modified:
trunk/libs/graph/doc/Graph.html  5 ++
trunk/libs/graph/quickbook/concepts/dfs_visitor.qbk  6 +++
trunk/libs/graph/quickbook/concepts/graph.qbk  2 +
trunk/libs/graph/quickbook/concepts/graphs.qbk  8 ++++
trunk/libs/graph/quickbook/concepts/vertex_index_graph.qbk  2 +
5 files changed, 11 insertions(+), 12 deletions()
Modified: trunk/libs/graph/doc/Graph.html
==============================================================================
 trunk/libs/graph/doc/Graph.html (original)
+++ trunk/libs/graph/doc/Graph.html 20090908 13:13:10 EDT (Tue, 08 Sep 2009)
@@ 62,9 +62,8 @@
An edge descriptor corresponds to a unique edge <i>(u,v)</i> in a
graph. An edge descriptor must be <a
href="http://www.sgi.com/tech/stl/DefaultConstructible.html">Default Constructible</I>,
<a
href="http://www.sgi.com/tech/stl/Assignable.html">Assignable</a>,
and Equality Comparable.
+Assignable, and
+Equality Comparable.
</td>
</tr>
Modified: trunk/libs/graph/quickbook/concepts/dfs_visitor.qbk
==============================================================================
 trunk/libs/graph/quickbook/concepts/dfs_visitor.qbk (original)
+++ trunk/libs/graph/quickbook/concepts/dfs_visitor.qbk 20090908 13:13:10 EDT (Tue, 08 Sep 2009)
@@ 27,7 +27,7 @@
[
[`vis.start_vertex(v,g)`]
[
 This is invoked on the source veretx once before the start of the search.
+ This is invoked on the source vertex once before the start of the search.
*Returns* `void`
]
@@ 51,7 +51,7 @@
[
[`vis.tree_edge(e,g)`]
[
 This is invoked on each edge as it becomes a member of the eges that the form the
+ This is invoked on each edge as it becomes a member of the edges that form the
search tree.
*Returns* `void`
@@ 60,7 +60,7 @@
[
[`vis.back_edge(v,g)`]
[
 This is invoked on the back edges of the graph. For an unidrected graph there
+ This is invoked on the back edges of the graph. For an undirected graph there
is some ambiguity between tree edges and back edges since the edge /(u,v)/
and /(v,u)/ are the same edge, but both `tree_edge(v,g)` and `back_edge(v,g)`
will be invoked. One way to resolve this ambiguity is to record the tree
Modified: trunk/libs/graph/quickbook/concepts/graph.qbk
==============================================================================
 trunk/libs/graph/quickbook/concepts/graph.qbk (original)
+++ trunk/libs/graph/quickbook/concepts/graph.qbk 20090908 13:13:10 EDT (Tue, 08 Sep 2009)
@@ 25,7 +25,7 @@
[
[`graph_traits<G>::edge_descriptor`]
[
 An edge descriptor corresponds to a unqie edge /(u,v)/ in a graph. An edge descriptor
+ An edge descriptor corresponds to a unique edge /(u,v)/ in a graph. An edge descriptor
must be DefaultConstructible, Assignable, and EqualityComparable. Edge descriptors
are almost always passed by value.
]
Modified: trunk/libs/graph/quickbook/concepts/graphs.qbk
==============================================================================
 trunk/libs/graph/quickbook/concepts/graphs.qbk (original)
+++ trunk/libs/graph/quickbook/concepts/graphs.qbk 20090908 13:13:10 EDT (Tue, 08 Sep 2009)
@@ 13,7 +13,7 @@
or more efficient to define a graph implicitly based on some functions.
The Boost.Graph interface does not appear as a single graph concept. Instead it is
factored into much smaller peices. The reason for this is that the purpose of a
+factored into much smaller pieces. The reason for this is that the purpose of a
concept is to summarize the requirements for particular algorithms. Any one algorithm
does not need every kind of graph operation, typically only a small subset. Furthermore,
there are many graph datastructures that can not provide efficient implementations of
@@ 225,15 +225,15 @@
[StdUniqueAssociativeContainer], then the graph cannont be a multigraph.
[heading Indexed Graphs]
Indexed graph provide a specific property, an index, for verticese, edges or both.
Many algorithms require vertex or edge indices for "fast" property acces, often
+Indexed graph provide a specific property, an index, for vertices, edges or both.
+Many algorithms require vertex or edge indices for "fast" property access, often
declaring exterior properties as `vector`s and using the indices as random access
iterators to access those properties. These concepts effectively require that
indices are accessible as interior properties of the graph.
These concepts are provided to help describe interface requirements for algorithms
that allow indices to be provided as an exterior property map. With these concepts,
requirements (and interfaces) can be written more disticntly for algorithms that accept
+requirements (and interfaces) can be written more distinctly for algorithms that accept
indexed graphs, and those that require adaptation through exterior properties.
There are two indexed graph concepts: [VertexIndexGraph] and [EdgeIndexGraph].
Modified: trunk/libs/graph/quickbook/concepts/vertex_index_graph.qbk
==============================================================================
 trunk/libs/graph/quickbook/concepts/vertex_index_graph.qbk (original)
+++ trunk/libs/graph/quickbook/concepts/vertex_index_graph.qbk 20090908 13:13:10 EDT (Tue, 08 Sep 2009)
@@ 91,7 +91,7 @@
[`G::vertex_index_type`]
[
Returns the index of the given vertex within the graph. This is
 equvalent to `get(get(vertex_index, g), v)`.
+ equivalent to `get(get(vertex_index, g), v)`.
*Complexity:* Amortized constant.
]
BoostCommit 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