Modify

Ticket #4386 (closed Bugs: fixed)

Opened 4 years ago

Last modified 17 months ago

Some documentation bugs

Reported by: Matthias Berndt <matthias_berndt@…> Owned by: asutton
Milestone: To Be Determined Component: graph
Version: Boost 1.43.0 Severity: Problem
Keywords: Cc:

Description

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??

Attachments

Change History

comment:1 Changed 4 years ago by jewillco

  • Status changed from new to closed
  • Resolution set to fixed

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

comment:2 Changed 4 years ago by Matthias Berndt <matthias_berndt@…>

  • Status changed from closed to reopened
  • Resolution fixed deleted

Hi again,

I am now confused.

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?

comment:3 Changed 4 years ago by jewillco

  • Status changed from reopened to closed
  • Resolution set to fixed

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

comment:4 Changed 17 months ago by dave

  • Status changed from closed to reopened
  • Resolution fixed deleted

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.

comment:5 Changed 17 months ago by jewillco

  • Status changed from reopened to closed
  • Resolution set to fixed

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

View

Add a comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
The resolution will be deleted. Next status will be 'reopened'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.