|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r76993 - in trunk/libs/geometry/doc: . concept generated html other/testcases reference/algorithms src/examples/algorithms
From: barend.gehrels_at_[hidden]
Date: 2012-02-12 10:04:48
Author: barendgehrels
Date: 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
New Revision: 76993
URL: http://svn.boost.org/trac/boost/changeset/76993
Log:
Boost.Geometry doc updates and fixes. Including a new section Conformance instead of notes/tips defining that in previous version
Binary files modified:
trunk/libs/geometry/doc/other/testcases/multi_overlay_cases.ppt
trunk/libs/geometry/doc/other/testcases/overlay_line_poly_cases.ppt
trunk/libs/geometry/doc/other/testcases/relate.ppt
Text files modified:
trunk/libs/geometry/doc/concept/linestring.qbk | 2
trunk/libs/geometry/doc/concept/polygon.qbk | 2
trunk/libs/geometry/doc/generated/append_status.qbk | 5 +-
trunk/libs/geometry/doc/geometry.qbk | 27 ++++++++++++++---
trunk/libs/geometry/doc/html/index.html | 61 ++++++++++++++++++++-------------------
trunk/libs/geometry/doc/introduction.qbk | 5 +-
trunk/libs/geometry/doc/reference/algorithms/append.qbk | 6 +++
trunk/libs/geometry/doc/reference/algorithms/area.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/buffer.qbk | 7 ++++
trunk/libs/geometry/doc/reference/algorithms/centroid.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/clear.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/comparable_distance.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/convert.qbk | 9 +++--
trunk/libs/geometry/doc/reference/algorithms/convex_hull.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/correct.qbk | 7 +++-
trunk/libs/geometry/doc/reference/algorithms/covered_by.qbk | 13 +++++---
trunk/libs/geometry/doc/reference/algorithms/difference.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/distance.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/equals.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/expand.qbk | 5 ++
trunk/libs/geometry/doc/reference/algorithms/intersection.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/intersects.qbk | 5 +++
trunk/libs/geometry/doc/reference/algorithms/length.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/num_geometries.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/num_interior_rings.qbk | 5 +++
trunk/libs/geometry/doc/reference/algorithms/num_points.qbk | 6 +++
trunk/libs/geometry/doc/reference/algorithms/perimeter.qbk | 8 +++++
trunk/libs/geometry/doc/reference/algorithms/reverse.qbk | 6 ++-
trunk/libs/geometry/doc/reference/algorithms/simplify.qbk | 17 +++++++++++
trunk/libs/geometry/doc/reference/algorithms/sym_difference.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/transform.qbk | 4 ++
trunk/libs/geometry/doc/reference/algorithms/union.qbk | 5 +++
trunk/libs/geometry/doc/reference/algorithms/unique.qbk | 6 ++-
trunk/libs/geometry/doc/reference/algorithms/within.qbk | 5 +++
trunk/libs/geometry/doc/src/examples/algorithms/append.cpp | 4 +-
35 files changed, 208 insertions(+), 60 deletions(-)
Modified: trunk/libs/geometry/doc/concept/linestring.qbk
==============================================================================
--- trunk/libs/geometry/doc/concept/linestring.qbk (original)
+++ trunk/libs/geometry/doc/concept/linestring.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -16,7 +16,7 @@
[concept Linestring..linestring]
A linestring is ['a Curve with linear interpolation between Points].
-([@http://portal.opengeospatial.org/files/?artifact_id=25355 opengeospatial]).
+(__ogc_sf__).
[heading Concept Definition]
Modified: trunk/libs/geometry/doc/concept/polygon.qbk
==============================================================================
--- trunk/libs/geometry/doc/concept/polygon.qbk (original)
+++ trunk/libs/geometry/doc/concept/polygon.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -16,7 +16,7 @@
[concept Polygon..polygon]
A polygon is ['A polygon is a planar surface defined by one exterior boundary and zero or more interior boundaries]
-([@http://portal.opengeospatial.org/files/?artifact_id=25355 opengeospatial]).
+(__ogc_sf__).
So the definition of a Boost.Geometry polygon differs a bit from e.g. Wiki, where a polygon does not have holes. A
polygon of Boost.Geometry is a polygon with or without holes.
Modified: trunk/libs/geometry/doc/generated/append_status.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/append_status.qbk (original)
+++ trunk/libs/geometry/doc/generated/append_status.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -1,3 +1,4 @@
+[/NOTE: adapted manually, multi-linestring/multi-polygon do compile but not run!]
[heading Supported geometries]
[table
[[ ][Point][Range]]
@@ -8,6 +9,6 @@
[[Ring][ [$img/ok.png] ][ [$img/ok.png] ]]
[[Polygon][ [$img/ok.png] ][ [$img/ok.png] ]]
[[MultiPoint][ [$img/ok.png] ][ [$img/ok.png] ]]
-[[MultiLinestring][ [$img/ok.png] ][ [$img/ok.png] ]]
-[[MultiPolygon][ [$img/ok.png] ][ [$img/ok.png] ]]
+[[MultiLinestring][ [$img/nyi.png] ][ [$img/nyi.png] ]]
+[[MultiPolygon][ [$img/nyi.png] ][ [$img/nyi.png] ]]
]
Modified: trunk/libs/geometry/doc/geometry.qbk
==============================================================================
--- trunk/libs/geometry/doc/geometry.qbk (original)
+++ trunk/libs/geometry/doc/geometry.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -12,7 +12,6 @@
[library Geometry
[quickbook 1.5]
- [version 1.49]
[authors [Gehrels, Barend], [Lalande, Bruno], [Loskot, Mateusz]]
[copyright 2009-2012 Barend Gehrels, Bruno Lalande, Mateusz Loskot]
[purpose Documentation of Boost.Geometry library]
@@ -61,10 +60,6 @@
[template qbk_ret[what] Returns [what]]
[template qbk_out[what] GeometryOut is a [what]]
-[template concept[name type] The [name] Concept describes the requirements for a [type] type.
-All algorithms in Boost.Geometry will check any geometry arguments against the concept requirements.]
-
-
[def __boost__ Boost]
[def __boost_geometry__ Boost.Geometry]
[def __boost_array__ Boost.Array]
@@ -78,6 +73,28 @@
[def __ttmath__ [@http://www.ttmath.org/ ttmath]]
[def __ogc__ [@http://www.opengeospatial.org OGC]]
+[def __ogc_sf__ [@http://www.opengeospatial.org/standards/sfa OGC Simple Feature Specification]]
+
+[/Templates]
+[template concept[name type]
+The [name] Concept describes the requirements for a [type] type.
+All algorithms in Boost.Geometry will check any geometry arguments against the concept requirements.
+]
+
+[template heading_conformance_no_ogc[function]
+[heading Conformance]
+The function [function] is not defined by OGC.
+]
+
+[template heading_conformance_ogc[function ogc_function]
+[heading Conformance]
+The function [function] implements function [ogc_function] from the __ogc_sf__.
+]
+
+[template conformance_std[function std_function]
+The function [function] conforms to the [std_function] of the C++ std-library.
+]
+
[heading Contributions]
Boost.Geometry contains contributions by:
Modified: trunk/libs/geometry/doc/html/index.html
==============================================================================
--- trunk/libs/geometry/doc/html/index.html (original)
+++ trunk/libs/geometry/doc/html/index.html 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -1,10 +1,10 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>Chapter 1. Geometry 1.0</title>
+<title>Chapter 1. Geometry</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
-<link rel="home" href="index.html" title="Chapter 1. Geometry 1.0">
+<link rel="home" href="index.html" title="Chapter 1. Geometry">
<link rel="next" href="geometry/introduction.html" title="Introduction">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -21,7 +21,7 @@
<div class="chapter">
<div class="titlepage"><div>
<div><h2 class="title">
-<a name="geometry"></a>Chapter 1. Geometry 1.0</h2></div>
+<a name="geometry"></a>Chapter 1. Geometry</h2></div>
<div><div class="author"><h3 class="author">
<span class="firstname">Barend</span> <span class="surname">Gehrels</span>
</h3></div></div>
@@ -31,9 +31,9 @@
<div><div class="author"><h3 class="author">
<span class="firstname">Mateusz</span> <span class="surname">Loskot</span>
</h3></div></div>
-<div><p class="copyright">Copyright © 2012 Barend Gehrels, Bruno Lalande, Mateusz Loskot</p></div>
+<div><p class="copyright">Copyright © 2009 -2012 Barend Gehrels, Bruno Lalande, Mateusz Loskot</p></div>
<div><div class="legalnotice">
-<a name="id666441"></a><p>
+<a name="id857080"></a><p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</p>
@@ -43,37 +43,38 @@
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="section">Introduction</span></dt>
-<dt><span class="section">Quick Start</span></dt>
-<dt><span class="section">Design Rationale</span></dt>
+<dt><span class="section"> Quick Start</span></dt>
+<dt><span class="section"> Design Rationale</span></dt>
<dt><span class="section">Compilation</span></dt>
<dt><span class="section">Indexes</span></dt>
<dd><dl>
-<dt><span class="section">Reference matrix</span></dt>
+<dt><span class="section"> Reference matrix</span></dt>
<dt><span class="section">Alphabetical Index</span></dt>
</dl></dd>
-<dt><span class="section">Reference</span></dt>
+<dt><span class="section"> Reference</span></dt>
<dd><dl>
-<dt><span class="section">Access Functions</span></dt>
-<dt><span class="section">Adapted models</span></dt>
-<dt><span class="section">Algorithms</span></dt>
-<dt><span class="section">Arithmetic</span></dt>
-<dt><span class="section">Concepts</span></dt>
-<dt><span class="section">Constants</span></dt>
-<dt><span class="section">Coordinate Systems</span></dt>
-<dt><span class="section">Core Metafunctions</span></dt>
-<dt><span class="section">Enumerations</span></dt>
-<dt><span class="section">Exceptions</span></dt>
-<dt><span class="section">Iterators</span></dt>
-<dt><span class="section">Models</span></dt>
-<dt><span class="section">Strategies</span></dt>
-<dt><span class="section">Views</span></dt>
+<dt><span class="section"> Access Functions</span></dt>
+<dt><span class="section"> Adapted models</span></dt>
+<dt><span class="section"> Algorithms</span></dt>
+<dt><span class="section"> Arithmetic</span></dt>
+<dt><span class="section"> Concepts</span></dt>
+<dt><span class="section"> Constants</span></dt>
+<dt><span class="section"> Coordinate Systems</span></dt>
+<dt><span class="section"> Core Metafunctions</span></dt>
+<dt><span class="section"> Enumerations</span></dt>
+<dt><span class="section"> Exceptions</span></dt>
+<dt><span class="section"> Iterators</span></dt>
+<dt><span class="section"> Models</span></dt>
+<dt><span class="section"> Strategies</span></dt>
+<dt><span class="section"> Views</span></dt>
</dl></dd>
-<dt><span class="section">About this documentation</span></dt>
+<dt><span class="section"> Release Notes</span></dt>
+<dt><span class="section"> About this documentation</span></dt>
<dt><span class="section">Acknowledgments</span></dt>
</dl>
</div>
<a name="geometry.contributions"></a><h3>
-<a name="geometry.contributions-heading"></a>
+<a name="id857099"></a>
<a class="link" href="index.html#geometry.contributions">Contributions</a>
</h3>
<p>
@@ -87,24 +88,24 @@
Alfredo Correa (adaption of Boost.Array)
</li>
<li class="listitem">
- Adam Wulkiewicz (spatial indexes) <sup>[<a name="id697753" href="#ftn.id697753" class="footnote">1</a>]</sup>
+ Adam Wulkiewicz (spatial indexes) <sup>[<a name="id857137" href="#ftn.id857137" class="footnote">1</a>]</sup>
</li>
<li class="listitem">
- Federico Fernández (spatial indexes) <sup>[<a name="id697767" href="#ftn.id697767" class="footnote">2</a>]</sup>
+ Federico Fernández (spatial indexes) <sup>[<a name="id857151" href="#ftn.id857151" class="footnote">2</a>]</sup>
</li>
</ul></div>
<div class="footnotes">
<br><hr width="100" align="left">
-<div class="footnote"><p><sup>[<a name="ftn.id697753" href="#id697753" class="para">1</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id857137" href="#id857137" class="para">1</a>] </sup>
Currently an extension
</p></div>
-<div class="footnote"><p><sup>[<a name="ftn.id697767" href="#id697767" class="para">2</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id857151" href="#id857151" class="para">2</a>] </sup>
Currently an extension
</p></div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: January 13, 2012 at 11:52:50 GMT</small></p></td>
+<td align="left"><p><small>Last revised: February 12, 2012 at 15:01:29 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: trunk/libs/geometry/doc/introduction.qbk
==============================================================================
--- trunk/libs/geometry/doc/introduction.qbk (original)
+++ trunk/libs/geometry/doc/introduction.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -38,10 +38,9 @@
* conventions from boost
* conventions from the std library
* conventions and names from one of the __ogc__ standards on geometry and, more
- specificly, from the
- [@http://portal.opengeospatial.org/files/?artifact_id=25355 Simple Feature Specification]
+ specificly, from the __ogc_sf__
-The library was released with Boost 1.47.0 and from that point on it is
+The library was first released with Boost 1.47.0 and from that point on it is
officially part of the Boost C++ Libraries.
Latest stable version of the source code is included in the
Modified: trunk/libs/geometry/doc/other/testcases/multi_overlay_cases.ppt
==============================================================================
Binary files. No diff available.
Modified: trunk/libs/geometry/doc/other/testcases/overlay_line_poly_cases.ppt
==============================================================================
Binary files. No diff available.
Modified: trunk/libs/geometry/doc/other/testcases/relate.ppt
==============================================================================
Binary files. No diff available.
Modified: trunk/libs/geometry/doc/reference/algorithms/append.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/append.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/append.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,12 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ append]
+
+[heading_conformance_no_ogc __this_function__]
+
+[include generated/append_status.qbk]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/area.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/area.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/area.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ area]
+
+[heading_conformance_ogc __this_function__..Area]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/buffer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/buffer.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/buffer.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,13 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ buffer]
+
+[heading_conformance_ogc __this_function__..Buffer]
+[note The current implemetation only enlarges a box, which is not defined by OGC.
+ A next version of the library will contain a more complete implementation
+]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/centroid.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/centroid.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/centroid.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ centroid]
+
+[heading_conformance_ogc __this_function__..Centroid]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/clear.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/clear.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/clear.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -11,6 +11,10 @@
=============================================================================/]
[def __is_cleared__ is cleared]
+[def __this_function__ clear]
+
+[heading_conformance_no_ogc __this_function__]
+[conformance_std __this_function__..__this_function__() method]
[include generated/clear_status.qbk]
Modified: trunk/libs/geometry/doc/reference/algorithms/comparable_distance.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/comparable_distance.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/comparable_distance.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ comparable_distance]
+
+[heading_conformance_no_ogc __this_function__]
+
[heading Behaviour]
There is no (not yet) version with a strategy.
Modified: trunk/libs/geometry/doc/reference/algorithms/convert.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/convert.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/convert.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,9 +10,9 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
-[note convert is not defined within OGC or ISO]
-[note convert is modelled as source -> target
- (where assign is modelled as target := source)]
+[def __this_function__ convert]
+
+[heading_conformance_no_ogc __this_function__]
[include generated/convert_status.qbk]
[note In this status matrix above: columns are source types
@@ -29,4 +29,5 @@
[heading See also]
* [link geometry.reference.algorithms.assign.assign assign]
-
+[note convert is modelled as source -> target
+ (where assign is modelled as target := source)]
Modified: trunk/libs/geometry/doc/reference/algorithms/convex_hull.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/convex_hull.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/convex_hull.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ convex_hull]
+
+[heading_conformance_ogc __this_function__..ConvexHull()]
+
[include generated/convex_hull_status.qbk]
[heading Complexity]
Modified: trunk/libs/geometry/doc/reference/algorithms/correct.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/correct.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/correct.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -11,6 +11,11 @@
=============================================================================/]
[def __corrected__ is corrected]
+[def __this_function__ correct]
+
+[heading_conformance_no_ogc __this_function__]
+
+[include generated/correct_status.qbk]
[heading Behavior]
[table
@@ -22,8 +27,6 @@
[[__other__][__does_nothing__]]
]
-[tip Correct is not defined within OGC or ISO]
-
[heading Complexity]
Linear
Modified: trunk/libs/geometry/doc/reference/algorithms/covered_by.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/covered_by.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/covered_by.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,17 +10,20 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ covered_by]
+
+[heading_conformance_no_ogc __this_function__]
+[note Both PostGIS and Oracle contain an algorithm with the same name and the
+ same functionality.
+ See the [@http://www.postgis.org/docs/ST_CoveredBy.html PostGIS documentation].
+]
+
[include generated/covered_by_status.qbk]
[note In this status matrix above: columns are types of first parameter
and rows are types of second parameter. So a point can be checked to be
covered by a polygon, but not vice versa.
]
-[note convert is not defined within OGC or ISO. However, both PostGIS
- and Oracle contain an algorithm with the same name and the same functionality.
- See the [@http://www.postgis.org/docs/ST_CoveredBy.html PostGIS documentation].
-]
-
[heading Complexity]
Linear
Modified: trunk/libs/geometry/doc/reference/algorithms/difference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/difference.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/difference.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -8,6 +8,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ difference]
+
+[heading_conformance_ogc __this_function__..Difference]
+
[include reference/algorithms/difference_behavior.qbk]
[include reference/algorithms/geometry_rules.qbk]
Modified: trunk/libs/geometry/doc/reference/algorithms/distance.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/distance.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/distance.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ distance]
+
+[heading_conformance_ogc __this_function__..Distance]
+
[include generated/distance_status.qbk]
[heading Complexity]
Modified: trunk/libs/geometry/doc/reference/algorithms/equals.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/equals.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/equals.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ equals]
+
+[heading_conformance_ogc __this_function__..Equals]
+
[include generated/equals_status.qbk]
[heading Complexity]
Modified: trunk/libs/geometry/doc/reference/algorithms/expand.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/expand.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/expand.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,8 +10,12 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ expand]
[def __apply_expand__ Box is expanded to include the specified]
+[heading_conformance_no_ogc __this_function__]
+
+
[heading Behavior]
[table
[[Case] [Behavior] ]
@@ -20,7 +24,6 @@
[[__box__ / __other__][__nyiversion__]]
]
-[tip Expand is not defined within OGC or ISO]
[note To use expand with another geometry type then specified, use expand(make_envelope<box_type>(geometry)]
[heading Complexity]
Modified: trunk/libs/geometry/doc/reference/algorithms/intersection.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/intersection.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/intersection.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ intersection]
+
+[heading_conformance_ogc __this_function__..Intersection]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/intersects.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/intersects.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/intersects.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,11 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ intersects]
+
+[heading_conformance_ogc __this_function__..Intersects]
+[note The one argument version is added for __boost_geometry__]
+
[heading Examples]
[intersects_linestring]
[intersects_linestring_output]
Modified: trunk/libs/geometry/doc/reference/algorithms/length.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/length.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/length.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ length]
+
+[heading_conformance_ogc __this_function__..Length]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/num_geometries.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/num_geometries.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/num_geometries.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ num_geometries]
+
+[heading_conformance_ogc __this_function__..NumGeometries]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/num_interior_rings.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/num_interior_rings.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/num_interior_rings.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,11 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ num_interior_ring]
+
+[heading_conformance_ogc __this_function__..NumInteriorRing]
+[note __boost_geometry__ adds an "s"]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/num_points.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/num_points.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/num_points.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,12 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ num_points]
+
+[heading_conformance_ogc __this_function__..NumPoints]
+[note __this_function__ can be called for any geometry and not just linestrings
+(as the standard describes)]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/perimeter.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/perimeter.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/perimeter.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,14 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ perimeter]
+
+[heading_conformance_no_ogc __this_function__]
+[note PostGIS contains an algorithm with the same name and the
+ same functionality.
+ See the [@http://www.postgis.org/docs/ST_Perimeter.html PostGIS documentation].
+]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/reverse.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/reverse.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/reverse.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ reverse]
+
+[heading_conformance_no_ogc __this_function__]
+[conformance_std __this_function__..std::__this_function__ function]
[heading Behavior]
[table
@@ -27,8 +31,6 @@
[note The reverse of a (multi)polygon or ring might make a valid geometry invalid because the (counter)clockwise orientation reverses.]
-[tip Conforms to std::reverse functionality. It is not defined within OGC or ISO]
-
[heading Complexity]
Linear
Modified: trunk/libs/geometry/doc/reference/algorithms/simplify.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/simplify.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/simplify.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,23 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ simplify]
+
+[heading_conformance_no_ogc __this_function__]
+[note PostGIS contains an algorithm with the same name and the
+ same functionality.
+ See the [@http://www.postgis.org/docs/ST_Simplify.html PostGIS documentation].
+]
+[note SQL Server contains an algorithm Reduce() with the same functionality.
+ See the [@http://msdn.microsoft.com/en-us/library/bb933814.aspx MSDN documentation].
+]
+
+[heading Behavior]
+Simplification is done using [@http://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm Douglas-Peucker] (if the default strategy is used).
+[note Geometries might become invalid by using simplify. The simplification
+process might create self-intersections.
+]
+
[heading Examples]
[simplify]
[simplify_output]
Modified: trunk/libs/geometry/doc/reference/algorithms/sym_difference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/sym_difference.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/sym_difference.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ sym_difference]
+
+[heading_conformance_ogc __this_function__..SymDifference]
+
[include reference/algorithms/difference_behavior.qbk]
[include reference/algorithms/geometry_rules.qbk]
Modified: trunk/libs/geometry/doc/reference/algorithms/transform.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/transform.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/transform.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,10 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ transform]
+
+[heading_conformance_no_ogc __this_function__]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/union.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/union.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/union.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,11 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ union]
+
+[heading_conformance_ogc __this_function__..Union]
+[note __boost_geometry__ adds an underscore to avoid using the `union` keyword]
+
[heading Behavior]
[table
[[Case] [Behavior] ]
Modified: trunk/libs/geometry/doc/reference/algorithms/unique.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/unique.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/unique.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -11,6 +11,10 @@
=============================================================================/]
[def __applies_unique__ Removes all consecutive duplicate points]
+[def __this_function__ unique]
+
+[heading_conformance_no_ogc __this_function__]
+[conformance_std __this_function__..std::__this_function__ function]
[heading Behavior]
[table
@@ -26,8 +30,6 @@
[[__multi_polygon__][__applies_unique__ in all contained polygons (all rings)]]
]
-[tip Conforms to std::unique functionality. It is not defined within OGC or ISO]
-
[heading Complexity]
Linear
Modified: trunk/libs/geometry/doc/reference/algorithms/within.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/algorithms/within.qbk (original)
+++ trunk/libs/geometry/doc/reference/algorithms/within.qbk 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -10,6 +10,11 @@
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
+[def __this_function__ within]
+
+[heading_conformance_ogc __this_function__..Within]
+[note OGC defines within as completely within and not on the border. See the notes for within / on the border]
+
[include generated/within_status.qbk]
[note In this status matrix above: columns are types of first parameter
and rows are types of second parameter. So a point can be checked to be
Modified: trunk/libs/geometry/doc/src/examples/algorithms/append.cpp
==============================================================================
--- trunk/libs/geometry/doc/src/examples/algorithms/append.cpp (original)
+++ trunk/libs/geometry/doc/src/examples/algorithms/append.cpp 2012-02-12 10:04:44 EST (Sun, 12 Feb 2012)
@@ -32,14 +32,14 @@
// Append a range
append(poly, tuple_list_of(0, 0)(0, 10)(11, 11)(10, 0)); /*< tuple_list_of delivers a range and can therefore be used in boost::geometry::append >*/
- // Append a point (in this case the closing point
+ // Append a point (in this case the closing point)
append(poly, make_tuple(0, 0));
// Create an interior ring (append does not do this automatically)
boost::geometry::interior_rings(poly).resize(1);
// Append a range to the interior ring
- append(poly, tuple_list_of(2, 2)(2, 5)(6, 6)(5, 2), 0);
+ append(poly, tuple_list_of(2, 2)(2, 5)(6, 6)(5, 2), 0); /*< The last parameter ring_index 0 denotes the first interior ring >*/
// Append a point to the first interior ring
append(poly, make_tuple(2, 2), 0);
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