Re: [Boost-bugs] [Boost C++ Libraries] #3807: Documentation improvement for graph/planar_canonical_ordering.hpp.

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #3807: Documentation improvement for graph/planar_canonical_ordering.hpp.
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-03-16 18:51:47

#3807: Documentation improvement for graph/planar_canonical_ordering.hpp.
-------------------------------------------------+--------------------------
 Reporter:  Tim Gee <writetotimgee@…>            |       Owner:  asutton 
     Type:  Bugs                                 |      Status:  new     
Milestone:  Boost 1.42.0                         |   Component:  graph   
  Version:  Boost 1.41.0                         |    Severity:  Cosmetic
 Keywords:  planar canonical ordering            |  
-------------------------------------------------+--------------------------

Comment(by anonymous):

 Just checked:
 http://www.boost.org/doc/libs/1_42_0/libs/graph/doc/planar_canonical_ordering.html


 Sorry, no I don't think the current documentation is adequate. The
 description of the algorithm output is accurate and clear (as described in
 the first paragraph), but the pre-requisites for the algorithm are not
 clear. This is particularly important, as if the inputs are not supplied
 correctly, the algorithm doesn't degrade nicely (it just produces a bogus
 ordering).

 The input graph must:
 a) Be maximal planar.
 b) Have at least two vertices.
 c) Must contain contain the edge {v1, v2} on its outer face.

 The documentation makes it clear that c) is true of the output - but isn't
 clear that it is also necessary in the input.

 *Also, I should note that my original example didn't meet criteria (a) as
 it was planar triangular and maximal planar (requires [0,3] to be
 maximal). That's my own fault for not originally understanding the
 difference.

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/3807#comment:4>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.