Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r78384 - sandbox/gtl/doc
From: sydorchuk.andriy_at_[hidden]
Date: 2012-05-08 15:14:18

Next message: dnljms_at_[hidden]: "[Boost-commit] svn:boost r78385 - trunk/libs/iostreams/test"
Previous message: lorcaminiti_at_[hidden]: "[Boost-commit] svn:boost r78383 - trunk/status"

Author: asydorchuk
Date: 2012-05-08 15:14:18 EDT (Tue, 08 May 2012)
New Revision: 78384
URL: http://svn.boost.org/trac/boost/changeset/78384

Log:
Updating segment concept documentation according to the latest API changes.

Text files modified:
sandbox/gtl/doc/gtl_segment_concept.htm | 39 ++++++++++++++++++++++++++++-----------
1 files changed, 28 insertions(+), 11 deletions(-)

Modified: sandbox/gtl/doc/gtl_segment_concept.htm
==============================================================================
--- sandbox/gtl/doc/gtl_segment_concept.htm (original)
+++ sandbox/gtl/doc/gtl_segment_concept.htm 2012-05-08 15:14:18 EDT (Tue, 08 May 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>
@@ -22,7 +23,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>
@@ -105,7 +106,7 @@
boost::tuple<Point, Point> or boost::array<Point, 2> 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
+and rectangle 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.
@@ -178,16 +179,32 @@
 </tr>
 <tr>
 <td>template <typename Segment, typename Point> 
- int on_above_or_below(const Segment& segment, 
-                      
-const Point& point) 
- </td>
- <td>Returns 0 if an object that is a model of segment and an object that is a model of point are collinear. 
-Returns 1 if the point object lies to the left of the segment object. 
-Returns -1 if the point object lies to the right of the segment object. 
+ int orientation(const Segment& segment, 
+                 const Point& point) 
+ </td>
+ <td>Implements
+a robust orientation test for two objects that model segment and point.
+Returns 0, if the point is collinear to the segment. 
+Returns 1, if the point lies to the left of the segment. 
+Returns -1, if the point lies to the right of the segment. 
+
 </td>
 </tr>
 <tr>
+ <td>template <typename Segment1, typename Segment2> 
+
+ int orientation(const Segment1& segment1, 
+
+                 const Segment2& segment2)</td>
+ <td>Implements a robust orientation test for two objects
+that are models of segment. Note: the segments are treated as math.
+vectors. 
+Returns 0, if the segments are collinear. 
+Returns 1, if the second segment is CCW oriented to the first segment. 
+Returns -1, if the second segment is CW oriented to the first segment. 
+ </td>
+ </tr>
+<tr>
 <td>template <typename Segment, typename Point> 
 bool contains(const Segment& segment, 
     const Point& value, bool consider_touch) 
@@ -451,7 +468,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">

Next message: dnljms_at_[hidden]: "[Boost-commit] svn:boost r78385 - trunk/libs/iostreams/test"
Previous message: lorcaminiti_at_[hidden]: "[Boost-commit] svn:boost r78383 - trunk/status"

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