Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r50234 - trunk/libs/graph/doc
From: asutton_at_[hidden]
Date: 2008-12-10 11:17:19

Next message: joaquin_at_[hidden]: "[Boost-commit] svn:boost r50235 - trunk/boost/flyweight"
Previous message: asutton_at_[hidden]: "[Boost-commit] svn:boost r50233 - trunk/libs/graph/test"

Author: asutton
Date: 2008-12-10 11:17:19 EST (Wed, 10 Dec 2008)
New Revision: 50234
URL: http://svn.boost.org/trac/boost/changeset/50234

Log:
Updating the adjacency list invalidation table.

Text files modified:
trunk/libs/graph/doc/adjacency_list.html | 83 +++++++++++++++++++++++++--------------
1 files changed, 52 insertions(+), 31 deletions(-)

Modified: trunk/libs/graph/doc/adjacency_list.html
==============================================================================
--- trunk/libs/graph/doc/adjacency_list.html (original)
+++ trunk/libs/graph/doc/adjacency_list.html 2008-12-10 11:17:19 EST (Wed, 10 Dec 2008)
@@ -8,10 +8,10 @@
   -->
<Head>
<Title>Boost Graph Library: Adjacency List</Title>
-<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
- ALINK="#ff0000">
-<IMG SRC="../../../boost.png"
- ALT="C++ Boost" width="277" height="86">
+<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
+ ALINK="#ff0000">
+<IMG SRC="../../../boost.png"
+ ALT="C++ Boost" width="277" height="86">

<BR Clear>

@@ -146,7 +146,7 @@
<H3>Model of</H3>

<P>
-VertexAndEdgeListGraph,
+VertexAndEdgeListGraph,
<a href="./MutablePropertyGraph.html">MutablePropertyGraph</a>,
<a href="../../utility/CopyConstructible.html">CopyConstructible</a>,
<a href="../../utility/Assignable.html">Assignable</a>,
@@ -178,7 +178,7 @@
HREF="../../property_map/property_map.html">Property Map
Concepts</A> or may be bundled properties,
which have a more succinct syntax. The types of all property values
-must be Copy Constructible, Assignable, and Default Constructible.
+must be Copy Constructible, Assignable, and Default Constructible.
The property maps obtained from the
<TT>adjacency_list</TT> class are models of the <a
href="../../property_map/LvaluePropertyMap.html">Lvalue Property
@@ -322,30 +322,51 @@
<CAPTION ALIGN="BOTTOM"><STRONG>Table:</STRONG>
     Summary of Descriptor and Iterator Invalidation.
     </CAPTION>
-<tr> <th>Function</th> <th>Vertex Desc</th> <th>Edge Desc</th>
-<th>Vertex Iter</th> <th>Edge Iter</th> <th>Adj Iter</th> </tr>
-
<tr>
-<td><tt>add_edge()</tt></td> <td align=center><tt>OK</tt></td><td
-align=center><tt>OK</tt></td><td align=center><tt>OK</tt></td><td
-align=center><tt>EL=vecS &&<br> Directed=directedS</tt></td><td align=center><tt>EL=vecS</tt></td>
+ <th>Function</th>
+ <th>Vertex Desc</th>
+ <th>Edge Desc</th>
+ <th>Vertex Iter</th>
+ <th>Edge Iter</th>
+ <th>Adj Iter</th>
</tr>
<tr>
-<td><tt>remove_edge()<br>remove_edge_if()<br>remove_out_edge_if()<br>remove_in_edge_if()<br>clear_vertex()</tt></td><td align=center><tt>OK</tt></td><td align=center><tt>OK</tt></td><td align=center><tt>OK</tt></td>
-<td align=center><tt>EL=vecS &&<br> Directed=directedS</tt></td><td align=center><tt>EL=vecS</tt></td>
+<td>
+ <tt>add_edge()</tt></td>
+ <td align=center><tt>OK</tt></td>
+ <td align=center><tt>OK</tt></td>
+ <td align=center><tt>OK</tt></td>
+ <td align=center><tt>EL=vecS && <br>Directed=directedS</tt></td>
+ <td align=center><tt>EL=vecS</tt></td>
</tr>
<tr>
-<td><tt>add_vertex()</tt></td><td align=center><tt>OK</tt></td><td
-align=center><tt>OK</tt></td><td align=center><tt>OK</tt></td><td
-align=center><tt>OK</tt></td><td align=center><tt>OK</tt></td>
+ <td><tt>remove_edge()<br>remove_edge_if()<br>remove_out_edge_if()<br>
+ remove_in_edge_if()<br>clear_vertex()</tt>
+ </td>
+ <td align=center><tt>OK</tt></td>
+ <td align=center><tt>OK</tt></td>
+ <td align=center><tt>OK</tt></td>
+ <td align=center><tt>EL=vecS && <br>Directed=directedS</tt></td>
+ <td align=center><tt>EL=vecS</tt></td>
</tr>
<tr>
-<td><tt>remove_vertex()</tt></td><td align=center><tt>VL=vecS</tt></td><td align=center><tt>VL=vecS</tt></td><td align=center><tt>VL=vecS</tt></td><td align=center><tt>VL=vecS</tt></td><td align=center><tt>VL=vecS</tt></td>
+ <td><tt>add_vertex()</tt></td>
+ <td align=center><tt>OK</tt></td>
+ <td align=center><tt>OK</tt></td>
+ <td align=center><tt>OK</tt></td>
+ <td align=center><tt>VL=vecS && <br/> Directed=directedS</tt></td>
+ <td align=center><tt>VL=vecS && <br/> Directed=directedS</tt></td>
+</tr>
+<tr>
+ <td><tt>remove_vertex()</tt></td>
+ <td align=center><tt>VL=vecS</tt></td>
+ <td align=center><tt>VL=vecS</tt></td>
+ <td align=center><tt>VL=vecS</tt></td>
+ <td align=center><tt>VL=vecS</tt></td>
+ <td align=center><tt>VL=vecS</tt></td>
</tr>
-
</table>

-
<H2>Associated Types</H2>

<hr>
@@ -539,7 +560,7 @@
<hr>

<pre>
-adjacency_list(vertices_size_type n,
+adjacency_list(vertices_size_type n,
                const GraphProperty& p = GraphProperty())
</pre>
Creates a graph object with <TT>n</TT> vertices and zero edges.
@@ -550,8 +571,8 @@
<pre>
template <class EdgeIterator>
adjacency_list(EdgeIterator first, EdgeIterator last,
- vertices_size_type n,
- edges_size_type m = 0,
+ vertices_size_type n,
+ edges_size_type m = 0,
                const GraphProperty& p = GraphProperty())
</pre>
Creates a graph object with <TT>n</TT> vertices and with the edges
@@ -600,7 +621,7 @@
Swap the vertices, edges, and properties of this graph with the
vertices, edges, and properties of graph <tt>x</tt>.
<hr>
-
+
<P>

<H2>Non-Member Functions</H2>
@@ -781,7 +802,7 @@
<p>
The placement of the new edge in the out-edge list is in general
unspecified, though ordering of the out-edge list can be accomplished
-through the choice of <tt>OutEdgeList</tt>.
+through the choice of <tt>OutEdgeList</tt>.

If the <tt>VertexList</tt> selector is
<tt>vecS</tt>, and if either vertex descriptor <tt>u</tt> or
@@ -821,7 +842,7 @@
void remove_edge(vertex_descriptor u, vertex_descriptor v,
                  adjacency_list& g)
</pre>
-Removes the edge <i>(u,v)</i> from the graph.
+Removes the edge <i>(u,v)</i> from the graph.
<p>
This operation causes any outstanding edge descriptors or iterators
that point to edge <i>(u,v)</i> to become invalid. In addition, if
@@ -867,7 +888,7 @@
</pre>
Removes all out-edges of vertex <i>u</i> from the graph that satisfy
the <tt>predicate</tt>. That is, if the predicate returns true when
-applied to an edge descriptor, then the edge is removed.
+applied to an edge descriptor, then the edge is removed.
<p>
The affect on descriptor and iterator stability is the same as that of
invoking <tt>remove_edge()</tt> on each of the removed edges.
@@ -899,7 +920,7 @@
</pre>
Removes all edges from the graph that satisfy
the <tt>predicate</tt>. That is, if the predicate returns true when
-applied to an edge descriptor, then the edge is removed.
+applied to an edge descriptor, then the edge is removed.
<p>
The affect on descriptor and iterator stability is the same as that of
invoking <tt>remove_edge()</tt> on each of the removed edges.
@@ -912,7 +933,7 @@
add_vertex(adjacency_list& g)
</pre>
Adds a vertex to the graph and returns the vertex descriptor for the
-new vertex.
+new vertex.
</a>

<hr>
@@ -975,7 +996,7 @@
Remove vertex <i>u</i> from the vertex set of the graph. It is assumed
that there are no edges to or from vertex <i>u</i> when it is removed.
One way to make sure of this is to invoke <TT>clear_vertex()</TT>
-beforehand.
+beforehand.
<p>
If the <TT>VertexList</TT> template parameter of the
<TT>adjacency_list</TT> was <TT>vecS</TT>, then all vertex
@@ -1110,7 +1131,7 @@
</TD></TR></TABLE>

</BODY>
-</HTML>
+</HTML>

<!-- LocalWords: GraphPropertyTag cpp enum ai cout endl VertexAndEdgeListGraph

Next message: joaquin_at_[hidden]: "[Boost-commit] svn:boost r50235 - trunk/boost/flyweight"
Previous message: asutton_at_[hidden]: "[Boost-commit] svn:boost r50233 - trunk/libs/graph/test"

Date view	Thread view	Subject view	Author view

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