Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r78198 - in sandbox/gtl: boost/polygon doc
From: sydorchuk.andriy_at_[hidden]
Date: 2012-04-25 19:21:05

Author: asydorchuk
Date: 2012-04-25 19:21:04 EDT (Wed, 25 Apr 2012)
New Revision: 78198
URL: http://svn.boost.org/trac/boost/changeset/78198

Log:
Updating segment docs/sources.

Text files modified:
   sandbox/gtl/boost/polygon/segment_concept.hpp | 37 ++++---
   sandbox/gtl/boost/polygon/segment_data.hpp | 6
   sandbox/gtl/doc/gtl_segment_concept.htm | 187 ++++++++++++++++++---------------------
   3 files changed, 110 insertions(+), 120 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-25 19:21:04 EDT (Wed, 25 Apr 2012)
@@ -238,7 +238,7 @@
 contains(const Segment& segment,
 const typename segment_point_type<Segment>::type& point,
 bool consider_touch = true ) {
- if(on_above_or_below(segment, point) == 0) {
+ if(!on_above_or_below(segment, point)) {
 rectangle_data<typename segment_coordinate_type<Segment>::type> rect;
 set_points(rect, low(segment), high(segment));
 if(area(rect) == 0.0) {
@@ -247,7 +247,7 @@
 !equivalence(point, high(segment));
 }
 }
- return contains(rect, value, consider_touch);
+ return contains(rect, point, consider_touch);
 }
 return false;
 }
@@ -267,11 +267,11 @@
>::type,
 bool
>::type
- contains(const Segment1& segment,
- const Segment2& value,
+ contains(const Segment1& segment1,
+ const Segment2& segment2,
 bool consider_touch = true) {
- return contains(segment, get(value, LOW), consider_touch) &&
- contains(segment, get(value, HIGH), consider_touch);
+ return contains(segment1, get(segment2, LOW), consider_touch) &&
+ contains(segment1, get(segment2, HIGH), consider_touch);
 }

 struct y_s_low : gtl_yes {};
@@ -446,7 +446,7 @@

 struct y_s_transform : gtl_yes {};

- template <typename Segment, typename transform_type>
+ template <typename Segment, typename Transform>
 typename enable_if<
 typename gtl_and<
 y_s_transform,
@@ -456,7 +456,7 @@
>::type,
 Segment
>::type &
- transform(Segment& segment, const transform_type& val) {
+ transform(Segment& segment, const Transform& val) {
 typename segment_point_type<Segment>::type l = low(segment), h = high(segment);
 low(segment, transform(l, val));
 high(segment, transform(h, val));
@@ -529,25 +529,27 @@
 struct y_s_e_dist : gtl_yes {};

 // distance from a point to a segment
- template <typename Segment>
+ template <typename Segment, typename Point>
 typename enable_if<
- typename gtl_and<
+ typename gtl_and_3<
 y_s_e_dist,
 typename is_segment_concept<
 typename geometry_concept<Segment>::type
+ >::type,
+ typename is_point_concept<
+ typename geometry_concept<Point>::type
>::type
>::type,
 typename segment_distance_type<Segment>::type
>::type
- euclidean_distance(const Segment& segment,
- const typename segment_point_type<Segment>::type& position) {
+ euclidean_distance(const Segment& segment, const Point& point) {
 typedef typename segment_distance_type<Segment>::type Unit;
 Unit x1 = x(low(segment));
 Unit y1 = y(low(segment));
 Unit x2 = x(high(segment));
 Unit y2 = y(high(segment));
- Unit X = x(position);
- Unit Y = y(position);
+ Unit X = x(point);
+ Unit Y = y(point);
 Unit A = X - x1;
 Unit B = Y - y1;
 Unit C = x2 - x1;
@@ -555,9 +557,9 @@
 Unit length_sq = C * C + D * D;
 Unit param = (A * C + B * D)/length_sq;
 if(param > 1.0) {
- return euclidean_distance(high(segment), position);
+ return euclidean_distance(high(segment), point);
 } else if(param < 0.0) {
- return euclidean_distance(low(segment), position);
+ return euclidean_distance(low(segment), point);
 }
 Unit denom = sqrt(length_sq);
 if(denom == 0.0)
@@ -584,8 +586,7 @@
>::type,
 typename segment_distance_type<Segment1>::type
>::type
- euclidean_distance(const Segment1& segment1,
- const Segment2& segment2) {
+ euclidean_distance(const Segment1& segment1, const Segment2& segment2) {
 typename segment_distance_type<Segment1>::type
 result1 = euclidean_distance(segment1, low(segment2)),
 result2 = euclidean_distance(segment1, high(segment2));

Modified: sandbox/gtl/boost/polygon/segment_data.hpp
==============================================================================
--- sandbox/gtl/boost/polygon/segment_data.hpp (original)
+++ sandbox/gtl/boost/polygon/segment_data.hpp 2012-04-25 19:21:04 EDT (Wed, 25 Apr 2012)
@@ -49,7 +49,7 @@
 template <typename Segment>
 inline segment_data& operator=(const Segment& that);

- inline const point_type& get(direction_1d dir) const {
+ inline point_type get(direction_1d dir) const {
 return points_[dir.to_int()];
 }

@@ -57,14 +57,14 @@
 points_[dir.to_int()] = point;
 }

- inline const point_type& low() const { return points_[0]; }
+ inline point_type low() const { return points_[0]; }

 inline point_type& low(const point_type& low) {
 points_[0] = low;
 return *this;
 }

- inline const point_type& high() const {return points_[1]; }
+ inline point_type high() const {return points_[1]; }

 inline point_type& high(const point_type& high) {
 points_[1] = high;

Modified: sandbox/gtl/doc/gtl_segment_concept.htm
==============================================================================
--- sandbox/gtl/doc/gtl_segment_concept.htm (original)
+++ sandbox/gtl/doc/gtl_segment_concept.htm 2012-04-25 19:21:04 EDT (Wed, 25 Apr 2012)
@@ -1,5 +1,6 @@
<!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>
@@ -14,7 +15,7 @@

 <tbody>
 <tr>
- <td style="background-color: rgb(238, 238, 238);" nowrap="1" valign="top">
+ <td style="background-color: rgb(238, 238, 238);" valign="top" nowrap="1">
 <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>
@@ -106,35 +107,33 @@
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> 
+ template <typename Segment> 
+ struct segment_traits { 
+   typedef typename Segment::coordinate_type coordinate_type; 
+   typedef typename Segment::point_type point_type; 
+ 
+   static inline point_type get(const Segment& segment, direction_1d dir) { 
+     return segment.get(dir); 
+   } 
+ }; 
+ template <typename Segment> 
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; 
+  template <typename Point> 
+  static inline void set(Segment& segment, direction_1d dir, const Point& value) { 
+    typename segment_traits<Segment>::point_type p1; 
    assign(p1, value); 
-    segment.set(dir, value); 
+    segment.set(dir, p1); 
  } 
 
  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; 
+  static inline Segment construct(const Point1& low_value, const Point2& high_value) { 
+    typename segment_traits<Segment>::point_type p1, p2; 
    assign(p1, low_value); 
    assign(p2, high_value); 
-    return T(p1, p2); 
+    return Segment(p1, p2); 
  } 
}; 
- 
+ 

 Example code custom_segment.cpp
demonstrates how to map a user defined segment class to the library segment_concept.
@@ -143,39 +142,40 @@
 <tbody>
 <tr>
 <td width="586">template
-<typename T> point_type<T> get(const T& segment, direction_1d dir)</td>
+<typename Segment> point_type get(const Segment& 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>
+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>
+<typename Segment, typename Point> 
+void set(Segment& 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 width="586">template <typename Segment, typename Point1, typename Point2> 
+Segment construct(const Point1& low, const Point2& high)</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: top;">template <typename Segment1, typename Segment2> Segment1 copy_construct(const Segment2>& 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>
+<typename Segment1, typename Segment2> 
+ Segment1& assign(Segment1& lvalue, const Segment2& 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>
+<typename Segment1, typename Segment1> 
+bool equivalence(const Segment1& segment1, 
+                 const Segment1& 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>
@@ -183,69 +183,64 @@
 <tr>
 <td style="vertical-align: top;">template <typename segment_type> 
 bool on_above_or_below(const segment_type& segment, 
-     point_type value) 
+                       
+const point_type& point) 
 </td>
- <td style="vertical-align: top;"> 
+ <td>Returns true if an object that is a model of segment and the given point are collinear, else false. 
 </td>
 </tr>
 <tr>
- <td style="vertical-align: top;">template <typename segment_type> 
- bool contains(const segment_type& segment, 
+ <td style="vertical-align: top;">template <typename Segment> 
+ bool contains(const Segment& segment, 
     point_type value, bool consider_touch) 
 </td>
- <td style="vertical-align: top;"> 
+ <td>Returns true if an first object that is a model of segment contains the given point, else false. 
 </td>
 </tr>
 <tr>
- <td style="vertical-align: top;">template <typename segment_type, typename segment_type_2> 
-
- bool contains(const segment_type& segment, 
+ <td style="vertical-align: top;">template <typename Segment1, typename Segment2> 

-     const segment_type_2& value, 
+ bool contains(const Segment1& segment1, 

-     bool consider_touch)</td>
- <td style="vertical-align: top;"> 
+     const Segment2& segment2, bool consider_touch)</td>
+ <td>Returns true if the first of the objects contains the second one, else false. Both objects represent a model of segment. 
 </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 style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename Segment> 
+point_type low(const Segment& segment) 
 </td>
- <td style="vertical-align: top;"> 
+ <td>Gets the low endpoint of an object that is a model of segment. 
 </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 style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename Segment> 
+point_type high(const Segment& segment)</td>
+ <td>Gets the high endpoint of an object that is a model of segment. 
 </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 style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename Segment> 
+point_type center(const Segment& segment)</td>
+ <td>Gets the centeral point of an object that is a model of segment. 
 </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 style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename Segment> void low(Segment& segment, const point_type& point)</td>
+ <td>Sets the low endpoint of an object that is a model of segment. 
 </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 style="vertical-align: top; font-family: Courier New,Courier,monospace;">template <typename Segment> 
+void high(Segment& segment, const point_type& point)</td>
+ <td>Sets the high endpoint of an object that is a model of segment. 
 </td>
 </tr>
 <tr>
- <td style="vertical-align: top;">template <typename segment_type> 
- distance_type length(const segment_type& segment) 
+ <td style="vertical-align: top;">template <typename Segment> 
+ distance_type length(const Segment& segment) 
 </td>
- <td style="vertical-align: top;"> 
+ <td>Returns the length of an object that is a model of segment. 
 </td>
 </tr>

@@ -254,72 +249,66 @@

 <tr>
 <td width="586">template
-<typename segment_type> segment_type& scale_up(segment_type& segment,     unsigned_area_type factor)</td>
+<typename Segment> Segment& scale_up(Segment& 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, 
+<typename Segment> 
+ Segment& scale_down(Segment& 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, 
+<typename Segment, typename scaling_type> 
+ Segment& scale(Segment& segment, 
    const scaling_type& factor) </td>
 <td>Calls
-the scale member function of scaling type on the low and high point of
+the scale member function of scaling type on the low and high endpoint 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>
+<typename Segment, typename Transform> Segment& transform(Segment& segment, 
+    const Transform& 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 
+<typename Segment> 
+ Segment& move(Segment& 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. 
+<Segment> 
+ Segment& convolve(Segment& segment, const point_type& b)</td>
+ <td>Convolves both endpoints of an object that models a 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>
+<Segment> 
+ Segment& deconvolve(Segment& segment, const point_type& b)</td>
+ <td>Deconvolves both endpoints of an object that models a 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>
+<typename Segment, typename Point> distance_type euclidean_distance( 
+    const Segment& segment, const Point& point)</td>
+ <td>Returns the distance from an object that is a model of segment
+to an object that is a model of 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>
+<typename Segment1, typename Segment2> distance_type euclidean_distance( 
+    const Segment1& segment1, const Segment2& segment2)</td>
+ <td style="vertical-align: middle;">Returns the distance between two objects that are models of segment.</td>
 </tr>
 <tr>
 <td style="vertical-align: top;"> 
@@ -480,7 +469,7 @@
 </td>
 </tr>
 <tr>
- <td style="background-color: rgb(238, 238, 238);" nowrap="1" valign="top">  </td>
+ <td style="background-color: rgb(238, 238, 238);" valign="top" nowrap="1">  </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">

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