diff --git a/doc/BUILD_DOCS.sh b/doc/BUILD_DOCS.sh index ac11f274..e18de3b3 100755 --- a/doc/BUILD_DOCS.sh +++ b/doc/BUILD_DOCS.sh @@ -10,3 +10,4 @@ for i in read_graphml read_graphviz write_graphml; do rst2html.py -gdt --link-stylesheet --traceback --trim-footnote-reference-space --footnote-references=superscript --stylesheet=../../../rst.css $i.rst > $i.html done +# Also see grid_graph_export_png.sh for figure conversions diff --git a/doc/Graph.html b/doc/Graph.html index 2c74f367..08423b10 100644 --- a/doc/Graph.html +++ b/doc/Graph.html @@ -62,9 +62,8 @@ href="http://www.sgi.com/tech/stl/DefaultConstructible.html">Default Constructib An edge descriptor corresponds to a unique edge (u,v) in a graph. An edge descriptor must be Default Constructible, -Assignable, -and Equality Comparable. +Assignable, and +Equality Comparable. diff --git a/doc/IncidenceGraph.html b/doc/IncidenceGraph.html index cbdc60b1..29db1946 100644 --- a/doc/IncidenceGraph.html +++ b/doc/IncidenceGraph.html @@ -76,7 +76,7 @@ href="../../utility/MultiPassInputIterator.html">MultiPassInputIterator.
boost::graph_traits<G>::degree_size_type
-The unsigned intergral type used for representing the number +The unsigned integral type used for representing the number out-edges or incident edges of a vertex. @@ -108,7 +108,7 @@ directed graphs) or incident edges (for undirected graphs) of vertex u in graph g. The source vertex of an edge obtained via an out edge iterator is guaranteed (for both directed and undirected graphs) to be the vertex u used in the call to -out_edges(u, g) and the target vertex must the a vertex +out_edges(u, g) and the target vertex must be a vertex adjacent to u.[1]
Return type: std::pair<out_edge_iterator, out_edge_iterator> diff --git a/doc/compressed_sparse_row.html b/doc/compressed_sparse_row.html index d7cefa17..5086ac68 100644 --- a/doc/compressed_sparse_row.html +++ b/doc/compressed_sparse_row.html @@ -40,7 +40,8 @@ function address(host, user) {

The class template compressed_sparse_row_graph is a graph class that uses the compact Compressed Sparse Row (CSR) - format to store directed graphs. While CSR graphs have much less + format to store directed (and bidirectional) graphs. While CSR graphs have + much less overhead than many other graph formats (e.g., adjacency_list), they do not provide any mutability: one cannot add or remove vertices @@ -67,14 +68,20 @@ function address(host, user) { providing the offset of the first edge outgoing from each vertex. Iteration over the out-edges for the ith vertex in the graph is achieved by - visiting edge_array[vertex_array[i]], edge_array[vertex_array[i]+1], + visiting edge_array[vertex_array[i]], + edge_array[vertex_array[i]+1], ..., edge_array[vertex_array[i+1]]. This format minimizes memory use to O(n + m), where n and m are the number of vertices and edges, respectively. The constants multiplied by n and m are based on the size of the integers needed to represent indices into the edge and vertex arrays, respectively, which can be controlled using - the template parameters.

+ the template parameters. The + Directed template parameter controls whether one edge direction + (the default) or both directions are stored. A directed CSR graph has + Directed = directedS and a bidirectional CSR graph (only + supported with the new interface and with a limited set of constructors) + has Directed = bidirectionalS.