|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r65376 - in sandbox/geometry/libs/geometry/doc/qbk: . reference
From: barend.gehrels_at_[hidden]
Date: 2010-09-10 13:43:19
Author: barendgehrels
Date: 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
New Revision: 65376
URL: http://svn.boost.org/trac/boost/changeset/65376
Log:
Now runs on linux
Text files modified:
sandbox/geometry/libs/geometry/doc/qbk/make_qbk.py | 4 +-
sandbox/geometry/libs/geometry/doc/qbk/reference/area.qbk | 44 ++++++++++++++----------
sandbox/geometry/libs/geometry/doc/qbk/reference/buffer.qbk | 13 +++++-
sandbox/geometry/libs/geometry/doc/qbk/reference/centroid.qbk | 72 +++++++++++++++++++++++++++------------
sandbox/geometry/libs/geometry/doc/qbk/reference/closing_iterator.qbk | 8 +++
sandbox/geometry/libs/geometry/doc/qbk/reference/concept_point.qbk | 2
sandbox/geometry/libs/geometry/doc/qbk/reference/convex_hull.qbk | 6 +-
sandbox/geometry/libs/geometry/doc/qbk/reference/dissolve.qbk | 2
sandbox/geometry/libs/geometry/doc/qbk/reference/distance.qbk | 10 ++++-
sandbox/geometry/libs/geometry/doc/qbk/reference/envelope.qbk | 6 +-
sandbox/geometry/libs/geometry/doc/qbk/reference/intersection.qbk | 40 +++++++++++----------
sandbox/geometry/libs/geometry/doc/qbk/reference/intersects.qbk | 32 +++++++----------
sandbox/geometry/libs/geometry/doc/qbk/reference/length.qbk | 40 ++++++++++++---------
sandbox/geometry/libs/geometry/doc/qbk/reference/num_geometries.qbk | 2
sandbox/geometry/libs/geometry/doc/qbk/reference/num_interior_rings.qbk | 2
sandbox/geometry/libs/geometry/doc/qbk/reference/num_points.qbk | 2
sandbox/geometry/libs/geometry/doc/qbk/reference/perimeter.qbk | 36 +++++++++++++------
sandbox/geometry/libs/geometry/doc/qbk/reference/point.qbk | 7 +--
sandbox/geometry/libs/geometry/doc/qbk/reference/point_xy.qbk | 4 +-
sandbox/geometry/libs/geometry/doc/qbk/reference/register.qbk | 53 +++++++++++++++++++++++-----
sandbox/geometry/libs/geometry/doc/qbk/reference/reverse.qbk | 8 +++
sandbox/geometry/libs/geometry/doc/qbk/reference/simplify.qbk | 49 ++++++++++++--------------
sandbox/geometry/libs/geometry/doc/qbk/reference/unique.qbk | 2
sandbox/geometry/libs/geometry/doc/qbk/reference/within.qbk | 32 ++++++++--------
24 files changed, 289 insertions(+), 187 deletions(-)
Modified: sandbox/geometry/libs/geometry/doc/qbk/make_qbk.py
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/make_qbk.py (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/make_qbk.py 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -22,7 +22,7 @@
#skip_doxygen
-cmd="doxygen_xml2qbk.exe ../doxygen_output/xml/%s.xml ../../../../ boost/geometry/geometry.hpp boost/geometry/geometries/geometries.hpp boost/geometry/multi/multi.hpp > reference/%s.qbk"
+cmd="doxygen_xml2qbk ../doxygen_output/xml/%s.xml ../../../../ boost/geometry/geometry.hpp boost/geometry/geometries/geometries.hpp boost/geometry/multi/multi.hpp > reference/%s.qbk"
# Algorithms
os.system(cmd % ("group__area", "area"));
@@ -73,6 +73,6 @@
os.system(cmd % ("structboost_1_1geometry_1_1closing__iterator", "closing_iterator"));
-os.system("bjam --toolset=msvc --without-python")
+os.system("bjam")
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/area.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/area.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/area.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,21 +1,22 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__area.xml]
-[section:area_1 area]
+[/ Generated from ../doxygen_output/xml/group__area.xml]
+[section:area_2 area (with strategy)]
-Calculates the area of a geometry.
+Calculates the area of a geometry using the specified strategy.
[heading Description]
-The free function area calculates the area of a geometry. It uses the default strategy, based on the coordinate system of the geometry.
+The free function area calculates the area of a geometry using the specified strategy. Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation (e.g. distance over the Earth)
[heading Synopsis]
-``template<typename Geometry>
-area_result<Geometry>::type area (Geometry const &geometry)``
+``template<typename Geometry, typename Strategy>
+Strategy::return_type area (Geometry const &geometry, Strategy const &strategy)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
+[[Strategy const &] [Any type fulfilling a Area Strategy Concept ] [strategy] [The strategy which will be used for area calculations ]]
]
@@ -46,30 +47,25 @@
[heading Complexity]
Linear
-[heading Examples]
-[area_polygon]
-[area_polygon_spherical]
-
[endsect]
-[section:area_2 area (with strategy)]
+[section:area_1 area]
-Calculates the area of a geometry using the specified strategy.
+Calculates the area of a geometry.
[heading Description]
-The free function area calculates the area of a geometry using the specified strategy. Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation (e.g. distance over the Earth)
+The free function area calculates the area of a geometry. It uses the default strategy, based on the coordinate system of the geometry.
[heading Synopsis]
-``template<typename Geometry, typename Strategy>
-Strategy::return_type area (Geometry const &geometry, Strategy const &strategy)``
+``template<typename Geometry>
+area_result<Geometry>::type area (Geometry const &geometry)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
-[[Strategy const &] [Any type fulfilling a Area Strategy Concept ] [strategy] [The strategy which will be used for area calculations ]]
]
@@ -85,8 +81,20 @@
`#include <boost/geometry/algorithms/area.hpp>`
-[heading Examples]
-[area_polygon_strategy]
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__0dim__][[qbk_ret 0]]]
+[[__1dim__][[qbk_ret 0]]]
+[[__2dim__][[qbk_ret the area]]]
+[[__cart__][[qbk_ret the area] __cs_units__]]
+[[__sph__][[qbk_ret the area] __sph1__]]
+[[__rev__][[qbk_ret the negative area]]]
+]
+
+
+[heading Complexity]
+Linear
[endsect]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/buffer.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/buffer.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/buffer.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__buffer.xml]
-[section:buffer buffer]
+[/ Generated from ../doxygen_output/xml/group__buffer.xml]
+[section:buffer_4 buffer]
Calculates the buffer of a geometry.
@@ -41,7 +41,7 @@
[endsect]
-[section:make_buffer make_buffer]
+[section:make_buffer_3 make_buffer]
Calculates the buffer of a geometry.
@@ -76,6 +76,13 @@
`#include <boost/geometry/algorithms/buffer.hpp>`
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__box__/__box__][Returns a new rectangular box, enlarged with the specified distance. It is allowed that "geometry_out" the same object as "geometry_in"]]
+]
+
+
[endsect]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/centroid.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/centroid.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/centroid.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,23 +1,22 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__centroid.xml]
-[section:centroid_3 centroid (with strategy)]
+[/ Generated from ../doxygen_output/xml/group__centroid.xml]
+[section:centroid_2 centroid]
-Calculates the centroid of a geometry using the specified strategy.
+Calculates the centroid of a geometry.
[heading Description]
The free function centroid calculates the geometric center (or: center of mass) of a geometry
[heading Synopsis]
-``template<typename Geometry, typename Point, typename Strategy>
-void centroid (Geometry const &geometry, Point &c, Strategy const &strategy)``
+``template<typename Geometry, typename Point>
+void centroid (Geometry const &geometry, Point &c)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
-[[Point &] [Any type fulfilling a Point Concept ] [c] [A model of the specified Point Concept which is set to the centroid ]]
-[[Strategy const &] [Any type fulfilling a Centroid Strategy Concept ] [strategy] [The strategy which will be used for centroid calculations]]
+[[Point &] [Any type fulfilling a Point Concept ] [c] [the calculated centroid will be assigned to this point reference]]
]
@@ -46,23 +45,24 @@
[endsect]
-[section:centroid_2 centroid]
+[section:centroid_3 centroid (with strategy)]
-Calculates the centroid of a geometry.
+Calculates the centroid of a geometry using the specified strategy.
[heading Description]
The free function centroid calculates the geometric center (or: center of mass) of a geometry
[heading Synopsis]
-``template<typename Geometry, typename Point>
-void centroid (Geometry const &geometry, Point &c)``
+``template<typename Geometry, typename Point, typename Strategy>
+void centroid (Geometry const &geometry, Point &c, Strategy const &strategy)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
-[[Point &] [Any type fulfilling a Point Concept ] [c] [the calculated centroid will be assigned to this point reference]]
+[[Point &] [Any type fulfilling a Point Concept ] [c] [A model of the specified Point Concept which is set to the centroid ]]
+[[Strategy const &] [Any type fulfilling a Centroid Strategy Concept ] [strategy] [The strategy which will be used for centroid calculations]]
]
@@ -91,16 +91,16 @@
[endsect]
-[section:make_centroid_1 make_centroid]
+[section:make_centroid_2 make_centroid (with strategy)]
-Calculates the centroid of a geometry.
+Calculates the centroid of a geometry using the specified strategy.
[heading Description]
The free function centroid calculates the geometric center (or: center of mass) of a geometry. This version with the make_ prefix returns the centroid, and a template parameter must therefore be specified in the call..
[heading Synopsis]
-``template<typename Point, typename Geometry>
-Point make_centroid (Geometry const &geometry)``
+``template<typename Point, typename Geometry, typename Strategy>
+Point make_centroid (Geometry const &geometry, Strategy const &strategy)``
[heading Parameters]
@@ -108,11 +108,12 @@
[[Type] [Concept] [Name] [Description] ]
[[Point] [Any type fulfilling a Point Concept ] [ - ] [Must be specified]]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
+[[Strategy const &] [Any type fulfilling a centroid Strategy Concept ] [strategy] [The strategy which will be used for centroid calculations ]]
]
[heading Returns]
-The calculated centroid
+The calculated centroid
[heading Header]
Either
@@ -123,19 +124,32 @@
`#include <boost/geometry/algorithms/centroid.hpp>`
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__0dim__][Calculates centroid]]
+[[__1dim__][Calculates centroid]]
+[[__2dim__][Calculates centroid]]
+[[__empty__][Throws a centroid_exception]]
+]
+
+
+[heading Complexity]
+Linear
+
[endsect]
-[section:make_centroid_2 make_centroid (with strategy)]
+[section:make_centroid_1 make_centroid]
-Calculates the centroid of a geometry using the specified strategy.
+Calculates the centroid of a geometry.
[heading Description]
The free function centroid calculates the geometric center (or: center of mass) of a geometry. This version with the make_ prefix returns the centroid, and a template parameter must therefore be specified in the call..
[heading Synopsis]
-``template<typename Point, typename Geometry, typename Strategy>
-Point make_centroid (Geometry const &geometry, Strategy const &strategy)``
+``template<typename Point, typename Geometry>
+Point make_centroid (Geometry const &geometry)``
[heading Parameters]
@@ -143,12 +157,11 @@
[[Type] [Concept] [Name] [Description] ]
[[Point] [Any type fulfilling a Point Concept ] [ - ] [Must be specified]]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
-[[Strategy const &] [Any type fulfilling a centroid Strategy Concept ] [strategy] [The strategy which will be used for centroid calculations ]]
]
[heading Returns]
-The calculated centroid
+The calculated centroid
[heading Header]
Either
@@ -159,6 +172,19 @@
`#include <boost/geometry/algorithms/centroid.hpp>`
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__0dim__][Calculates centroid]]
+[[__1dim__][Calculates centroid]]
+[[__2dim__][Calculates centroid]]
+[[__empty__][Throws a centroid_exception]]
+]
+
+
+[heading Complexity]
+Linear
+
[endsect]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/closing_iterator.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/closing_iterator.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/closing_iterator.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,5 +1,5 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\structboost_1_1geometry_1_1closing__iterator.xml]
+[/ Generated from ../doxygen_output/xml/structboost_1_1geometry_1_1closing__iterator.xml]
[section:closing_iterator closing_iterator]
[heading Synopsis]
@@ -40,6 +40,12 @@
]
[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
`#include <boost/geometry/iterators/closing_iterator.hpp>`
[endsect]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/concept_point.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/concept_point.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/concept_point.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,5 +1,5 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\classboost_1_1geometry_1_1concept_1_1_point.xml]
+[/ Generated from ../doxygen_output/xml/classboost_1_1geometry_1_1concept_1_1_point.xml]
[section:concept::Point concept::Point]
[heading Description]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/convex_hull.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/convex_hull.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/convex_hull.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__convex__hull.xml]
-[section:convex_hull convex_hull]
+[/ Generated from ../doxygen_output/xml/group__convex__hull.xml]
+[section:convex_hull_2 convex_hull]
Calculates the convex hull of a geometry.
@@ -32,7 +32,7 @@
[endsect]
-[section:convex_hull_inserter convex_hull_inserter]
+[section:convex_hull_inserter_2 convex_hull_inserter]
Calculate the convex hull of a geometry, output-iterator version.
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/dissolve.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/dissolve.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/dissolve.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,2 +1,2 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__dissolve.xml]
+[/ Generated from ../doxygen_output/xml/group__dissolve.xml]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/distance.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/distance.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/distance.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__distance.xml]
-[section:comparable_distance comparable_distance]
+[/ Generated from ../doxygen_output/xml/group__distance.xml]
+[section:comparable_distance_2 comparable_distance]
Calculate the comparable distance measurement of two geometries.
@@ -24,6 +24,12 @@
The calculated comparable distance
[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
`#include <boost/geometry/algorithms/comparable_distance.hpp>`
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/envelope.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/envelope.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/envelope.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__envelope.xml]
-[section:envelope envelope]
+[/ Generated from ../doxygen_output/xml/group__envelope.xml]
+[section:envelope_2 envelope]
Calculates the envelope of a geometry.
@@ -32,7 +32,7 @@
[endsect]
-[section:make_envelope make_envelope]
+[section:make_envelope_1 make_envelope]
Calculates the envelope of a geometry.
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/intersection.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/intersection.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/intersection.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__intersection.xml]
-[section:intersection intersection]
+[/ Generated from ../doxygen_output/xml/group__intersection.xml]
+[section:intersection_3 intersection]
Calculate the intersection of two geometries.
@@ -39,23 +39,19 @@
]
-[heading Examples]
-[intersection_linestring]
-[intersection_segment]
-
[endsect]
-[section:intersection_inserter_4 intersection_inserter (with strategy)]
+[section:intersection_inserter_3 intersection_inserter]
-Calculate the intersection of two geometries using the specified strategy.
+Calculate the intersection of two geometries.
[heading Description]
-The free function intersection_inserter calculates the spatial set theoretic intersection of two geometries using the specified strategy. This version with the _inserter suffix outputs the intersection to an output iterator, and a template parameter must therefore be specified in the call.
+The free function intersection_inserter calculates the spatial set theoretic intersection of two geometries. This version with the _inserter suffix outputs the intersection to an output iterator, and a template parameter must therefore be specified in the call.
[heading Synopsis]
-``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
-OutputIterator intersection_inserter (Geometry1 const &geometry1, Geometry2 const &geometry2, OutputIterator out, Strategy const &strategy)``
+``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
+OutputIterator intersection_inserter (Geometry1 const &geometry1, Geometry2 const &geometry2, OutputIterator out)``
[heading Parameters]
@@ -65,7 +61,6 @@
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
[[OutputIterator] [A valid output iterator type, accepting geometries of Point, LineString or Polygon Concept ] [out] [The output iterator, to which intersection geometries are feeded ]]
-[[Strategy const &] [Compound strategy for intersection ] [strategy] [The strategy ]]
]
@@ -93,16 +88,16 @@
[endsect]
-[section:intersection_inserter_3 intersection_inserter]
+[section:intersection_inserter_4 intersection_inserter (with strategy)]
-Calculate the intersection of two geometries.
+Calculate the intersection of two geometries using the specified strategy.
[heading Description]
-The free function intersection_inserter calculates the spatial set theoretic intersection of two geometries. This version with the _inserter suffix outputs the intersection to an output iterator, and a template parameter must therefore be specified in the call.
+The free function intersection_inserter calculates the spatial set theoretic intersection of two geometries using the specified strategy. This version with the _inserter suffix outputs the intersection to an output iterator, and a template parameter must therefore be specified in the call.
[heading Synopsis]
-``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
-OutputIterator intersection_inserter (Geometry1 const &geometry1, Geometry2 const &geometry2, OutputIterator out)``
+``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
+OutputIterator intersection_inserter (Geometry1 const &geometry1, Geometry2 const &geometry2, OutputIterator out, Strategy const &strategy)``
[heading Parameters]
@@ -112,6 +107,7 @@
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
[[OutputIterator] [A valid output iterator type, accepting geometries of Point, LineString or Polygon Concept ] [out] [The output iterator, to which intersection geometries are feeded ]]
+[[Strategy const &] [Compound strategy for intersection ] [strategy] [The strategy ]]
]
@@ -127,8 +123,14 @@
`#include <boost/geometry/algorithms/intersection.hpp>`
-[heading Examples]
-[intersection_segment_inserter]
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[[qbk_out __point__]][Calculates intersection points of input geometries]]
+[[[qbk_out __linestring__]][Calculates intersection linestrings of input geometries (NYI)]]
+[[[qbk_out __polygon__]][Calculates intersection polygons input (multi)polygons and/or boxes]]
+]
+
[endsect]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/intersects.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/intersects.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/intersects.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,23 +1,24 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__intersects.xml]
-[section:intersects_1 intersects (one geometry)]
+[/ Generated from ../doxygen_output/xml/group__intersects.xml]
+[section:intersects_2 intersects]
-Checks if a geometry has at least one intersection (crossing or self-tangency).
+Checks if two geometries have at least one intersection.
[heading Synopsis]
-``template<typename Geometry>
-bool intersects (Geometry const &geometry)``
+``template<typename Geometry1, typename Geometry2>
+bool intersects (Geometry1 const &geometry1, Geometry2 const &geometry2)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
-[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
+[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
+[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
]
[heading Returns]
-Returns true if the geometry is self-intersecting
+Returns true if two geometries intersect each other
[heading Header]
Either
@@ -31,25 +32,24 @@
[endsect]
-[section:intersects_2 intersects (two geometries)]
+[section:intersects_1 intersects]
-Checks if two geometries have at least one intersection.
+Checks if a geometry has at least one intersection (crossing or self-tangency).
[heading Synopsis]
-``template<typename Geometry1, typename Geometry2>
-bool intersects (Geometry1 const &geometry1, Geometry2 const &geometry2)``
+``template<typename Geometry>
+bool intersects (Geometry const &geometry)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
-[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
-[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
+[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
]
[heading Returns]
-Returns true if two geometries intersect each other
+Returns true if the geometry is self-intersecting
[heading Header]
Either
@@ -60,10 +60,6 @@
`#include <boost/geometry/algorithms/intersects.hpp>`
-[heading Examples]
-[intersects_linestring]
-[intersects_segment]
-
[endsect]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/length.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/length.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/length.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,21 +1,22 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__length.xml]
-[section:length_1 length]
+[/ Generated from ../doxygen_output/xml/group__length.xml]
+[section:length_2 length (with strategy)]
-Calculates the length of a geometry.
+Calculates the length of a geometry using the specified strategy.
[heading Description]
-The free function length calculates the length (the sum of distances between consecutive points) of a geometry. It uses the default strategy, based on the coordinate system of the geometry.
+The free function length calculates the length (the sum of distances between consecutive points) of a geometry using the specified strategy. Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation (e.g. distance over the Earth)
[heading Synopsis]
-``template<typename Geometry>
-length_result<Geometry>::type length (Geometry const &geometry)``
+``template<typename Geometry, typename Strategy>
+length_result<Geometry>::type length (Geometry const &geometry, Strategy const &strategy)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
+[[Strategy const &] [Any type fulfilling a distance Strategy Concept ] [strategy] [The strategy which will be used for distance calculations ]]
]
@@ -43,29 +44,25 @@
[heading Complexity]
Linear
-[heading Examples]
-[length]
-
[endsect]
-[section:length_2 length (with strategy)]
+[section:length_1 length]
-Calculates the length of a geometry using the specified strategy.
+Calculates the length of a geometry.
[heading Description]
-The free function length calculates the length (the sum of distances between consecutive points) of a geometry using the specified strategy. Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation (e.g. distance over the Earth)
+The free function length calculates the length (the sum of distances between consecutive points) of a geometry. It uses the default strategy, based on the coordinate system of the geometry.
[heading Synopsis]
-``template<typename Geometry, typename Strategy>
-length_result<Geometry>::type length (Geometry const &geometry, Strategy const &strategy)``
+``template<typename Geometry>
+length_result<Geometry>::type length (Geometry const &geometry)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
-[[Strategy const &] [Any type fulfilling a distance Strategy Concept ] [strategy] [The strategy which will be used for distance calculations ]]
]
@@ -81,8 +78,17 @@
`#include <boost/geometry/algorithms/length.hpp>`
-[heading Examples]
-[length_strategy]
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__0dim__][[qbk_ret 0]]]
+[[__1dim__][[qbk_ret the length]]]
+[[__2dim__][[qbk_ret 0]]]
+]
+
+
+[heading Complexity]
+Linear
[endsect]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/num_geometries.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/num_geometries.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/num_geometries.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,5 +1,5 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__num__geometries.xml]
+[/ Generated from ../doxygen_output/xml/group__num__geometries.xml]
[section:num_geometries num_geometries]
Calculates the number of geometries of a geometry.
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/num_interior_rings.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/num_interior_rings.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/num_interior_rings.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,5 +1,5 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__num__interior__rings.xml]
+[/ Generated from ../doxygen_output/xml/group__num__interior__rings.xml]
[section:num_interior_rings num_interior_rings]
Calculates the number of interior rings of a geometry.
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/num_points.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/num_points.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/num_points.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,5 +1,5 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__num__points.xml]
+[/ Generated from ../doxygen_output/xml/group__num__points.xml]
[section:num_points num_points]
Calculates the number of points of a geometry.
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/perimeter.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/perimeter.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/perimeter.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,21 +1,22 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__perimeter.xml]
-[section:perimeter_1 perimeter]
+[/ Generated from ../doxygen_output/xml/group__perimeter.xml]
+[section:perimeter_2 perimeter (with strategy)]
-Calculates the perimeter of a geometry.
+Calculates the perimeter of a geometry using the specified strategy.
[heading Description]
-The function perimeter returns the perimeter of a geometry, using the default distance-calculation-strategy
+The function perimeter returns the perimeter of a geometry, using specified strategy
[heading Synopsis]
-``template<typename Geometry>
-length_result<Geometry>::type perimeter (Geometry const &geometry)``
+``template<typename Geometry, typename Strategy>
+length_result<Geometry>::type perimeter (Geometry const &geometry, Strategy const &strategy)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
+[[Strategy const &] [Any type fulfilling a distance Strategy Concept ] [strategy] [strategy to be used for distance calculations. ]]
]
@@ -46,23 +47,22 @@
[endsect]
-[section:perimeter_2 perimeter (with strategy)]
+[section:perimeter_1 perimeter]
-Calculates the perimeter of a geometry using the specified strategy.
+Calculates the perimeter of a geometry.
[heading Description]
-The function perimeter returns the perimeter of a geometry, using specified strategy
+The function perimeter returns the perimeter of a geometry, using the default distance-calculation-strategy
[heading Synopsis]
-``template<typename Geometry, typename Strategy>
-length_result<Geometry>::type perimeter (Geometry const &geometry, Strategy const &strategy)``
+``template<typename Geometry>
+length_result<Geometry>::type perimeter (Geometry const &geometry)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
-[[Strategy const &] [Any type fulfilling a distance Strategy Concept ] [strategy] [strategy to be used for distance calculations. ]]
]
@@ -78,6 +78,18 @@
`#include <boost/geometry/algorithms/perimeter.hpp>`
+[heading Behavior]
+[table
+[[Case] [Behavior] ]
+[[__0dim__][Returns zero]]
+[[__1dim__][Returns zero]]
+[[__2dim__][Returns the perimeter]]
+]
+
+
+[heading Complexity]
+Linear
+
[endsect]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/point.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/point.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/point.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,5 +1,5 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\classboost_1_1geometry_1_1point.xml]
+[/ Generated from ../doxygen_output/xml/classboost_1_1geometry_1_1point.xml]
[section:point point]
[heading Description]
@@ -71,14 +71,11 @@
[heading Header]
Either
-`#include <boost/geometry/geometries/geometries.hpp>`
+`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/geometries/point.hpp>`
-[heading Examples]
-[point]
-
[endsect]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/point_xy.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/point_xy.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/point_xy.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,5 +1,5 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\classboost_1_1geometry_1_1point__xy.xml]
+[/ Generated from ../doxygen_output/xml/classboost_1_1geometry_1_1point__xy.xml]
[section:point_xy point_xy]
[heading Synopsis]
@@ -74,7 +74,7 @@
[heading Header]
Either
-`#include <boost/geometry/geometries/geometries.hpp>`
+`#include <boost/geometry/geometry.hpp>`
Or
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/register.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/register.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/register.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__register.xml]
-[section:BOOST_GEOMETRY_REGISTER_POINT_2D BOOST_GEOMETRY_REGISTER_POINT_2D]
+[/ Generated from ../doxygen_output/xml/group__register.xml]
+[section:BOOST_GEOMETRY_REGISTER_POINT_2D_5 BOOST_GEOMETRY_REGISTER_POINT_2D]
Macro to register a 2D point type.
@@ -23,17 +23,20 @@
[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
`#include <boost/geometry/geometries/register/point.hpp>`
[caution Use the macro outside any namespace]
[note A point can include a namespace]
-[heading Examples]
-[boost_geometry_register_point_2d]
-
[endsect]
-[section:BOOST_GEOMETRY_REGISTER_POINT_2D_CONST BOOST_GEOMETRY_REGISTER_POINT_2D_CONST]
+[section:BOOST_GEOMETRY_REGISTER_POINT_2D_CONST_5 BOOST_GEOMETRY_REGISTER_POINT_2D_CONST]
Macro to register a 2D point type (const version).
@@ -56,12 +59,18 @@
[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
`#include <boost/geometry/geometries/register/point.hpp>`
[endsect]
-[section:BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET]
+[section:BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET_7 BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET]
Macro to register a 2D point type (having separate get/set methods).
@@ -86,12 +95,18 @@
[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
`#include <boost/geometry/geometries/register/point.hpp>`
[endsect]
-[section:BOOST_GEOMETRY_REGISTER_POINT_3D BOOST_GEOMETRY_REGISTER_POINT_3D]
+[section:BOOST_GEOMETRY_REGISTER_POINT_3D_6 BOOST_GEOMETRY_REGISTER_POINT_3D]
Macro to register a 3D point type.
@@ -115,12 +130,18 @@
[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
`#include <boost/geometry/geometries/register/point.hpp>`
[endsect]
-[section:BOOST_GEOMETRY_REGISTER_POINT_3D_CONST BOOST_GEOMETRY_REGISTER_POINT_3D_CONST]
+[section:BOOST_GEOMETRY_REGISTER_POINT_3D_CONST_6 BOOST_GEOMETRY_REGISTER_POINT_3D_CONST]
Macro to register a 3D point type (const version).
@@ -144,12 +165,18 @@
[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
`#include <boost/geometry/geometries/register/point.hpp>`
[endsect]
-[section:BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET]
+[section:BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET_9 BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET]
Macro to register a 3D point type (having separate get/set methods).
@@ -176,6 +203,12 @@
[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
`#include <boost/geometry/geometries/register/point.hpp>`
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/reverse.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/reverse.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/reverse.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,5 +1,5 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__reverse.xml]
+[/ Generated from ../doxygen_output/xml/group__reverse.xml]
[section:reverse reverse]
Reverses a geometry.
@@ -17,6 +17,12 @@
[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
`#include <boost/geometry/algorithms/reverse.hpp>`
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/simplify.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/simplify.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/simplify.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,21 +1,20 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__simplify.xml]
-[section:simplify_4 simplify (with strategy)]
+[/ Generated from ../doxygen_output/xml/group__simplify.xml]
+[section:simplify_3 simplify]
-Simplify a geometry using a specified strategy.
+Simplify a geometry.
[heading Synopsis]
-``template<typename Geometry, typename Distance, typename Strategy>
-void simplify (Geometry const &geometry, Geometry &out, Distance const &max_distance, Strategy const &strategy)``
+``template<typename Geometry, typename Distance>
+void simplify (Geometry const &geometry, Geometry &out, Distance const &max_distance)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
-[[Strategy const &] [A type fulfilling a SimplifyStrategy concept ] [strategy] [simplify strategy to be used for simplification, might include point-distance strategy]]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [input geometry, to be simplified ]]
[[Geometry &] [Any type fulfilling a Geometry Concept ] [out] [output geometry, simplified version of the input geometry ]]
-[[Distance const &] [A numerical distance measure ] [max_distance] [distance (in units of input coordinates) of a vertex to other segments to be removed ]]
+[[Distance const &] [Numerical type (int, double, ttmath, ...) ] [max_distance] [distance (in units of input coordinates) of a vertex to other segments to be removed]]
]
@@ -28,26 +27,25 @@
`#include <boost/geometry/algorithms/simplify.hpp>`
-[heading Image(s)]
-[$svg_simplify_country.png]
[endsect]
-[section:simplify_3 simplify]
+[section:simplify_4 simplify (with strategy)]
-Simplify a geometry.
+Simplify a geometry using a specified strategy.
[heading Synopsis]
-``template<typename Geometry, typename Distance>
-void simplify (Geometry const &geometry, Geometry &out, Distance const &max_distance)``
+``template<typename Geometry, typename Distance, typename Strategy>
+void simplify (Geometry const &geometry, Geometry &out, Distance const &max_distance, Strategy const &strategy)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
+[[Strategy const &] [A type fulfilling a SimplifyStrategy concept ] [strategy] [simplify strategy to be used for simplification, might include point-distance strategy]]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [input geometry, to be simplified ]]
[[Geometry &] [Any type fulfilling a Geometry Concept ] [out] [output geometry, simplified version of the input geometry ]]
-[[Distance const &] [Numerical type (int, double, ttmath, ...) ] [max_distance] [distance (in units of input coordinates) of a vertex to other segments to be removed]]
+[[Distance const &] [A numerical distance measure ] [max_distance] [distance (in units of input coordinates) of a vertex to other segments to be removed ]]
]
@@ -60,16 +58,18 @@
`#include <boost/geometry/algorithms/simplify.hpp>`
+[heading Image(s)]
+[$svg_simplify_country.png]
[endsect]
-[section:simplify_inserter_4 simplify_inserter (with strategy)]
+[section:simplify_inserter_3 simplify_inserter]
-Simplify a geometry, using an output iterator and a specified strategy.
+Simplify a geometry, using an output iterator.
[heading Synopsis]
-``template<typename Geometry, typename OutputIterator, typename Distance, typename Strategy>
-void simplify_inserter (Geometry const &geometry, OutputIterator out, Distance const &max_distance, Strategy const &strategy)``
+``template<typename Geometry, typename OutputIterator, typename Distance>
+void simplify_inserter (Geometry const &geometry, OutputIterator out, Distance const &max_distance)``
[heading Parameters]
@@ -78,7 +78,6 @@
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [input geometry, to be simplified ]]
[[OutputIterator] [] [out] [output iterator, outputs all simplified points ]]
[[Distance const &] [] [max_distance] [distance (in units of input coordinates) of a vertex to other segments to be removed ]]
-[[Strategy const &] [] [strategy] [simplify strategy to be used for simplification, might include point-distance strategy ]]
]
@@ -91,19 +90,16 @@
`#include <boost/geometry/algorithms/simplify.hpp>`
-[heading Examples]
-[simplify_inserter]
-
[endsect]
-[section:simplify_inserter_3 simplify_inserter]
+[section:simplify_inserter_4 simplify_inserter (with strategy)]
-Simplify a geometry, using an output iterator.
+Simplify a geometry, using an output iterator and a specified strategy.
[heading Synopsis]
-``template<typename Geometry, typename OutputIterator, typename Distance>
-void simplify_inserter (Geometry const &geometry, OutputIterator out, Distance const &max_distance)``
+``template<typename Geometry, typename OutputIterator, typename Distance, typename Strategy>
+void simplify_inserter (Geometry const &geometry, OutputIterator out, Distance const &max_distance, Strategy const &strategy)``
[heading Parameters]
@@ -112,6 +108,7 @@
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [input geometry, to be simplified ]]
[[OutputIterator] [] [out] [output iterator, outputs all simplified points ]]
[[Distance const &] [] [max_distance] [distance (in units of input coordinates) of a vertex to other segments to be removed ]]
+[[Strategy const &] [] [strategy] [simplify strategy to be used for simplification, might include point-distance strategy ]]
]
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/unique.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/unique.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/unique.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,5 +1,5 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__unique.xml]
+[/ Generated from ../doxygen_output/xml/group__unique.xml]
[section:unique unique]
Calculates the minimal set of a geometry.
Modified: sandbox/geometry/libs/geometry/doc/qbk/reference/within.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/qbk/reference/within.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/qbk/reference/within.qbk 2010-09-10 13:43:13 EDT (Fri, 10 Sep 2010)
@@ -1,24 +1,25 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from ..\doxygen_output\xml\group__within.xml]
-[section:within_2 within]
+[/ Generated from ../doxygen_output/xml/group__within.xml]
+[section:within_3 within (with strategy)]
-Checks if the first geometry completely inside the second geometry.
+Within, examine if a geometry is within another geometry, using a specified strategy.
[heading Synopsis]
-``template<typename Geometry1, typename Geometry2>
-bool within (Geometry1 const &geometry1, Geometry2 const &geometry2)``
+``template<typename Geometry1, typename Geometry2, typename Strategy>
+bool within (Geometry1 const &geometry1, Geometry2 const &geometry2, Strategy const &strategy)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
-[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [geometry which might be within the second geometry ]]
-[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [geometry which might contain the first geometry ]]
+[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept geometry which might be within the second geometry ]]
+[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept which might contain the first geometry ]]
+[[Strategy const &] [] [strategy] [strategy to be used ]]
]
[heading Returns]
-true if geometry1 is completely contained within geometry2, else false
+true if geometry1 is completely contained within geometry2, else false
[heading Header]
Either
@@ -32,26 +33,25 @@
[endsect]
-[section:within_3 within (with strategy)]
+[section:within_2 within]
-Within, examine if a geometry is within another geometry, using a specified strategy.
+Checks if the first geometry completely inside the second geometry.
[heading Synopsis]
-``template<typename Geometry1, typename Geometry2, typename Strategy>
-bool within (Geometry1 const &geometry1, Geometry2 const &geometry2, Strategy const &strategy)``
+``template<typename Geometry1, typename Geometry2>
+bool within (Geometry1 const &geometry1, Geometry2 const &geometry2)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
-[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept geometry which might be within the second geometry ]]
-[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept which might contain the first geometry ]]
-[[Strategy const &] [] [strategy] [strategy to be used ]]
+[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [geometry which might be within the second geometry ]]
+[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [geometry which might contain the first geometry ]]
]
[heading Returns]
-true if geometry1 is completely contained within geometry2, else false
+true if geometry1 is completely contained within geometry2, else false
[heading Header]
Either
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