Some documentation bugs

[Matthias Berndt <matthias_berndt@…>]

Hi,

i have hit a few documentation bugs in the graph library's documentation that made it hard for me to make sense of it.

On http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/graph_concepts.html it says that VertexListGraph refines IncidenceGraph and AdjacencyGraph, but this can't be seen in the diagram in figure 1.

On http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/VertexListGraph.html it says that VertexListGraph refines Graph, but it doesn't say that it refines AdjacencyGraph and IncidenceGraph.

On http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/astar_search.html it says: "Please note that astar_search_no_init() must be used for implicit graphs; the basic astar_search() function requires a graph that models VertexListGraph". This seems to imply that astar_search_no_init() doesn't require a VertexListGraph. Nevertheless, the template parameter in the prototype for the function is called VertexListGraph. Shouldn't that be IncidenceGraph?

[Jeremiah Willcock]

(In [63466]) Fixed various BGL documentation bugs; fixes #4386

[Matthias Berndt <matthias_berndt@…>]

Hi again,

I am now confused.

• the astar_search algorithm takes a VertexListGraph, and A* needs to be able to traverse a vertex's out-edges, thus one can conclude that VertexListGraph must be a refinement of IncidenceGraph
• the way i read it, the documentation for the VertexListGraph concept argues in the rationale section that VertexListGraph should be a refinement of IncidenceGraph

And yet, you altered the documentation to say that VertexListGraph doesn't refine IncidenceGraph (which is confirmed by the fact that the VertexListGraphConcept concept checking class doesn't check for out_edge_iterator etc). How does that fit together?

[Jeremiah Willcock]

(In [63530]) Changed to using const reference for input graphs; added Incidence Graph requirements to documentation; fixes #4386

[Dave Abrahams]

The confusion about astar_search_no_init's requirements and its template parameter names remains. The text is not very clear on what its requirements should be (presumably IncidenceGraph, but that's only a guess) and its template parameter name still implies VertexListGraph is required.

[Jeremiah Willcock]

(In [81602]) Fixed template parameter names; fixes #4386