[Boost-commit] svn:boost r60899 - trunk/libs/graph/doc

Subject: [Boost-commit] svn:boost r60899 - trunk/libs/graph/doc
From: jewillco_at_[hidden]
Date: 2010-03-28 14:16:52

Author: jewillco
Date: 2010-03-28 14:16:51 EDT (Sun, 28 Mar 2010)
New Revision: 60899
URL: http://svn.boost.org/trac/boost/changeset/60899

Log:
Added preconditions on graph listed in #3807; fixes #3807
Text files modified: 
   trunk/libs/graph/doc/planar_canonical_ordering.html |    10 ++++++++++                              
   1 files changed, 10 insertions(+), 0 deletions(-)

Modified: trunk/libs/graph/doc/planar_canonical_ordering.html
==============================================================================
--- trunk/libs/graph/doc/planar_canonical_ordering.html	(original)
+++ trunk/libs/graph/doc/planar_canonical_ordering.html	2010-03-28 14:16:51 EDT (Sun, 28 Mar 2010)
@@ -82,6 +82,16 @@
 <blockquote>
 An undirected graph. The graph type must be a model of 
 <a href="VertexAndEdgeListGraph.html">VertexAndEdgeListGraph</a>.
+The graph must:
+<ul>
+<li>Be maximal planar.</li>
+<li>Have at least two vertices.</li>
+<li>Have the edge <i>{v<sub>0</sub>, v<sub>1</sub>}</i> on its outer face,
+where <i>v<sub>0</sub></i> is <tt>*vertices(g).first</tt> and
+<i>v<sub>1</sub></i> is the first element of
+<tt>adjacent_vertices(</tt><i>v<sub>0</sub></i><tt>, g)</tt> distinct from
+<i>v<sub>0</sub></i>.</li>
+</ul>
 </blockquote>
 
 IN: <tt>PlanarEmbedding</tt>