|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r76997 - in trunk: boost/geometry/algorithms boost/geometry/geometries libs/geometry/doc libs/geometry/doc/concept libs/geometry/doc/html libs/geometry/doc/reference/algorithms libs/geometry/doc/reference/geometries
From: barend.gehrels_at_[hidden]
Date: 2012-02-12 12:07:40
Author: barendgehrels
Date: 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
New Revision: 76997
URL: http://svn.boost.org/trac/boost/changeset/76997
Log:
Boost.Geometry doc updates and fixes
Added:
trunk/libs/geometry/doc/reference/algorithms/disjoint.qbk (contents, props changed)
trunk/libs/geometry/doc/reference/algorithms/envelope.qbk (contents, props changed)
trunk/libs/geometry/doc/reference/algorithms/for_each_point.qbk (contents, props changed)
trunk/libs/geometry/doc/reference/algorithms/for_each_segment.qbk (contents, props changed)
trunk/libs/geometry/doc/reference/algorithms/overlaps.qbk (contents, props changed)
trunk/libs/geometry/doc/reference/geometries/point_assign_warning.qbk (contents, props changed)
Text files modified:
trunk/boost/geometry/algorithms/disjoint.hpp | 4 +++-
trunk/boost/geometry/algorithms/envelope.hpp | 10 ++--------
trunk/boost/geometry/algorithms/for_each.hpp | 5 +++++
trunk/boost/geometry/algorithms/intersects.hpp | 1 +
trunk/boost/geometry/algorithms/overlaps.hpp | 4 +++-
trunk/boost/geometry/geometries/point_xy.hpp | 3 +++
trunk/libs/geometry/doc/compiling.qbk | 6 ++++--
trunk/libs/geometry/doc/concept/linestring.qbk | 10 ++++++++++
trunk/libs/geometry/doc/concept/ring.qbk | 1 +
trunk/libs/geometry/doc/geometry.qbk | 7 +++++++
trunk/libs/geometry/doc/html/index.html | 14 +++++++-------
trunk/libs/geometry/doc/reference/algorithms/intersects.qbk | 2 +-
trunk/libs/geometry/doc/reference/geometries/point.qbk | 3 +++
13 files changed, 50 insertions(+), 20 deletions(-)
Modified: trunk/boost/geometry/algorithms/disjoint.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/disjoint.hpp (original)
+++ trunk/boost/geometry/algorithms/disjoint.hpp 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -228,7 +228,9 @@
\param geometry1 \param_geometry
\param geometry2 \param_geometry
\return \return_check2{are disjoint}
- */
+
+\qbk{[include reference/algorithms/disjoint.qbk]}
+*/
template <typename Geometry1, typename Geometry2>
inline bool disjoint(Geometry1 const& geometry1,
Geometry2 const& geometry2)
Modified: trunk/boost/geometry/algorithms/envelope.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/envelope.hpp (original)
+++ trunk/boost/geometry/algorithms/envelope.hpp 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -216,14 +216,7 @@
\param geometry \param_geometry
\param mbr \param_box \param_set{envelope}
-\par Example:
-Example showing envelope calculation, using point_ll latlong points
-\dontinclude doxygen_1.cpp
-\skip example_envelope_polygon
-\line {
-\until }
-
-
+\qbk{[include reference/algorithms/envelope.qbk]}
\qbk{
[heading Example]
[envelope] [envelope_output]
@@ -253,6 +246,7 @@
\param geometry \param_geometry
\return \return_calc{envelope}
+\qbk{[include reference/algorithms/envelope.qbk]}
\qbk{
[heading Example]
[return_envelope] [return_envelope_output]
Modified: trunk/boost/geometry/algorithms/for_each.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/for_each.hpp (original)
+++ trunk/boost/geometry/algorithms/for_each.hpp 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -250,6 +250,7 @@
\tparam Functor \tparam_functor
\qbk{distinguish,const version}
+\qbk{[include reference/algorithms/for_each_point.qbk]}
\qbk{[heading Example]}
\qbk{[for_each_point_const] [for_each_point_const_output]}
*/
@@ -277,6 +278,7 @@
\tparam Geometry \tparam_geometry
\tparam Functor \tparam_functor
+\qbk{[include reference/algorithms/for_each_point.qbk]}
\qbk{[heading Example]}
\qbk{[for_each_point] [for_each_point_output]}
*/
@@ -305,6 +307,7 @@
\tparam Functor \tparam_functor
\qbk{distinguish,const version}
+\qbk{[include reference/algorithms/for_each_segment.qbk]}
\qbk{[heading Example]}
\qbk{[for_each_segment_const] [for_each_segment_const_output]}
*/
@@ -331,6 +334,8 @@
\param f \par_for_each_f{segment}
\tparam Geometry \tparam_geometry
\tparam Functor \tparam_functor
+
+\qbk{[include reference/algorithms/for_each_segment.qbk]}
*/
template<typename Geometry, typename Functor>
inline Functor for_each_segment(Geometry& geometry, Functor f)
Modified: trunk/boost/geometry/algorithms/intersects.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/intersects.hpp (original)
+++ trunk/boost/geometry/algorithms/intersects.hpp 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -35,6 +35,7 @@
\return \return_check{is self-intersecting}
\qbk{distinguish,one geometry}
+\qbk{[def __one_parameter__]}
\qbk{[include reference/algorithms/intersects.qbk]}
*/
template <typename Geometry>
Modified: trunk/boost/geometry/algorithms/overlaps.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/overlaps.hpp (original)
+++ trunk/boost/geometry/algorithms/overlaps.hpp 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -179,7 +179,9 @@
\brief \brief_check2{overlap}
\ingroup overlaps
\return \return_check2{overlap}
- */
+
+\qbk{[include reference/algorithms/overlaps.qbk]}
+*/
template <typename Geometry1, typename Geometry2>
inline bool overlaps(Geometry1 const& geometry1, Geometry2 const& geometry2)
{
Modified: trunk/boost/geometry/geometries/point_xy.hpp
==============================================================================
--- trunk/boost/geometry/geometries/point_xy.hpp (original)
+++ trunk/boost/geometry/geometries/point_xy.hpp 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -36,6 +36,9 @@
[heading Model of]
[link geometry.reference.concepts.concept_point Point Concept]
}
+
+\qbk{[include reference/geometries/point_assign_warning.qbk]}
+
*/
template<typename CoordinateType, typename CoordinateSystem = cs::cartesian>
class point_xy : public model::point<CoordinateType, 2, CoordinateSystem>
Modified: trunk/libs/geometry/doc/compiling.qbk
==============================================================================
--- trunk/libs/geometry/doc/compiling.qbk (original)
+++ trunk/libs/geometry/doc/compiling.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -39,9 +39,11 @@
* 9.0 (__msvc__ 2008) [/reported by Trunk report May 8, 2011]
* 8.0 (__msvc__ 2005) [/reported by Trunk report May 8, 2011]
* gcc
+ * gcc 4.7.0 [/reported by Trunk report February 12, 2012]
+ * gcc 4.6.2 [/reported by Trunk report February 12, 2012]
* gcc 4.6.1 [/reported by Trunk report May 8, 2011]
- * gcc 4.6.0 (including C++0x) [/reported by Trunk report May 8, 2011]
- * gcc 4.5.2 (including C++0x) [/reported by Trunk report May 8, 2011]
+ * gcc 4.6.0 [/reported by Trunk report May 8, 2011]
+ * gcc 4.5.2 [/reported by Trunk report May 8, 2011]
* gcc 4.4.0 [/reported by Trunk report May 8, 2011]
* gcc 4.3.4 [/reported by Trunk report March 26, 2011]
* gcc 4.2.1 [/reported by Trunk report May 8, 2011]
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 12:07:37 EST (Sun, 12 Feb 2012)
@@ -27,9 +27,19 @@
* The type defined by the metafunction `range_value<...>::type` must fulfill
the [link geometry.reference.concepts.concept_point Point Concept]
+[heading Rules]
+
+Besides the Concepts, which are checks on compile-time, there are rules that
+valid linestrings must fulfill. Most algorithms work on any linestring, so either
+self-crossing or not. However, for correct results using the overlay algorithms
+(intersection and difference algorithms in combination with a polygon)
+self-intersections can disturb the process and result in incorrect results.
+
[heading Available Models]
* [link geometry.reference.models.model_linestring model::linestring]
* a std::vector (requires registration)
* a std::deque (requires registration)
+[see_boost_range_sample Linestring]
+
[endsect]
Modified: trunk/libs/geometry/doc/concept/ring.qbk
==============================================================================
--- trunk/libs/geometry/doc/concept/ring.qbk (original)
+++ trunk/libs/geometry/doc/concept/ring.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -41,5 +41,6 @@
* a std::vector (requires `#include boost/geometry/geometries/adapted/std_as_ring.hpp>`)
* a std::deque (requires `#include boost/geometry/geometries/adapted/std_as_ring.hpp>`)
+[see_boost_range_sample Ring]
[endsect]
Modified: trunk/libs/geometry/doc/geometry.qbk
==============================================================================
--- trunk/libs/geometry/doc/geometry.qbk (original)
+++ trunk/libs/geometry/doc/geometry.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -95,6 +95,13 @@
The function [function] conforms to the [std_function] of the C++ std-library.
]
+[template see_boost_range_sample[concept]
+[note See also the sample in the [@../../../range/doc/html/range/reference/extending/method_2.html Boost.Range documentation]
+ showing how a type can be adapted to a Boost.Range to fulfill the concept of a [concept]
+]
+]
+
+
[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 12:07:37 EST (Sun, 12 Feb 2012)
@@ -33,7 +33,7 @@
</h3></div></div>
<div><p class="copyright">Copyright © 2009 -2012 Barend Gehrels, Bruno Lalande, Mateusz Loskot</p></div>
<div><div class="legalnotice">
-<a name="id857080"></a><p>
+<a name="id876741"></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>
@@ -74,7 +74,7 @@
</dl>
</div>
<a name="geometry.contributions"></a><h3>
-<a name="id857099"></a>
+<a name="id876760"></a>
<a class="link" href="index.html#geometry.contributions">Contributions</a>
</h3>
<p>
@@ -88,24 +88,24 @@
Alfredo Correa (adaption of Boost.Array)
</li>
<li class="listitem">
- Adam Wulkiewicz (spatial indexes) <sup>[<a name="id857137" href="#ftn.id857137" class="footnote">1</a>]</sup>
+ Adam Wulkiewicz (spatial indexes) <sup>[<a name="id876797" href="#ftn.id876797" class="footnote">1</a>]</sup>
</li>
<li class="listitem">
- Federico Fernández (spatial indexes) <sup>[<a name="id857151" href="#ftn.id857151" class="footnote">2</a>]</sup>
+ Federico Fernández (spatial indexes) <sup>[<a name="id876812" href="#ftn.id876812" 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.id857137" href="#id857137" class="para">1</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id876797" href="#id876797" class="para">1</a>] </sup>
Currently an extension
</p></div>
-<div class="footnote"><p><sup>[<a name="ftn.id857151" href="#id857151" class="para">2</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id876812" href="#id876812" 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: February 12, 2012 at 15:01:29 GMT</small></p></td>
+<td align="left"><p><small>Last revised: February 12, 2012 at 17:00:38 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Added: trunk/libs/geometry/doc/reference/algorithms/disjoint.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/reference/algorithms/disjoint.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -0,0 +1,15 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
+ Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
+ Copyright (c) 2009-2012 Bruno Lalande, Paris, France.
+
+ Use, modification and distribution is subject to 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)
+=============================================================================/]
+
+[def __this_function__ disjoint]
+
+[heading_conformance_ogc __this_function__..Disjoint]
Added: trunk/libs/geometry/doc/reference/algorithms/envelope.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/reference/algorithms/envelope.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -0,0 +1,15 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
+ Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
+ Copyright (c) 2009-2012 Bruno Lalande, Paris, France.
+
+ Use, modification and distribution is subject to 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)
+=============================================================================/]
+
+[def __this_function__ envelope]
+
+[heading_conformance_ogc __this_function__..Envelope]
Added: trunk/libs/geometry/doc/reference/algorithms/for_each_point.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/reference/algorithms/for_each_point.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -0,0 +1,16 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
+ Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
+ Copyright (c) 2009-2012 Bruno Lalande, Paris, France.
+
+ Use, modification and distribution is subject to 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)
+=============================================================================/]
+
+[def __this_function__ for_each_point]
+
+[heading_conformance_no_ogc __this_function__]
+[conformance_std __this_function__..std::for_each function]
Added: trunk/libs/geometry/doc/reference/algorithms/for_each_segment.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/reference/algorithms/for_each_segment.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -0,0 +1,16 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
+ Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
+ Copyright (c) 2009-2012 Bruno Lalande, Paris, France.
+
+ Use, modification and distribution is subject to 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)
+=============================================================================/]
+
+[def __this_function__ for_each_segment]
+
+[heading_conformance_no_ogc __this_function__]
+[conformance_std __this_function__..std::for_each function]
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 12:07:37 EST (Sun, 12 Feb 2012)
@@ -13,7 +13,7 @@
[def __this_function__ intersects]
[heading_conformance_ogc __this_function__..Intersects]
-[note The one argument version is added for __boost_geometry__]
+[? __one_parameter__ The version with one parameter is additional and not described in the OGC standard]
[heading Examples]
[intersects_linestring]
Added: trunk/libs/geometry/doc/reference/algorithms/overlaps.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/reference/algorithms/overlaps.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -0,0 +1,15 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
+ Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
+ Copyright (c) 2009-2012 Bruno Lalande, Paris, France.
+
+ Use, modification and distribution is subject to 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)
+=============================================================================/]
+
+[def __this_function__ overlaps]
+
+[heading_conformance_ogc __this_function__..Overlaps]
Modified: trunk/libs/geometry/doc/reference/geometries/point.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/geometries/point.qbk (original)
+++ trunk/libs/geometry/doc/reference/geometries/point.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -13,3 +13,6 @@
[heading Examples]
[point]
[point_output]
+
+[include reference/geometries/point_assign_warning.qbk]
+
Added: trunk/libs/geometry/doc/reference/geometries/point_assign_warning.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/reference/geometries/point_assign_warning.qbk 2012-02-12 12:07:37 EST (Sun, 12 Feb 2012)
@@ -0,0 +1,16 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
+ Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
+ Copyright (c) 2009-2012 Bruno Lalande, Paris, France.
+
+ Use, modification and distribution is subject to 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)
+=============================================================================/]
+
+[heading Notes]
+[note Coordinates are not initialized. If the constructor with parameters is not
+called and points are not assigned using `set` or `assign` then the coordinate
+values will contain garbage]
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