|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r78373 - sandbox/gtl/doc
From: sydorchuk.andriy_at_[hidden]
Date: 2012-05-07 16:05:16
Author: asydorchuk
Date: 2012-05-07 16:05:16 EDT (Mon, 07 May 2012)
New Revision: 78373
URL: http://svn.boost.org/trac/boost/changeset/78373
Log:
Updating segment concept documentation.
Text files modified:
sandbox/gtl/doc/gtl_segment_concept.htm | 35 ++++++++---------------------------
1 files changed, 8 insertions(+), 27 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-07 16:05:16 EDT (Mon, 07 May 2012)
@@ -1,6 +1,5 @@
<!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>
-<!--
+<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><!--
Copyright 2009-2010 Intel Corporation
license banner
--><title>Boost Polygon Library: Segment Concept</title>
@@ -12,6 +11,8 @@
+
+
@@ -133,13 +134,7 @@
static inline Segment construct(const point_type& low, const point_type& high) {<br />
return Segment(low, high);<br />
}<br />
-};<br />
- </span><span style="font-family: Courier New,Courier,monospace;" /></span></p>
-
-
- <p> Example code custom_segment.cpp
-demonstrates how to map a user defined segment class to the library segment_concept.</p>
- <h2>Functions</h2>
+};</span></span></p><h2>Functions</h2>
<table style="width: 100%;" id="table1" border="1">
<tbody>
<tr>
@@ -328,19 +323,7 @@
</td>
</tr>
- <tr>
- <td style="font-family: Courier New,Courier,monospace;">template <typename Point, typename Segment1, typename Segment2><br />
-
-bool <span style="font-weight: bold;">intersection</span>(Point& point,<br />
-
- const Segment1& segment1, const Segment2& segment2,<br />
-
- bool projected = false, bool round_closest = false)</td>
- <td>Returns
-true and computes the intersection point of the two objects that model
-a segment in case those intersect, else returns false.
- </td>
- </tr>
+
<tr>
<td style="font-family: Courier New,Courier,monospace;"><font face="Courier New">template
<typename </font><span style="font-family: Courier New,Courier,monospace;">Segment, typename Point</span><font face="Courier New">><br />distance_type <b>euclidean_distance</b>(<br />
@@ -371,10 +354,7 @@
<p>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.</p>
- <p>Example code segment_usage.cpp
-demonstrates using the library provided segment data type and functions.</p>
- <h2>Members</h2>
+type is implemented to be convenient to use with the library traits.</p><h2>Members</h2>
<table style="width: 100%;" id="table2" border="1">
<tbody>
<tr>
@@ -395,7 +375,8 @@
<td>Default constructor.</td>
</tr>
<tr>
- <td width="586"><font face="Courier New"><b>segment_data</b>(point_type low, point_type high)</font></td>
+ <td width="586"><font face="Courier New"><b>segment_data</b>(const point_type& low,<br />
+ const point_type& high)</font></td>
<td>Constructs a segment from the given endpoints.</td>
</tr>
<tr>
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