|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r57601 - trunk/libs/graph/doc
From: jewillco_at_[hidden]
Date: 2009-11-12 14:11:59
Author: jewillco
Date: 2009-11-12 14:11:58 EST (Thu, 12 Nov 2009)
New Revision: 57601
URL: http://svn.boost.org/trac/boost/changeset/57601
Log:
Fixed issues in docs, especially ToC; refs #3615
Text files modified:
trunk/libs/graph/doc/index.html | 35 ++--
trunk/libs/graph/doc/table_of_contents.html | 290 ++++++++++++++++++++-------------------
2 files changed, 167 insertions(+), 158 deletions(-)
Modified: trunk/libs/graph/doc/index.html
==============================================================================
--- trunk/libs/graph/doc/index.html (original)
+++ trunk/libs/graph/doc/index.html 2009-11-12 14:11:58 EST (Thu, 12 Nov 2009)
@@ -1,3 +1,5 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+"http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<!--
Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
@@ -7,17 +9,16 @@
http://www.boost.org/LICENSE_1_0.txt)
-->
<Head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
<Title>The Boost Graph Library</Title>
-<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
- ALINK="#ff0000">
-<IMG SRC="../../../boost.png"
- ALT="C++ Boost" width="277" height="86">
-
-<BR Clear>
+<BODY bgcolor="#ffffff" link="#0000ee" text="#000000" vlink="#551a8b"
+ alink="#ff0000">
+<IMG src="../../../boost.png"
+ alt="C++ Boost" width="277" height="86">
<h1>The Boost Graph Library (BGL)
<a href="http://www.awprofessional.com/title/0201729148">
-<img src="bgl-cover.jpg" ALT="BGL Book" ALIGN="RIGHT"></a>
+<img src="bgl-cover.jpg" alt="BGL Book" align="RIGHT"></a>
</h1>
<P>
@@ -28,12 +29,12 @@
importance to encourage reuse of graph algorithms and data structures.
Part of the Boost Graph Library is a generic interface that allows
access to a graph's structure, but hides the details of the
-implementation. This is an ``open'' interface in the sense that any
+implementation. This is an “open” interface in the sense that any
graph library that implements this interface will be interoperable
with the BGL generic algorithms and with other algorithms that also
use this interface. The BGL provides some general purpose graph classes
that conform to this interface, but they are not meant to be the
-``only'' graph classes; there certainly will be other graph classes
+“only” graph classes; there certainly will be other graph classes
that are better for certain situations. We believe that the main
contribution of the The BGL is the formulation of this interface.
@@ -62,7 +63,7 @@
href="read_graphviz.html">GraphViz input parser</a>.</p>
<p>When compiling programs that use the BGL, <b>be sure to compile
-with optimization</b>. For instance, select "Release" mode with
+with optimization</b>. For instance, select “Release” mode with
Microsoft Visual C++ or supply the flag <tt>-O2</tt> or <tt>-O3</tt>
to GCC. </p>
@@ -108,14 +109,14 @@
<P>
The third way that STL is generic is that its containers are
parameterized on the element type. Though hugely important, this is
-perhaps the least ``interesting'' way in which STL is generic.
+perhaps the least “interesting” way in which STL is generic.
Generic programming is often summarized by a brief description of
parameterized lists such as <TT>std::list<T></TT>. This hardly scratches
the surface!
<P>
-<H2>Genericity in the Boost Graph Library</A>
+<H2>Genericity in the Boost Graph Library
</H2>
<P>
@@ -169,7 +170,7 @@
Second, the graph algorithms of the BGL are extensible. The BGL introduces the
notion of a <I>visitor</I>, which is just a function object with
multiple methods. In graph algorithms, there are often several key
-``event points'' at which it is useful to insert user-defined
+“event points” at which it is useful to insert user-defined
operations. The visitor object has a different method that is invoked
at each event point. The particular event points and corresponding
visitor methods depend on the particular algorithm. They often
@@ -185,13 +186,13 @@
The third way that the BGL is generic is analogous to the parameterization
of the element-type in STL containers, though again the story is a bit
more complicated for graphs. We need to associate values (called
-"properties") with both the vertices and the edges of the graph.
+“properties”) with both the vertices and the edges of the graph.
In addition, it will often be necessary to associate
multiple properties with each vertex and edge; this is what we mean
by multi-parameterization.
The STL <tt>std::list<T></tt> class has a parameter <tt>T</tt>
for its element type. Similarly, BGL graph classes have template
-parameters for vertex and edge ``properties''. A
+parameters for vertex and edge “properties”. A
property specifies the parameterized type of the property and also assigns
an identifying tag to the property. This tag is used to distinguish
between the multiple properties which an edge or vertex may have. A
@@ -265,8 +266,8 @@
</UL>
<P>
-The <TT>adjacency_list</TT> class is the general purpose ``swiss army
-knife'' of graph classes. It is highly parameterized so that it can be
+The <TT>adjacency_list</TT> class is the general purpose “swiss army
+knife” of graph classes. It is highly parameterized so that it can be
optimized for different situations: the graph is directed or
undirected, allow or disallow parallel edges, efficient access to just
the out-edges or also to the in-edges, fast vertex insertion and
Modified: trunk/libs/graph/doc/table_of_contents.html
==============================================================================
--- trunk/libs/graph/doc/table_of_contents.html (original)
+++ trunk/libs/graph/doc/table_of_contents.html 2009-11-12 14:11:58 EST (Thu, 12 Nov 2009)
@@ -1,3 +1,5 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+"http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<!--
Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
@@ -7,14 +9,13 @@
http://www.boost.org/LICENSE_1_0.txt)
-->
<Head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
<Title>Table of Contents: Boost Graph Library</Title>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
ALINK="#ff0000">
<IMG SRC="../../../boost.png"
ALT="C++ Boost" width="277" height="86">
-<BR Clear>
-
<h1>Table of Contents: the Boost Graph Library
<a href="http://www.awprofessional.com/title/0201729148">
<img src="bgl-cover.jpg" ALT="BGL Book" ALIGN="RIGHT"></a>
@@ -64,12 +65,12 @@
<LI>Mutable Property Graph
</OL>
<li>The Property Map Library (technically not part of the graph library, but used a lot here)
- <li><img src="figs/python_ico.gif" alt="(Python)"/>Python bindings</li>
+ <li><img src="figs/python_ico.gif" alt="(Python)">Python bindings</li>
<li>Visitor Concepts
<OL>
<LI>BFS Visitor
<LI>DFS Visitor
- <LI>Dijkstra Visitor
+ <LI>Dijkstra Visitor
<LI>Bellman Ford Visitor
<LI>A* Visitor</LI>
<LI>Event Visitor
@@ -114,144 +115,153 @@
<OL>
<LI>Multi-dimensional grid graph
</OL>
- <LI>Iterator Adaptors
- <OL>
- <LI><a
- href="./adjacency_iterator.html"><tt>adjacency_iterator</tt></a>
- <LI><a
- href="./inv_adjacency_iterator.html"><tt>inv_adjacency_iterator</tt></a>
- </OL>
- <LI>Traits classes
- <OL>
- <LI>graph_traits
- <LI>adjacency_list_traits
- <LI>property_map
- </OL>
- <LI>Algorithms
- <OL>
- <LI>bgl_named_params
- <LI>Core Algorithm Patterns
- <OL>
- <LI>breadth_first_search
- <LI>breadth_first_visit
- <LI><A
- href="./depth_first_search.html"><tt>depth_first_search</tt></A>
- <LI>depth_first_visit
- <LI><A
- href="./undirected_dfs.html"><tt>undirected_dfs</tt></A>
- </OL>
- <LI>Graph Algorithms
- <OL>
- <LI>Shortest Paths Algorithms
- <OL>
- <LI>dijkstra_shortest_paths
- <LI>dijkstra_shortest_paths_no_color_map
- <LI>bellman_ford_shortest_paths
- <LI>dag_shortest_paths
- <LI><A
- href="./johnson_all_pairs_shortest.html"><tt>johnson_all_pairs_shortest_paths</tt></A>
- <li>floyd_warshall_all_pairs_shortest_paths</li>
- <li>r_c_shortest_paths - resource-constrained shortest paths</li>
- </OL>
- <LI>Minimum Spanning Tree Algorithms
- <OL>
- <LI><A
- href="./kruskal_min_spanning_tree.html"><tt>kruskal_minimum_spanning_tree</tt></A>
- <LI><A
- href="./prim_minimum_spanning_tree.html"><tt>prim_minimum_spanning_tree</tt></A>
- </OL>
- <LI>Connected Components Algorithms
+ </ol>
+ <LI>Iterator Adaptors
<OL>
- <LI>connected_components
- <LI>strong_components
-
- <LI>biconnected_components
- <LI>articulation_points
- <LI>Incremental Connected Components
+ <LI><a
+ href="./adjacency_iterator.html"><tt>adjacency_iterator</tt></a>
+ <LI><a
+ href="./inv_adjacency_iterator.html"><tt>inv_adjacency_iterator</tt></a>
+ </OL>
+ <LI>Traits classes
+ <OL>
+ <LI>graph_traits
+ <LI>adjacency_list_traits
+ <LI>property_map
+ </OL>
+ <LI>Algorithms
+ <OL>
+ <LI>Named parameters (used in many graph algorithms)
+ <li>Basic Operations
+ <ol>
+ <LI>copy_graph
+ <LI>transpose_graph
+ </ol>
+ <LI>Core Algorithm Patterns
<OL>
- <LI>initialize_incremental_components
- <LI>incremental_components
- <LI><A
- href="./incremental_components.html#sec:same-component"><tt>same_component</tt></A>
- <LI>component_index
+ <LI>breadth_first_search
+ <LI>breadth_first_visit
+ <LI><A
+ href="./depth_first_search.html"><tt>depth_first_search</tt></A>
+ <LI>depth_first_visit
+ <LI><A
+ href="./undirected_dfs.html"><tt>undirected_dfs</tt></A>
</OL>
- </OL></LI>
- <LI>Maximum Flow and Matching Algorithms
- <OL>
- <LI>edmonds_karp_max_flow
- <LI>push_relabel_max_flow
- <li>kolmogorov_max_flow</li>
- <LI>edmonds_maximum_cardinality_matching
- </OL>
+ <LI>Shortest Paths Algorithms
+ <OL>
+ <LI>dijkstra_shortest_paths
+ <LI>dijkstra_shortest_paths_no_color_map
+ <LI>bellman_ford_shortest_paths
+ <LI>dag_shortest_paths
+ <LI><A
+ href="./johnson_all_pairs_shortest.html"><tt>johnson_all_pairs_shortest_paths</tt></A>
+ <li>floyd_warshall_all_pairs_shortest_paths</li>
+ <li>r_c_shortest_paths - resource-constrained shortest paths</li>
+ </OL>
+ <LI>Minimum Spanning Tree Algorithms
+ <OL>
+ <LI><A
+ href="./kruskal_min_spanning_tree.html"><tt>kruskal_minimum_spanning_tree</tt></A>
+ <LI><A
+ href="./prim_minimum_spanning_tree.html"><tt>prim_minimum_spanning_tree</tt></A>
+ </OL>
+ <LI>Connected Components Algorithms
+ <OL>
+ <LI>connected_components
+ <LI>strong_components
+
+ <LI>biconnected_components
+ <LI>articulation_points
+ <LI>Incremental Connected Components
+ <OL>
+ <LI>initialize_incremental_components
+ <LI>incremental_components
+ <LI><A
+ href="./incremental_components.html#sec:same-component"><tt>same_component</tt></A>
+ <LI>component_index
+ </OL>
+ </OL></LI>
+ <LI>Maximum Flow and Matching Algorithms
+ <OL>
+ <LI>edmonds_karp_max_flow
+ <LI>push_relabel_max_flow
+ <li>kolmogorov_max_flow</li>
+ <LI>edmonds_maximum_cardinality_matching
+ </OL>
+
+ <li>Sparse Matrix Ordering Algorithms
+ <ol>
+ <LI><A
+ href="./cuthill_mckee_ordering.html"><tt>cuthill_mckee_ordering</tt></a>
+ <li>king_ordering</li>
+ <LI>minimum_degree_ordering
+ <li>sloan_ordering</li>
+ <li>sloan_start_end_vertices</li>
+ </ol>
+ </li>
+ <li>Sparse Matrix Ordering Metrics
+ <ol>
+ <LI>ith_wavefront, max_wavefront, aver_wavefront, and rms_wavefront</LI>
+ <LI>bandwidth
+ <LI>ith_bandwidth
+ </ol>
+ </li>
+ <LI>topological_sort
+ <li>transitive_closure
+ <li>Graph Structure Comparisons
+ <ol>
+ <LI>isomorphism
+ <li>mcgregor_common_subgraphs</li>
+ </ol>
- <li>Sparse Matrix Ordering Algorithms
+ <li>Path and Tour Algorithms
<ol>
- <LI><A
- href="./cuthill_mckee_ordering.html"><tt>cuthill_mckee_ordering</tt></a>
- <li>king_ordering</li>
- <LI>minimum_degree_ordering
+ <li>metric_tsp_approx</li>
</ol>
- </li>
- <LI>topological_sort
- <li>transitive_closure
- <LI>copy_graph
- <LI>transpose_graph
- <LI>isomorphism
-
- <li>Path and Tour Algorithms
- <ol>
- <li>metric_tsp_approx</li>
- </ol>
- </li>
-
- <LI>sequential_vertex_coloring
- <li>sloan_ordering</li>
- <li>sloan_start_end_vertices</li>
-
- <LI>ith_wavefront, max_wavefront, aver_wavefront, and rms_wavefront</LI>
- <LI>brandes_betweenness_centrality</LI>
- <li>Layout algorithms
+ </li>
+
+ <LI>sequential_vertex_coloring
+
+ <LI>brandes_betweenness_centrality</LI>
+ <li>Layout Algorithms
+ <ol>
+ <li>random_graph_layout</li>
+ <li>circle_layout</li>
+ <li>kamada_kawai_spring_layout</li>
+ <li>fruchterman_reingold_force_directed_layout</li>
+ <li>gursoy_atun_layout</li>
+ </ol>
+ </li>
+ <li>Clustering algorithms
<ol>
- <li>random_graph_layout</li>
- <li>circle_layout</li>
- <li>kamada_kawai_spring_layout</li>
- <li>fruchterman_reingold_force_directed_layout</li>
- <li>gursoy_atun_layout</li>
- </ol>
- </li>
- <li>Clustering algorithms
- <ol>
- <li>betweenness_centrality_clustering</li>
- </ol>
- </li>
- <li>astar_search</li>
- <li>lengauer_tarjan_dominator_tree</li>
- <li>minimum_cycle_ratio and maximum_cycle_ratio</li>
- <li>Planar Graph Algorithms
- <ol>
- <li><a href="boyer_myrvold.html">
- <tt>boyer_myrvold_planarity_test</tt></a>
- <li><a href="planar_face_traversal.html">
- <tt>planar_face_traversal</tt></a>
- <li><a href="planar_canonical_ordering.html">
- <tt>planar_canonical_ordering</tt></a>
- <li><a href="straight_line_drawing.html">
- <tt>chrobak_payne_straight_line_drawing</tt></a>
- <li><a href="is_straight_line_drawing.html">
- <tt>is_straight_line_drawing</tt></a>
- <li><a href="is_kuratowski_subgraph.html">
- <tt>is_kuratowski_subgraph</tt></a>
- <li><a href="make_connected.html">
- <tt>make_connected</tt></a>
- <li><a href="make_biconnected_planar.html">
- <tt>make_biconnected_planar</tt></a>
- <li><a href="make_maximal_planar.html">
- <tt>make_maximal_planar</tt></a>
- </ol>
- <li>lengauer_tarjan_dominator_tree</li>
- <li>mcgregor_common_subgraphs</li>
- </OL>
- </OL>
+ <li>betweenness_centrality_clustering</li>
+ </ol>
+ </li>
+ <li>astar_search</li>
+ <li>lengauer_tarjan_dominator_tree</li>
+ <li>minimum_cycle_ratio and maximum_cycle_ratio</li>
+ <li>Planar Graph Algorithms
+ <ol>
+ <li><a href="boyer_myrvold.html">
+ <tt>boyer_myrvold_planarity_test</tt></a>
+ <li><a href="planar_face_traversal.html">
+ <tt>planar_face_traversal</tt></a>
+ <li><a href="planar_canonical_ordering.html">
+ <tt>planar_canonical_ordering</tt></a>
+ <li><a href="straight_line_drawing.html">
+ <tt>chrobak_payne_straight_line_drawing</tt></a>
+ <li><a href="is_straight_line_drawing.html">
+ <tt>is_straight_line_drawing</tt></a>
+ <li><a href="is_kuratowski_subgraph.html">
+ <tt>is_kuratowski_subgraph</tt></a>
+ <li><a href="make_connected.html">
+ <tt>make_connected</tt></a>
+ <li><a href="make_biconnected_planar.html">
+ <tt>make_biconnected_planar</tt></a>
+ <li><a href="make_maximal_planar.html">
+ <tt>make_maximal_planar</tt></a>
+ </ol>
+ </OL>
<li>Graph Input/Output
<ol>
@@ -268,18 +278,16 @@
<LI>BasicMatrix
<LI>incident
<LI>opposite
- <LI>bandwidth
- <LI>ith_bandwidth
<LI>Tools for random graphs
<OL>
<LI>random_vertex
<LI>random_edge
<LI>generate_random_graph
<LI>randomize_property
- <li><a href="erdos_renyi_generator.html"><tt>erdos_renyi_iterator</tt></li>
- <li><a href="sorted_erdos_renyi_gen.html"><tt>sorted_erdos_renyi_iterator</tt></li>
- <li><a href="plod_generator.html"><tt>plod_iterator</tt></li>
- <li><a href="small_world_generator.html"><tt>small_world_iterator</tt></li>
+ <li>erdos_renyi_iterator</li>
+ <li>sorted_erdos_renyi_iterator</li>
+ <li>plod_iterator</li>
+ <li>small_world_iterator</li>
</OL>
</OL>
<LI>Challenge and To-Do List
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