Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r77241 - sandbox/gtl/doc
From: sydorchuk.andriy_at_[hidden]
Date: 2012-03-05 16:22:49

Author: asydorchuk
Date: 2012-03-05 16:22:48 EST (Mon, 05 Mar 2012)
New Revision: 77241
URL: http://svn.boost.org/trac/boost/changeset/77241

Log:
Documentation update. Finished voronoi utils main page.

Text files modified:
   sandbox/gtl/doc/voronoi_builder.htm | 8 +-
   sandbox/gtl/doc/voronoi_utils.htm | 83 +++++++++++++++++++++++++++++----------
   2 files changed, 65 insertions(+), 26 deletions(-)

Modified: sandbox/gtl/doc/voronoi_builder.htm
==============================================================================
--- sandbox/gtl/doc/voronoi_builder.htm (original)
+++ sandbox/gtl/doc/voronoi_builder.htm 2012-03-05 16:22:48 EST (Mon, 05 Mar 2012)
@@ -3,12 +3,13 @@

+
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252"><title>Contents</title></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);" valign="top" nowrap="1">
+ <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" tabindex="2" style="border: medium none ;" href="http://www.boost.org/">
 </a></div>
@@ -94,8 +95,7 @@
 The main differences are in the following: 1) The input coordinate type
 is not required to be integral (while it still should be integer type);
 2) The output coordinate type (for voronoi vertices) is required to be
- IEEE-754 floating point type. Let's have a closer look at the voronoi_builder
- definition: 
+ IEEE-754 floating point type. Let's have a closer look at the voronoi_builder declaration: 
 
 
 template <typename
@@ -378,7 +378,7 @@
 Tutorial</a>.</td>
 </tr>
 <tr>
- <td style="background-color: rgb(238, 238, 238);" valign="top" nowrap="1"> </td>
+ <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="table2" frame="void" rules="none">
 <colgroup>

Modified: sandbox/gtl/doc/voronoi_utils.htm
==============================================================================
--- sandbox/gtl/doc/voronoi_utils.htm (original)
+++ sandbox/gtl/doc/voronoi_utils.htm 2012-03-05 16:22:48 EST (Mon, 05 Mar 2012)
@@ -11,8 +11,11 @@

+
+
+
<meta http-equiv="Content-Language" content="en-us">
-<meta http-equiv="Content-Type" content="text/html; charset=windows-1252"><title>Contents</title></head><body>
+<meta http-equiv="Content-Type" content="text/html; charset=windows-1252"><title>Contents</title><meta http-equiv="content-type" content="text/html; charset=utf-8"><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body>

<table style="margin: 0pt; padding: 0pt; width: 100%;" border="0" cellpadding="0" cellspacing="0">
 <tbody><tr>
@@ -91,52 +94,88 @@
 
 
 <h1>Voronoi Utils</h1>Voronoi
-utilities are set of tools that users may find useful especially for
-the visualization of the Voronoi diagrams or parabolic edges
-interpoliation. 
-All the methods within the utilities class are static. Class definition follows: 
+utilities imlements a set of tools that users may find useful
+especially for
+the visualization of Voronoi diagrams or interpolation of the parabolic
+edges. All the methods within the utilities class are static. Class
+declaration is following: 
 
template <typename T, typename TRAITS = voronoi_utils_traits<T> > 
class voronoi_utils; 
 
- T - coordinate type utilities methods operate with. 
- TRAITS - contain utilities coordinate and geometry traits. 
+ T - output coordinate type used by the utilities. 
+ TRAITS - output geometries type traits (see definition below). 
+<h2 style="color: rgb(0, 0, 0); font-family: 'Times New Roman'; font-style: normal; font-variant: normal; letter-spacing: normal; line-height: normal; orphans: 2; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px;">EdgeType</h2>EdgeType
+enumerator is used to categorise straight linear primitive based on the
+finity of its endpoints. There are three possible values: segment, ray,
+line. 
 
+ enum EdgeType { SEGMENT = 0, RAY = 1, LINE = 2 }; 
+<h2 style="color: rgb(0, 0, 0); font-family: 'Times New Roman'; font-style: normal; font-variant: normal; letter-spacing: normal; line-height: normal; orphans: 2; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px;">Member Functions</h2>
+
 <table style="text-align: left; width: 100%;" border="1" cellpadding="2" cellspacing="2">
 <tbody>
 <tr>
 <td style="vertical-align: top;">template <typename CT> 
- static brect_type get_view_rectangle(const bounding_rectangle<CT> &brect, fpt_type scale = 1.0) 
+ static brect_type scale(const bounding_rectangle<CT> &brect, fpt_type factor = 1.0) 
 </td>
- <td style="vertical-align: top;">Returns scaled homothetic bounding rectangle. The center of homotethy corresponds to the center of the input rectangle. 
+ <td style="vertical-align: top;">Returns scaled bounding rectangle. The center of transformation corresponds to the center of the input rectangle. 
 </td>
 </tr>
 <tr>
 <td style="vertical-align: top;">template <typename CT> 
- static point_set_type get_point_interpolation(const voronoi_edge<CT> *edge, const bounding_rectangle<CT> &brect, fpt_type max_error) 
+ static void discretize(const voronoi_edge<CT> *edge, const bounding_rectangle<CT> &brect, fpt_type max_error, point_set_type &interpolation) 
 </td>
- <td style="vertical-align: top;">Interpolates Voronoi edge.
-For linear edges fills output set with edge endpoints. For parabolic
-edges fills output set with points that interpolate Voronoi edge. 
-Additional clipping is done for infinite edges using input bounding
-rectangle. 
+ <td style="vertical-align: top;">Provides point discretization of the input voronoi edge. 
+Finite edges are not clipped at all. Infinite edges (at least one of
+the endpoints is not finite) are clipped by the bounding rectangle. 
+For linear edges fills output set with edge endpoints. 
+For parabolic edges fills output set with edge discretization
+satisfying max distance requirement equal to max_error *
+brect.min_len(). 
+
 </td>
 </tr>
 <tr>
 <td style="vertical-align: top;">static
-void find_intersections(const point_type &origin, const point_type
-&direction, kEdgeType edge_type, const brect_type &brect,
+void intersect(const point_type &origin, const point_type
+&direction, EdgeType edge_type, const brect_type &brect,
point_set_type &intersections) 
 </td>
- <td style="vertical-align: top;"> 
+ <td style="vertical-align: top;">Fills
+the output structure with the intersection points of input linear
+primitive and bounding rectangle. Based on the EdgeType origin and
+direction mean following: 
+SEGMENT: origin - start-point, direction - vector going from start-point to endpoint; 
+RAY: origin - start-point, direction - ray vector; 
+LINE: origin - point on a line, direction - line vector. 
 </td>
 </tr>
 </tbody>
- </table>
- 
+ </table><h1>Voronoi Utils Traits 
+</h1>Below is shown the default voronoi utilities traits: 
+ 
+ template <typename fpt_> 
+ struct voronoi_utils_traits; 
+ 
+ template<> 
+ struct voronoi_utils_traits<double> { 
+     typedef double fpt_type; 
+     typedef detail::point_2d<fpt_type> point_type; 
+     typedef std::vector<point_type> point_set_type; 
+     typedef bounding_rectangle<fpt_type> brect_type; 
+     typedef struct { 
+         template <typename CT> 
+         fpt_type operator()(const CT& value) const { 
+             return static_cast<fpt_type>(value); 
+         } 
+     } ctype_converter_type; 
+ }; 
+ 
+ Most of the types define output geometries.
+ctype_converter_type is used to cast coordinate type of the input
+primitives to the one used by the utilities. 

- <h1>Voronoi Utils Traits 
-</h1>

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