Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r55787 - in sandbox/gtl: boost/polygon doc
From: lucanus.j.simonson_at_[hidden]
Date: 2009-08-26 11:49:04


Author: ljsimons
Date: 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
New Revision: 55787
URL: http://svn.boost.org/trac/boost/changeset/55787

Log:
fixed return types of error APIs of polygon 45 set data and documented them
Text files modified:
   sandbox/gtl/boost/polygon/polygon_45_set_data.hpp | 4 ++--
   sandbox/gtl/doc/gtl_custom_point.htm | 9 ++++++++-
   sandbox/gtl/doc/gtl_custom_polygon.htm | 9 ++++++++-
   sandbox/gtl/doc/gtl_custom_polygon_set.htm | 9 ++++++++-
   sandbox/gtl/doc/gtl_point_usage.htm | 9 ++++++++-
   sandbox/gtl/doc/gtl_polygon_45_set_concept.htm | 23 +++++++++++++++++++++++
   sandbox/gtl/doc/gtl_polygon_set_usage.htm | 9 ++++++++-
   sandbox/gtl/doc/gtl_polygon_usage.htm | 9 ++++++++-
   sandbox/gtl/doc/gtl_property_merge_usage.htm | 9 ++++++++-
   9 files changed, 81 insertions(+), 9 deletions(-)

Modified: sandbox/gtl/boost/polygon/polygon_45_set_data.hpp
==============================================================================
--- sandbox/gtl/boost/polygon/polygon_45_set_data.hpp (original)
+++ sandbox/gtl/boost/polygon/polygon_45_set_data.hpp 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
@@ -148,8 +148,8 @@
       get_dispatch(output, typename geometry_concept<typename output_container::value_type>::type());
     }
 
- inline void has_error_data() const { return !error_data_.empty(); }
- inline unsigned int error_count() const { return error_data_.size() / 4; }
+ inline bool has_error_data() const { return !error_data_.empty(); }
+ inline std::size_t error_count() const { return error_data_.size() / 4; }
     inline void get_error_data(polygon_45_set_data& p) const {
       p.data_.insert(p.data_.end(), error_data_.begin(), error_data_.end());
     }

Modified: sandbox/gtl/doc/gtl_custom_point.htm
==============================================================================
--- sandbox/gtl/doc/gtl_custom_point.htm (original)
+++ sandbox/gtl/doc/gtl_custom_point.htm 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
@@ -7,7 +7,14 @@
 
 <body>
 
-<p><font face="Courier New">#include &lt;boost/polygon/polygon.hpp&gt;<br>
+<p><font face="Courier New">/*<br>
+Copyright 2008 Intel Corporation<br>
+<br>
+Use, modification and distribution are subject to the Boost Software License,<br>
+Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at<br>
+http://www.boost.org/LICENSE_1_0.txt).<br>
+*/<br>
+#include &lt;boost/polygon/polygon.hpp&gt;<br>
 #include &lt;cassert&gt;<br>
 namespace gtl = boost::polygon;<br>
 using namespace boost::polygon::operators;<br><br>

Modified: sandbox/gtl/doc/gtl_custom_polygon.htm
==============================================================================
--- sandbox/gtl/doc/gtl_custom_polygon.htm (original)
+++ sandbox/gtl/doc/gtl_custom_polygon.htm 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
@@ -7,7 +7,14 @@
 
 <body>
 
-<p><font face="Courier New">#include &lt;boost/polygon/polygon.hpp&gt;<br>
+<p><font face="Courier New">/*<br>
+Copyright 2008 Intel Corporation<br>
+<br>
+Use, modification and distribution are subject to the Boost Software License,<br>
+Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at<br>
+http://www.boost.org/LICENSE_1_0.txt).<br>
+*/<br>
+#include &lt;boost/polygon/polygon.hpp&gt;<br>
 #include &lt;cassert&gt;<br>
 #include &lt;list&gt;<br>
 namespace gtl = boost::polygon;<br>

Modified: sandbox/gtl/doc/gtl_custom_polygon_set.htm
==============================================================================
--- sandbox/gtl/doc/gtl_custom_polygon_set.htm (original)
+++ sandbox/gtl/doc/gtl_custom_polygon_set.htm 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
@@ -7,7 +7,14 @@
 
 <body>
 
-<p><font face="Courier New">#include &lt;boost/polygon/polygon.hpp&gt;<br>
+<p><font face="Courier New">/*<br>
+Copyright 2008 Intel Corporation<br>
+<br>
+Use, modification and distribution are subject to the Boost Software License,<br>
+Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at<br>
+http://www.boost.org/LICENSE_1_0.txt).<br>
+*/<br>
+#include &lt;boost/polygon/polygon.hpp&gt;<br>
 #include &lt;list&gt;<br>
 #include &lt;time.h&gt;<br>
 #include &lt;cassert&gt;<br>

Modified: sandbox/gtl/doc/gtl_point_usage.htm
==============================================================================
--- sandbox/gtl/doc/gtl_point_usage.htm (original)
+++ sandbox/gtl/doc/gtl_point_usage.htm 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
@@ -7,7 +7,14 @@
 
 <body>
 
-<p><font face="Courier New">#include &lt;boost/polygon/polygon.hpp&gt;<br>
+<p><font face="Courier New">/*<br>
+Copyright 2008 Intel Corporation<br>
+<br>
+Use, modification and distribution are subject to the Boost Software License,<br>
+Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at<br>
+http://www.boost.org/LICENSE_1_0.txt).<br>
+*/<br>
+#include &lt;boost/polygon/polygon.hpp&gt;<br>
 #include &lt;cassert&gt;<br>
 namespace gtl = boost::polygon;<br>
 using namespace boost::polygon::operators;<br><br>

Modified: sandbox/gtl/doc/gtl_polygon_45_set_concept.htm
==============================================================================
--- sandbox/gtl/doc/gtl_polygon_45_set_concept.htm (original)
+++ sandbox/gtl/doc/gtl_polygon_45_set_concept.htm 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
@@ -623,6 +623,29 @@
                 <td width="586"><font face="Courier New">polygon_45_set_data&amp; <b>self_intersect</b>()</font></td>
                 <td>Retain only overlapping regions of geometry within a polygon set.</td>
         </tr>
+ <tr>
+ <td width="586"><font face="Courier New">bool <b>has_error_data</b>()
+ const </font></td>
+ <td>Returns true if non-integer intersections resulted in small
+ artifacts in the output of a boolean.</td>
+ </tr>
+ <tr>
+ <td width="586"><font face="Courier New">std::size_t <b>error_count</b>()
+ const</font></td>
+ <td>Returns the number of artifacts that may potentially be present in
+ the output due to non-integer intersections.</td>
+ </tr>
+ <tr>
+ <td width="586"><font face="Courier New">void <b>get_error_data</b>(polygon_45_set_data&amp;
+ p) const</font></td>
+ <td>Populates the input polygon set with 1x1 unit squares that bound the
+ error that may be present in the output due to non-integer
+ intersections.</td>
+ </tr>
+ <tr>
+ <td width="586"><font face="Courier New">polygon_45_set_data&amp; <b>self_intersect</b>()</font></td>
+ <td>Retain only overlapping regions of geometry within a polygon set.</td>
+ </tr>
         </table>
         <tr>
 <td style="background-color: rgb(238, 238, 238);" nowrap="1" valign="top">

Modified: sandbox/gtl/doc/gtl_polygon_set_usage.htm
==============================================================================
--- sandbox/gtl/doc/gtl_polygon_set_usage.htm (original)
+++ sandbox/gtl/doc/gtl_polygon_set_usage.htm 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
@@ -7,7 +7,14 @@
 
 <body>
 
-<p><font face="Courier New">#include &lt;boost/polygon/polygon.hpp&gt;<br>
+<p><font face="Courier New">/*<br>
+Copyright 2008 Intel Corporation<br>
+<br>
+Use, modification and distribution are subject to the Boost Software License,<br>
+Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at<br>
+http://www.boost.org/LICENSE_1_0.txt).<br>
+*/<br>
+#include &lt;boost/polygon/polygon.hpp&gt;<br>
 #include &lt;cassert&gt;<br>
 namespace gtl = boost::polygon;<br>
 using namespace boost::polygon::operators;<br><br>

Modified: sandbox/gtl/doc/gtl_polygon_usage.htm
==============================================================================
--- sandbox/gtl/doc/gtl_polygon_usage.htm (original)
+++ sandbox/gtl/doc/gtl_polygon_usage.htm 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
@@ -7,7 +7,14 @@
 
 <body>
 
-<p><font face="Courier New">#include &lt;boost/polygon/polygon.hpp&gt;<br>
+<p><font face="Courier New">/*<br>
+Copyright 2008 Intel Corporation<br>
+<br>
+Use, modification and distribution are subject to the Boost Software License,<br>
+Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at<br>
+http://www.boost.org/LICENSE_1_0.txt).<br>
+*/<br>
+#include &lt;boost/polygon/polygon.hpp&gt;<br>
 #include &lt;cassert&gt;<br>
 namespace gtl = boost::polygon;<br>
 using namespace boost::polygon::operators;<br><br>

Modified: sandbox/gtl/doc/gtl_property_merge_usage.htm
==============================================================================
--- sandbox/gtl/doc/gtl_property_merge_usage.htm (original)
+++ sandbox/gtl/doc/gtl_property_merge_usage.htm 2009-08-26 11:49:02 EDT (Wed, 26 Aug 2009)
@@ -7,7 +7,14 @@
 
 <body>
 
-<p><font face="Courier New">#include &lt;boost/polygon/polygon.hpp&gt;<br>
+<p><font face="Courier New">/*<br>
+Copyright 2008 Intel Corporation<br>
+<br>
+Use, modification and distribution are subject to the Boost Software License,<br>
+Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at<br>
+http://www.boost.org/LICENSE_1_0.txt).<br>
+*/<br>
+#include &lt;boost/polygon/polygon.hpp&gt;<br>
 #include &lt;cassert&gt;<br>
 namespace gtl = boost::polygon;<br>
 using namespace boost::polygon::operators;<br>


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk