Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r78185 - in sandbox/gtl: boost/polygon doc
From: sydorchuk.andriy_at_[hidden]
Date: 2012-04-24 18:09:55

Author: asydorchuk
Date: 2012-04-24 18:09:54 EDT (Tue, 24 Apr 2012)
New Revision: 78185
URL: http://svn.boost.org/trac/boost/changeset/78185

Log:
Adding segment concept documentation page.
Updating segment concept code.

Added:
   sandbox/gtl/doc/gtl_segment_concept.htm (contents, props changed)
Text files modified:
   sandbox/gtl/boost/polygon/segment_concept.hpp | 32 ++++++++++++++------------------
   1 files changed, 14 insertions(+), 18 deletions(-)

Modified: sandbox/gtl/boost/polygon/segment_concept.hpp
==============================================================================
--- sandbox/gtl/boost/polygon/segment_concept.hpp (original)
+++ sandbox/gtl/boost/polygon/segment_concept.hpp 2012-04-24 18:09:54 EDT (Tue, 24 Apr 2012)
@@ -117,7 +117,7 @@
>::type,
 void
>::type
- set(T& segment, direction_1d dir, point_type value) {
+ set(T& segment, direction_1d dir, const point_type& value) {
 segment_mutable_traits<T>::set(segment, dir, value);
 }

@@ -133,7 +133,7 @@
>::type,
 T
>::type
- construct(T2 low_value, T3 high_value) {
+ construct(const T2& low_value, const T3& high_value) {
 return segment_mutable_traits<T>::construct(low_value, high_value);
 }

@@ -153,9 +153,7 @@
 T
>::type
 copy_construct(const T2& segment) {
- return construct<T>
- (get(segment, LOW ),
- get(segment, HIGH));
+ return construct<T>(get(segment, LOW ), get(segment, HIGH));
 }

 struct y_s_assign : gtl_yes {};
@@ -195,7 +193,7 @@
>::type
 equivalence(const T& segment1, const T2& segment2) {
 return get(segment1, LOW) == get(segment2, LOW) &&
- get(segment1, HIGH) == get(segment2, HIGH);
+ get(segment1, HIGH) == get(segment2, HIGH);
 }

 struct y_s_on_above_or_below : gtl_yes {};
@@ -341,7 +339,7 @@
 void
>::type
 low(segment_type& segment,
- typename segment_point_type<segment_type>::type v) {
+ const typename segment_point_type<segment_type>::type& v) {
 set(segment, LOW, v);
 }

@@ -359,7 +357,7 @@
 void
>::type
 high(segment_type& segment,
- typename segment_point_type<segment_type>::type v) {
+ const typename segment_point_type<segment_type>::type& v) {
 set(segment, HIGH, v);
 }

@@ -373,7 +371,7 @@
 typename geometry_concept<segment_type>::type
>::type
>::type,
- typename segment_point_type<segment_type>::type
+ typename segment_distance_type<segment_type>::type
>::type
 length(const segment_type& segment) {
 return euclidean_distance(low(segment), high(segment));
@@ -540,7 +538,7 @@
 typename segment_distance_type<segment_type>::type
>::type
 euclidean_distance(const segment_type& segment,
- typename segment_point_type<segment_type>::type position) {
+ const typename segment_point_type<segment_type>::type& position) {
 typedef typename segment_distance_type<segment_type>::type Unit;
 Unit x1 = x(low(segment));
 Unit y1 = y(low(segment));
@@ -586,10 +584,10 @@
>::type
 euclidean_distance(const segment_type& segment,
 const segment_type_2& b) {
- typename segment_distance_type<segment_type>::type result1 =
- euclidean_distance(segment, low(b)),
- result2 = euclidean_distance(segment, high(b));
- if(result2 < result1) result1 = result2;
+ typename segment_distance_type<segment_type>::type
+ result1 = euclidean_distance(segment, low(b)),
+ result2 = euclidean_distance(segment, high(b));
+ if(result2 < result1) return result2;
 return result1;
 }

@@ -613,10 +611,8 @@
 const segment_type_2& b,
 bool consider_touch = true) {
 if(consider_touch) {
- if(low(segment) == low(b) ||
- low(segment) == high(b) ||
- high(segment) == low(b) ||
- high(segment) == high(b))
+ if(low(segment) == low(b) || low(segment) == high(b) ||
+ high(segment) == low(b) || high(segment) == high(b))
 return true;
 }
 typedef polygon_arbitrary_formation<

Added: sandbox/gtl/doc/gtl_segment_concept.htm
==============================================================================
--- (empty file)
+++ sandbox/gtl/doc/gtl_segment_concept.htm 2012-04-24 18:09:54 EDT (Tue, 24 Apr 2012)
@@ -0,0 +1,504 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:(null)1="http://www.w3.org/TR/REC-html40" lang="en"><head><title>Boost Polygon Library: Segment Concept</title>
+
+
+
+
+
+
+ <meta http-equiv="content-type" content="text/html;charset=ISO-8859-1" /></head><body>
+<table style="margin: 0pt; padding: 0pt; width: 100%;" border="0" cellpadding="0" cellspacing="0">
+
+ <tbody>
+ <tr>
+ <td style="background-color: rgb(238, 238, 238);" nowrap="1" valign="top">
+ <div style="padding: 5px;" align="center"> <img src="images/boost.png" border="0" height="86" width="277" /><a title="www.boost.org home page" href="http://www.boost.org/" tabindex="2" style="border: medium none ;"> </a> </div>
+ <div style="margin: 5px;">
+ <h3 class="navbar">Contents</h3>
+ <ul>
+ <li>Boost.Polygon Main Page</li>
+ <li>Design Overview</li>
+ <li>Isotropy</li>
+ <li>Coordinate Concept</li>
+ <li>Interval Concept</li>
+ <li>Point Concept 
+ </li>
+ <li>Segment Concept</li>
+ <li>Rectangle Concept</li>
+ <li>Polygon 90 Concept</li>
+ <li><a href="gtl_polygon_90_with_holes_concept.htm">Polygon 90
+With Holes Concept</a></li>
+ <li>Polygon 45 Concept</li>
+ <li><a href="gtl_polygon_45_with_holes_concept.htm">Polygon 45
+With Holes Concept</a></li>
+ <li>Polygon Concept</li>
+ <li><a href="gtl_polygon_with_holes_concept.htm">Polygon With
+Holes Concept</a></li>
+ <li><a href="gtl_polygon_90_set_concept.htm">Polygon 90 Set
+Concept</a></li>
+ <li><a href="gtl_polygon_45_set_concept.htm">Polygon 45 Set
+Concept</a></li>
+ <li>Polygon Set Concept</li>
+ <li><a href="gtl_connectivity_extraction_90.htm">Connectivity
+Extraction 90</a></li>
+ <li><a href="gtl_connectivity_extraction_45.htm">Connectivity
+Extraction 45</a></li>
+ <li><a href="gtl_connectivity_extraction.htm">Connectivity
+Extraction</a></li>
+ <li>Property Merge 90</li>
+ <li>Property Merge 45</li>
+ <li>Property Merge</li>
+ <li><a href="voronoi_main.htm">Voronoi Main Page 
+ </a></li>
+ <li>Voronoi Benchmark 
+ </li>
+ <li>Voronoi Builder</li>
+ <li><a href="voronoi_diagram.htm">Voronoi Diagram 
+ </a></li>
+ <li>Voronoi Predicates</li>
+ <li>Voronoi Robust FPT 
+ </li>
+ <li>Voronoi Utils</li>
+ </ul>
+ <h3 class="navbar">Other Resources</h3>
+ <ul>
+ <li>GTL Boostcon 2009 Paper</li>
+ <li><a href="GTL_boostcon_draft03.htm">GTL Boostcon 2009
+Presentation</a></li>
+ <li>Performance Analysis</li>
+ <li>Layout Versus Schematic Tutorial</li>
+ <li>Minkowski Sum Tutorial</li>
+ <li>Voronoi Basic Tutorial</li>
+ <li><a href="voronoi_advanced_tutorial.htm">Voronoi Advanced
+Tutorial</a></li>
+ </ul>
+ </div>
+ <h3 class="navbar">Polygon Sponsor</h3>
+ <div style="padding: 5px;" align="center"> <img src="images/intlogo.gif" border="0" height="51" width="127" /><a title="www.adobe.com home page" href="http://www.adobe.com/" tabindex="2" style="border: medium none ;"> </a> </div>
+ </td>
+ <td style="padding-left: 10px; padding-right: 10px; padding-bottom: 10px;" valign="top" width="100%"> 
+ 
+ <h1>Segment Concept</h1>
+ 
+ The segment concept tag is segment_concept
+ To register a user defined type as a model of segment
+concept, specialize the geometry concept meta-function for that
+type.  In the example below CSegment is registered as a model of
+the segment concept.
+ template <> 
+struct geometry_concept<CSegment>
+{ typedef segment_concept type; };
+ The semantic of a segment is
+that it has an low and high point.  A
+std::pair<std::pair<int, int>, std::pair<int,int>>,
+boost::tuple<boost::tuple<int, int>, boost::tuple<int,
+int>> or boost::array<int, 4> could all be made models of
+segment by simply providing indirect access to their elements through
+traits, however, these objects cannot be made a model of both segment
+and interval in the same compilation unit, for obvious reason that
+duplicate specialization of the geometry_concept struct is illegal, but
+also because it would make overloading generic function by concept
+ambiguous if a type modeled more than one concept.
+ Below is shown the default
+segment traits.  Specialization of these traits is required for
+types that don't conform to the default behavior.
+
+ template <typename T> 
+struct segment_traits { 
+  typedef typename T::coordinate_type coordinate_type; 
+  typedef typename T::point_type point_type; 
+ 
+  static inline point_type get(const T& segment, direction_1d dir) { 
+    return segment.get(dir); 
+  } 
+}; 
+ template <typename T> 
+struct segment_mutable_traits { 
+  template <typename Point1> 
+  static inline void set(T& segment, direction_1d dir, const Point1& value) { 
+    typename segment_traits<T>::point_type p1; 
+    assign(p1, value); 
+    segment.set(dir, value); 
+  } 
+ 
+  template <typename Point1, typename Point2> 
+  static inline T construct(const Point1& low_value, 
+                           
+const Point2& high_value) { 
+    typename segment_traits<T>::point_type p1, p2; 
+    assign(p1, low_value); 
+    assign(p2, high_value); 
+    return T(p1, p2); 
+  } 
+}; 
+ 
+
+ Example code custom_segment.cpp
+demonstrates how to map a user defined segment class to the library segment_concept.
+ <h2>Functions</h2>
+ <table style="width: 100%;" id="table1" border="1">
+ <tbody>
+ <tr>
+ <td width="586">template
+<typename T> point_type<T> get(const T& segment, direction_1d dir)</td>
+ <td>Expects a model of segment.  Returns the low or high endpoint of the segment, depending on
+the direction_1d value. 
+ </td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename T, typename point_type> 
+void set(T& segment, direction_1d dir, 
+    const point_type& point)</td>
+ <td>Expects a model of segment. Sets the low or high endpoint of the segment to the point, depending on the direction_1d  value.</td>
+ </tr>
+ <tr>
+ <td width="586">template <typename T, typename T2, typename T3> 
+T construct(const T2& low_value, const T3& high_value)</td>
+ <td>Construct an object that is a model of segment given both endpoints.</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;">template <typename T, typename T2> 
+T copy_construct(const T2& segment)</td>
+ <td style="vertical-align: middle; text-align: left;">Copy construct an object that is a model of segment given another segment.</td>
+ </tr>
+<tr>
+ <td width="586">template
+<typename T1, typename T2> 
+T1& assign(T1& lvalue, const T2& rvalue)</td>
+ <td>Copies data from right object that models segment into
+left object that models segment.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename T, typename T2> 
+bool equivalence(const T& segment, const T2& segment2)</td>
+ <td>Given two objects that model segment, compares and
+returns true if their low and high values are respectively equal to each
+other.</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;">template <typename segment_type> 
+ bool on_above_or_below(const segment_type& segment, 
+     point_type value) 
+ </td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;">template <typename segment_type> 
+ bool contains(const segment_type& segment, 
+     point_type value, bool consider_touch) 
+ </td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;">template <typename segment_type, typename segment_type_2> 
+
+ bool contains(const segment_type& segment, 
+
+     const segment_type_2& value, 
+
+     bool consider_touch)</td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename segment_type> 
+point_type low(const segment_type& segment) 
+ </td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename segment_type> 
+point_type high(const segment_type& segment)</td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename segment_type> 
+point_type center(const segment_type& segment)</td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename segment_type> 
+point_type low(const segment_type& segment, 
+    const segment_type::point_type& v)</td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename segment_type> 
+point_type high(const segment_type& segment, 
+
+    const segment_type::point_type& v)</td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;">template <typename segment_type> 
+ distance_type length(const segment_type& segment) 
+ </td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+
+
+
+
+ <tr>
+ <td width="586">template
+<typename segment_type> segment_type& scale_up(segment_type& segment,     unsigned_area_type factor)</td>
+ <td>Multiplies x and y coordinates of both endpoints of an object that models segment by unsigned factor.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename segment_type> 
+ segment_type& scale_down(segment_type& segment, 
+    unsigned_area_type factor)</td>
+ <td>Divides x and y coordinates of both endpoints of an object that models segment by unsigned factor.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename segment_type, typename scaling_type> 
+ segment_type& scale(segment_type& segment, 
+    const scaling_type& factor) </td>
+ <td>Calls
+the scale member function of scaling type on the low and high point of
+an object that models segment and updates the segment with the
+scaled points.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename segment_type, typename transform_type> 
+segment_type& transform(segment_type& segment, 
+    const transform_type& transform) </td>
+ <td>Calls the transform member function of transform type
+on the low and high endpoints of an object that models segment and updates the segment with the transformed endpoints.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename segment_type> 
+ segment_type& move(segment_type& segment, orientation_2d 
+    coordinate_difference displacement)</td>
+ <td>Adds displacement value to the coordinates of both endpoints of an object
+that models segment indicated by the orientation_2d.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<segment_type> 
+segment_type& convolve(segment_type& segment, 
+    const point_type& b)</td>
+ <td>Convolves both endpoints of an object that models segment with b. 
+</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<segment_type> 
+ segment_type& deconvolve(segment_type& segment, 
+    const point_type& b)</td>
+ <td>Deconvolves both endpoints of an object that models segment with b. </td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename segment_type> distance_type euclidean_distance( 
+    const segment_type& segment,    
+const point_type& point)</td>
+ <td>Returns the distance from an object that models segment
+to a second object that models point.</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;">template
+<typename segment_type, typename segment_type_2> distance_type euclidean_distance( 
+    const segment_type& segment,    
+const segment_type_2& b)</td>
+ <td style="vertical-align: middle;">Returns the distance from an object that models segment
+to a second object that models segment.</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;"> 
+ </td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;"> 
+ </td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;"> 
+ </td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;"> 
+ </td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;"> 
+ </td>
+ <td style="vertical-align: top;"> 
+ </td>
+ </tr>
+
+
+
+ </tbody>
+ </table>
+ <h1>Segment Data</h1>
+ 
+ The library provides a model of the segment concept declared template<typename T> segment_data where
+T is the coordinate type.
+ This data type is used internally when a segment is needed and
+is available to the library user who finds it convenient to use a
+library segment data type instead of providing their own.  The data
+type is implemented to be convenient to use with the library traits.
+ Example code segment_usage.cpp
+demonstrates using the library provided segment data type and functions
+ <h2>Members</h2>
+ <table id="table2" border="1" width="100%">
+ <tbody>
+ <tr>
+ <td width="586">geometry_type</td>
+ <td>segment_concept</td>
+ </tr>
+ <tr>
+ <td width="586">coordinate_type</td>
+ <td>T</td>
+ </tr>
+ <tr>
+ <td style="vertical-align: top;">point_type</td>
+ <td style="vertical-align: top;">point_data<T> 
+ </td>
+ </tr>
+<tr>
+ <td width="586">segment_data()</td>
+ <td>Default constructs the two endpoints of the segment.</td>
+ </tr>
+ <tr>
+ <td width="586">segment_data(point_type low, point_type high)</td>
+ <td>Constructs a segment from the given endpoints.</td>
+ </tr>
+ <tr>
+ <td width="586">segment_data(const segment_data& that)</td>
+ <td>Copy constructor.</td>
+ </tr>
+ <tr>
+ <td width="586">segment_data& operator=(const segment_data& that)</td>
+ <td>Assignment operator.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename T2> 
+ point_data& operator=(const T2& that)
+const</td>
+ <td>Assign from an object that is a model of point.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename T2> 
+ bool operator==(const T2& that) const</td>
+ <td>Compare equality to an object that is a model of point.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename T2> 
+ bool operator!=(const T2& that) const</td>
+ <td>Compare inequality to an object that is a model of
+point.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename T2> 
+ bool operator<(const T2& that) const</td>
+ <td>Compares y coordinates then x coordinates to break ties.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename T2> 
+ bool operator<=(const T2& that) const</td>
+ <td>Compares y coordinates then x coordinates to break ties.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename T2> 
+ bool operator>(const T2& that) const</td>
+ <td>Compares low coordinates then high coordinates to break
+ties.</td>
+ </tr>
+ <tr>
+ <td width="586">template
+<typename T2> 
+ bool operator>=(const T2& that) const</td>
+ <td>Compares low coordinates then high coordinates to break
+ties.</td>
+ </tr>
+ <tr>
+ <td width="586">T get(orientation_2d
+orient) const</td>
+ <td>Get the coordinate in the given orientation.</td>
+ </tr>
+ <tr>
+ <td width="586">T x() const</td>
+ <td>Get the coordinate in the horizontal orientation.</td>
+ </tr>
+ <tr>
+ <td width="586">T y() const</td>
+ <td>Get the coordinate in the vertical orientation.</td>
+ </tr>
+ <tr>
+ <td width="586">void set(orientation_2d
+orient, T value)</td>
+ <td>Sets the coordinate in the given orientation to the
+value.</td>
+ </tr>
+ <tr>
+ <td width="586">void x(T
+value)</td>
+ <td>Sets the coordinate in the horizontal orientation to
+the value.</td>
+ </tr>
+ <tr>
+ <td width="586">void y(T
+value)</td>
+ <td>Sets the coordinate in the vertical orientation to the
+value.</td>
+ </tr>
+ </tbody>
+ </table>
+ </td>
+ </tr>
+ <tr>
+ <td style="background-color: rgb(238, 238, 238);" nowrap="1" valign="top">  </td>
+ <td style="padding-left: 10px; padding-right: 10px; padding-bottom: 10px;" valign="top" width="100%">
+ <table class="docinfo" id="table3" frame="void" rules="none">
+ <colgroup> <col class="docinfo-name" /><col class="docinfo-content" /> </colgroup> <tbody valign="top">
+ <tr>
+ <th class="docinfo-name">Copyright:</th>
+ <td>Copyright © Intel Corporation 2008-2010.</td>
+ </tr>
+ <tr class="field">
+ <th class="docinfo-name">License:</th>
+ <td class="field-body">Distributed under the Boost Software
+License, Version 1.0. (See accompanying file <tt class="literal"> LICENSE_1_0.txt</tt> or copy at <a class="reference" target="_top" href="http://www.boost.org/LICENSE_1_0.txt">
+http://www.boost.org/LICENSE_1_0.txt>)</td>
+ </tr>
+ </tbody>
+ </table>
+ </td>
+ </tr>
+ </tbody>
+</table>
+
+</body></html>
\ No newline at end of file

Next message: sydorchuk.andriy_at_[hidden]: "[Boost-commit] svn:boost r78186 - sandbox/gtl/boost/polygon"
Previous message: jeffrey.hellrung_at_[hidden]: "[Boost-commit] svn:boost r78184 - in branches/release: boost/iterator libs/iterator libs/iterator/doc libs/iterator/test"

Date view	Thread view	Subject view	Author view

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