Boost C++ Libraries: Ticket #4386: Some documentation bugs https://svn.boost.org/trac10/ticket/4386 <p> Hi, </p> <p> i have hit a few documentation bugs in the graph library's documentation that made it hard for me to make sense of it. </p> <p> On <a href="http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/graph_concepts.html">http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/graph_concepts.html</a> it says that <a class="missing wiki">VertexListGraph</a> refines <a class="missing wiki">IncidenceGraph</a> and <a class="missing wiki">AdjacencyGraph</a>, but this can't be seen in the diagram in figure 1. </p> <p> On <a href="http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/VertexListGraph.html">http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/VertexListGraph.html</a> it says that <a class="missing wiki">VertexListGraph</a> refines Graph, but it doesn't say that it refines <a class="missing wiki">AdjacencyGraph</a> and <a class="missing wiki">IncidenceGraph</a>. </p> <p> On <a href="http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/astar_search.html">http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/astar_search.html</a> 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 <a class="missing wiki">VertexListGraph</a>". This seems to imply that astar_search_no_init() doesn't require a <a class="missing wiki">VertexListGraph</a>. Nevertheless, the template parameter in the prototype for the function is called <a class="missing wiki">VertexListGraph</a>. Shouldn't that be <a class="missing wiki">IncidenceGraph</a>? </p> en-us Boost C++ Libraries /htdocs/site/boost.png https://svn.boost.org/trac10/ticket/4386 Trac 1.4.3 Jeremiah Willcock Thu, 01 Jul 2010 05:09:26 GMT status changed; resolution set https://svn.boost.org/trac10/ticket/4386#comment:1 https://svn.boost.org/trac10/ticket/4386#comment:1 <ul> <li><strong>status</strong> <span class="trac-field-old">new</span> → <span class="trac-field-new">closed</span> </li> <li><strong>resolution</strong> → <span class="trac-field-new">fixed</span> </li> </ul> <p> (In <a class="changeset" href="https://svn.boost.org/trac10/changeset/63466" title="Fixed various BGL documentation bugs; fixes #4386">[63466]</a>) Fixed various BGL documentation bugs; fixes <a class="closed ticket" href="https://svn.boost.org/trac10/ticket/4386" title="#4386: Bugs: Some documentation bugs (closed: fixed)">#4386</a> </p> Ticket Matthias Berndt <matthias_berndt@…> Fri, 02 Jul 2010 12:00:48 GMT status changed; resolution deleted https://svn.boost.org/trac10/ticket/4386#comment:2 https://svn.boost.org/trac10/ticket/4386#comment:2 <ul> <li><strong>status</strong> <span class="trac-field-old">closed</span> → <span class="trac-field-new">reopened</span> </li> <li><strong>resolution</strong> <span class="trac-field-deleted">fixed</span> </li> </ul> <p> Hi again, </p> <p> I am now confused. </p> <ul><li>the astar_search algorithm takes a <a class="missing wiki">VertexListGraph</a>, and A* needs to be able to traverse a vertex's out-edges, thus one can conclude that <a class="missing wiki">VertexListGraph</a> must be a refinement of <a class="missing wiki">IncidenceGraph</a> </li><li>the way i read it, the documentation for the <a class="missing wiki">VertexListGraph</a> concept argues in the rationale section that <a class="missing wiki">VertexListGraph</a> should be a refinement of <a class="missing wiki">IncidenceGraph</a> </li></ul><p> And yet, you altered the documentation to say that <a class="missing wiki">VertexListGraph</a> doesn't refine <a class="missing wiki">IncidenceGraph</a> (which is confirmed by the fact that the <a class="missing wiki">VertexListGraphConcept</a> concept checking class doesn't check for out_edge_iterator etc). How does that fit together? </p> Ticket Jeremiah Willcock Fri, 02 Jul 2010 19:30:58 GMT status changed; resolution set https://svn.boost.org/trac10/ticket/4386#comment:3 https://svn.boost.org/trac10/ticket/4386#comment:3 <ul> <li><strong>status</strong> <span class="trac-field-old">reopened</span> → <span class="trac-field-new">closed</span> </li> <li><strong>resolution</strong> → <span class="trac-field-new">fixed</span> </li> </ul> <p> (In <a class="changeset" href="https://svn.boost.org/trac10/changeset/63530" title="Changed to using const reference for input graphs; added Incidence ...">[63530]</a>) Changed to using const reference for input graphs; added Incidence Graph requirements to documentation; fixes <a class="closed ticket" href="https://svn.boost.org/trac10/ticket/4386" title="#4386: Bugs: Some documentation bugs (closed: fixed)">#4386</a> </p> Ticket Dave Abrahams Tue, 27 Nov 2012 09:48:09 GMT status changed; resolution deleted https://svn.boost.org/trac10/ticket/4386#comment:4 https://svn.boost.org/trac10/ticket/4386#comment:4 <ul> <li><strong>status</strong> <span class="trac-field-old">closed</span> → <span class="trac-field-new">reopened</span> </li> <li><strong>resolution</strong> <span class="trac-field-deleted">fixed</span> </li> </ul> <p> The confusion about <code>astar_search_no_init</code>'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. </p> Ticket Jeremiah Willcock Tue, 27 Nov 2012 22:17:30 GMT status changed; resolution set https://svn.boost.org/trac10/ticket/4386#comment:5 https://svn.boost.org/trac10/ticket/4386#comment:5 <ul> <li><strong>status</strong> <span class="trac-field-old">reopened</span> → <span class="trac-field-new">closed</span> </li> <li><strong>resolution</strong> → <span class="trac-field-new">fixed</span> </li> </ul> <p> (In <a class="changeset" href="https://svn.boost.org/trac10/changeset/81602" title="Fixed template parameter names; fixes #4386">[81602]</a>) Fixed template parameter names; fixes <a class="closed ticket" href="https://svn.boost.org/trac10/ticket/4386" title="#4386: Bugs: Some documentation bugs (closed: fixed)">#4386</a> </p> Ticket