diff options
| author | Lorry Tar Creator <lorry-tar-importer@baserock.org> | 2013-06-25 22:59:01 +0000 |
|---|---|---|
| committer | <> | 2013-09-27 11:49:28 +0000 |
| commit | 8c4528713d907ee2cfd3bfcbbad272c749867f84 (patch) | |
| tree | c09e2ce80f47b90c85cc720f5139089ad9c8cfff /libs/geometry/doc/reference | |
| download | boost-tarball-8c4528713d907ee2cfd3bfcbbad272c749867f84.tar.gz | |
Imported from /home/lorry/working-area/delta_boost-tarball/boost_1_54_0.tar.bz2.boost_1_54_0baserock/morph
Diffstat (limited to 'libs/geometry/doc/reference')
78 files changed, 2111 insertions, 0 deletions
diff --git a/libs/geometry/doc/reference/algorithms/append.qbk b/libs/geometry/doc/reference/algorithms/append.qbk new file mode 100644 index 000000000..3582dfbf4 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/append.qbk @@ -0,0 +1,39 @@ +[/============================================================================ + 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__ append] + +[heading_conformance_no_ogc __this_function__] + +[include generated/append_status.qbk] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__point__, __box__, __segment__][Compiles, but no action]] +[[__linestring__][Appends point or range to the end of the linestring]] +[[__ring__][Appends point or range to the end of the ring (without explicitly closing it)]] +[[__polygon__][Appends point or range to the end of the polygon (without explicitly closing it), + either the exterior ring (the default) or specify a zero-based index for one of the interior rings. + In the last case, the interior rings are not resized automatically, + so ensure that the zero-based index is smaller than the number of interior rings]] +] + +[heading Complexity] +Linear + +[heading Example] +[append] +[append_output] + +[heading See also] +* [link geometry.reference.algorithms.assign.assign_points assign] diff --git a/libs/geometry/doc/reference/algorithms/area.qbk b/libs/geometry/doc/reference/algorithms/area.qbk new file mode 100644 index 000000000..e459ee5da --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/area.qbk @@ -0,0 +1,33 @@ +[/============================================================================ + 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__ area] + +[heading_conformance_ogc __this_function__..Area] + +[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]]] +] + +[include generated/area_status.qbk] + +[heading Complexity] +Linear + + diff --git a/libs/geometry/doc/reference/algorithms/buffer.qbk b/libs/geometry/doc/reference/algorithms/buffer.qbk new file mode 100644 index 000000000..c798daaab --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/buffer.qbk @@ -0,0 +1,26 @@ +[/============================================================================ + 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__ 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] ] +[[__box__/__box__][Returns a new rectangular box, enlarged with the specified distance. It is allowed that "geometry_out" the same object as "geometry_in"]] +] + + diff --git a/libs/geometry/doc/reference/algorithms/centroid.qbk b/libs/geometry/doc/reference/algorithms/centroid.qbk new file mode 100644 index 000000000..12152cb46 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/centroid.qbk @@ -0,0 +1,45 @@ +[/============================================================================ + 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__ centroid] + +[heading_conformance_ogc __this_function__..Centroid] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__point__][Returns the point itself as the centroid]] +[[__multi_point__][Calculates centroid (based on average)]] +[[__1dim__][Calculates centroid (based on weighted length)]] +[[__2dim__][Calculates centroid]] +[[__empty__][Throws a [link geometry.reference.exceptions.centroid_exception centroid_exception] ]] +[[__cart__][Implemented]] +[[__sph__][Calculates the centroid as if based on Cartesian coordinates]] +] + +[heading Supported geometries] +[table +[[ ][2D][3D]] +[[Point][[$img/ok.png]][[$img/ok.png]]] +[[Segment][[$img/ok.png]][[$img/ok.png]]] +[[Box][[$img/ok.png]][[$img/ok.png]]] +[[Linestring][[$img/ok.png]][[$img/nyi.png]]] +[[Ring][[$img/ok.png]][[$img/nyi.png]]] +[[Polygon][[$img/ok.png]][[$img/nyi.png]]] +[[MultiPoint][[$img/ok.png]][[$img/ok.png]]] +[[MultiLinestring][[$img/ok.png]][[$img/nyi.png]]] +[[MultiPolygon][[$img/ok.png]][[$img/nyi.png]]] +] + +[heading Complexity] +Linear + diff --git a/libs/geometry/doc/reference/algorithms/centroid_strategies.qbk b/libs/geometry/doc/reference/algorithms/centroid_strategies.qbk new file mode 100644 index 000000000..b794906c7 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/centroid_strategies.qbk @@ -0,0 +1,14 @@ +[/============================================================================ + 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 Available Strategies] +* [link geometry.reference.strategies.strategy_centroid_bashein_detmer Bashein Detmer (cartesian)] diff --git a/libs/geometry/doc/reference/algorithms/clear.qbk b/libs/geometry/doc/reference/algorithms/clear.qbk new file mode 100644 index 000000000..969d6df84 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/clear.qbk @@ -0,0 +1,41 @@ +[/============================================================================ + 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 __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] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__point__][__does_nothing__]] +[[__segment__][__does_nothing__]] +[[__box__][__does_nothing__]] +[[__linestring__][__linestring__ __is_cleared__]] +[[__ring__][__ring__ is cleared]] +[[__polygon__][The exterior ring __is_cleared__ and all interior rings are removed]] +[[__multi_point__][__multi_point__ __is_cleared__]] +[[__multi_linestring__][__multi_linestring__ __is_cleared__]] +[[__multi_polygon__][__multi_polygon__ __is_cleared__]] +] + +[heading Complexity] +Constant + +[heading Example] +[clear] +[clear_output] + diff --git a/libs/geometry/doc/reference/algorithms/comparable_distance.qbk b/libs/geometry/doc/reference/algorithms/comparable_distance.qbk new file mode 100644 index 000000000..99a6b372d --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/comparable_distance.qbk @@ -0,0 +1,29 @@ +[/============================================================================ + 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__ comparable_distance] + +[heading_conformance_no_ogc __this_function__] + +[heading Behaviour] +There is no (not yet) version with a strategy. + +It depends on the coordinate system of the geometry's point type if there is +a strategy available which can determine (more efficient than the standard +strategy) a measure of comparable distance. + +[heading Complexity] +Linear + +[heading Example] +[comparable_distance] +[comparable_distance_output] diff --git a/libs/geometry/doc/reference/algorithms/convert.qbk b/libs/geometry/doc/reference/algorithms/convert.qbk new file mode 100644 index 000000000..f5704cc0f --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/convert.qbk @@ -0,0 +1,33 @@ +[/============================================================================ + 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__ convert] + +[heading_conformance_no_ogc __this_function__] + +[include generated/convert_status.qbk] +[note In this status matrix above: columns are source types + and rows are target types. So a box can be converted to a ring, polygon + or multi-polygon, but not vice versa.] + +[heading Complexity] +Linear + +[heading Example] +[convert] +[convert_output] + +[heading See also] +* [link geometry.reference.algorithms.assign.assign assign] + +[note convert is modelled as source -> target + (where assign is modelled as target := source)] diff --git a/libs/geometry/doc/reference/algorithms/convex_hull.qbk b/libs/geometry/doc/reference/algorithms/convex_hull.qbk new file mode 100644 index 000000000..492c99a5a --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/convex_hull.qbk @@ -0,0 +1,24 @@ +[/============================================================================ + 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__ convex_hull] + +[heading_conformance_ogc __this_function__..ConvexHull()] + +[include generated/convex_hull_status.qbk] + +[heading Complexity] +Logarithmic + +[heading Example] +[convex_hull] +[convex_hull_output] diff --git a/libs/geometry/doc/reference/algorithms/correct.qbk b/libs/geometry/doc/reference/algorithms/correct.qbk new file mode 100644 index 000000000..cb3f6d902 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/correct.qbk @@ -0,0 +1,36 @@ +[/============================================================================ + 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 __corrected__ is corrected] +[def __this_function__ correct] + +[heading_conformance_no_ogc __this_function__] + +[include generated/correct_status.qbk] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__ring__][__ring__ __corrected__]] +[[__polygon__][__polygon__ __corrected__]] +[[__multi_polygon__][__multi_polygon__ __corrected__]] +[[__box__][__box__ __corrected__ with respect to minimal and maximal corners]] +[[__other__][__does_nothing__]] +] + +[heading Complexity] +Linear + +[heading Example] +[correct] +[correct_output] + diff --git a/libs/geometry/doc/reference/algorithms/covered_by.qbk b/libs/geometry/doc/reference/algorithms/covered_by.qbk new file mode 100644 index 000000000..0fb187f09 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/covered_by.qbk @@ -0,0 +1,35 @@ +[/============================================================================ + 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__ 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. +] + +[heading Complexity] +Linear + +[heading See also] +* [link geometry.reference.algorithms.within within] + +[note The difference with the `within` algorithm is that this algorithm checks the + border by default +]
\ No newline at end of file diff --git a/libs/geometry/doc/reference/algorithms/difference.qbk b/libs/geometry/doc/reference/algorithms/difference.qbk new file mode 100644 index 000000000..3aaf54efd --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/difference.qbk @@ -0,0 +1,26 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2011-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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__ difference] + +[heading_conformance_ogc __this_function__..Difference] + +[include reference/algorithms/difference_behavior.qbk] + +[include reference/algorithms/geometry_rules.qbk] + +[heading Example] +[difference] [difference_output] + +[heading See also] +* [link geometry.reference.algorithms.sym_difference sym_difference (symmetric difference)] +* [link geometry.reference.algorithms.intersection intersection] +* [link geometry.reference.algorithms.union_ union] + diff --git a/libs/geometry/doc/reference/algorithms/difference_behavior.qbk b/libs/geometry/doc/reference/algorithms/difference_behavior.qbk new file mode 100644 index 000000000..0044026c8 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/difference_behavior.qbk @@ -0,0 +1,21 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2011-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Behavior] +[table +[[Case] [Behavior] ] +[[__2dim__][All combinations of: box, ring, polygon, multi_polygon]] +[[__1dim__ / __2dim__][A combinations of a (multi) linestring with a (multi) polygon + results in a collection of linestrings]] +[[__other__][__nyiversion__]] +[[__sph__][__nyiversion__]] +[[Three dimensional][__nyiversion__]] +] + diff --git a/libs/geometry/doc/reference/algorithms/difference_inserter.qbk b/libs/geometry/doc/reference/algorithms/difference_inserter.qbk new file mode 100644 index 000000000..89e309488 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/difference_inserter.qbk @@ -0,0 +1,22 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2011-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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) +=============================================================================/] + +[include reference/algorithms/difference_behavior.qbk] + +[include reference/algorithms/geometry_rules.qbk] + +[heading Example] +[difference_inserter] [difference_inserter_output] + +[heading See also] +* [link geometry.reference.algorithms.sym_difference.sym_difference_inserter_3 sym_difference_inserter (symmetric difference)] +* [link geometry.reference.algorithms.intersection.intersection_inserter_3 intersection_inserter] +* [link geometry.reference.algorithms.union.union_inserter_3 union_inserter] + diff --git a/libs/geometry/doc/reference/algorithms/disjoint.qbk b/libs/geometry/doc/reference/algorithms/disjoint.qbk new file mode 100644 index 000000000..6f5c8ef49 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/disjoint.qbk @@ -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] diff --git a/libs/geometry/doc/reference/algorithms/distance.qbk b/libs/geometry/doc/reference/algorithms/distance.qbk new file mode 100644 index 000000000..d9c448cfe --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/distance.qbk @@ -0,0 +1,26 @@ +[/============================================================================ + 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__ distance] + +[heading_conformance_ogc __this_function__..Distance] + +[include generated/distance_status.qbk] + +[heading Complexity] +Linear + +For multi-geometry to multi-geometry: currently quadratic + +[heading Example] +[distance] +[distance_output] diff --git a/libs/geometry/doc/reference/algorithms/envelope.qbk b/libs/geometry/doc/reference/algorithms/envelope.qbk new file mode 100644 index 000000000..97209a394 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/envelope.qbk @@ -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] diff --git a/libs/geometry/doc/reference/algorithms/equals.qbk b/libs/geometry/doc/reference/algorithms/equals.qbk new file mode 100644 index 000000000..b0159a90a --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/equals.qbk @@ -0,0 +1,25 @@ +[/============================================================================ + 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__ equals] + +[heading_conformance_ogc __this_function__..Equals] + +[include generated/equals_status.qbk] + +[heading Complexity] +Linear + +[heading Example] +[equals] +[equals_output] + diff --git a/libs/geometry/doc/reference/algorithms/expand.qbk b/libs/geometry/doc/reference/algorithms/expand.qbk new file mode 100644 index 000000000..0b1c14bd7 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/expand.qbk @@ -0,0 +1,35 @@ +[/============================================================================ + 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__ expand] +[def __apply_expand__ Box is expanded to include the specified] + +[heading_conformance_no_ogc __this_function__] + + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__box__ / __point__][__apply_expand__ __point__]] +[[__box__ / __box__][__apply_expand__ __box__]] +[[__box__ / __other__][__nyiversion__]] +] + +[note To use expand with another geometry type then specified, use expand(make_envelope<box_type>(geometry)] + +[heading Complexity] +Linear + +[heading Example] +[expand] +[expand_output] + diff --git a/libs/geometry/doc/reference/algorithms/for_each_point.qbk b/libs/geometry/doc/reference/algorithms/for_each_point.qbk new file mode 100644 index 000000000..a48becbda --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/for_each_point.qbk @@ -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] diff --git a/libs/geometry/doc/reference/algorithms/for_each_segment.qbk b/libs/geometry/doc/reference/algorithms/for_each_segment.qbk new file mode 100644 index 000000000..fbb9fc621 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/for_each_segment.qbk @@ -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] diff --git a/libs/geometry/doc/reference/algorithms/geometry_rules.qbk b/libs/geometry/doc/reference/algorithms/geometry_rules.qbk new file mode 100644 index 000000000..15fe580b9 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/geometry_rules.qbk @@ -0,0 +1,12 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2011-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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) +=============================================================================/] + +[note Check the [link geometry.reference.concepts.concept_polygon Polygon Concept] + for the rules that polygon input for this algorithm should fulfill] diff --git a/libs/geometry/doc/reference/algorithms/intersection.qbk b/libs/geometry/doc/reference/algorithms/intersection.qbk new file mode 100644 index 000000000..a4d2c9fbf --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/intersection.qbk @@ -0,0 +1,34 @@ +[/============================================================================ + 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__ intersection] + +[heading_conformance_ogc __this_function__..Intersection] + +[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 of input (multi)polygons and/or boxes]] +] + +[include reference/algorithms/geometry_rules.qbk] + +[heading Example] +[intersection] +[intersection_output] + +[heading See also] +* [link geometry.reference.algorithms.union_ union] +* [link geometry.reference.algorithms.difference difference] +* [link geometry.reference.algorithms.sym_difference sym_difference (symmetric difference)] diff --git a/libs/geometry/doc/reference/algorithms/intersects.qbk b/libs/geometry/doc/reference/algorithms/intersects.qbk new file mode 100644 index 000000000..49aea2322 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/intersects.qbk @@ -0,0 +1,21 @@ +[/============================================================================ + 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__ intersects] + +[heading_conformance_ogc __this_function__..Intersects] +[? __one_parameter__ The version with one parameter is additional and not described in the OGC standard] + +[heading Examples] +[intersects_linestring] +[intersects_linestring_output] + diff --git a/libs/geometry/doc/reference/algorithms/length.qbk b/libs/geometry/doc/reference/algorithms/length.qbk new file mode 100644 index 000000000..c349f56e4 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/length.qbk @@ -0,0 +1,29 @@ +[/============================================================================ + 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__ length] + +[heading_conformance_ogc __this_function__..Length] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__0dim__][[qbk_ret 0]]] +[[__1dim__][[qbk_ret the length]]] +[[__2dim__][[qbk_ret 0]]] +] + + +[heading Complexity] +Linear + +[heading Examples] [/ filled by doxml2qbk] diff --git a/libs/geometry/doc/reference/algorithms/num_geometries.qbk b/libs/geometry/doc/reference/algorithms/num_geometries.qbk new file mode 100644 index 000000000..998d0b155 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/num_geometries.qbk @@ -0,0 +1,31 @@ +[/============================================================================ + 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__ num_geometries] + +[heading_conformance_ogc __this_function__..NumGeometries] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__single__][[qbk_ret 1]]] +[[__multi__][Returns boost::size(geometry); the input is considered as a range]] +] + + +[heading Complexity] +Constant + +[heading Examples] +[num_geometries] +[num_geometries_output] + diff --git a/libs/geometry/doc/reference/algorithms/num_interior_rings.qbk b/libs/geometry/doc/reference/algorithms/num_interior_rings.qbk new file mode 100644 index 000000000..abbe59e45 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/num_interior_rings.qbk @@ -0,0 +1,33 @@ +[/============================================================================ + 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__ num_interior_ring] + +[heading_conformance_ogc __this_function__..NumInteriorRing] +[note __boost_geometry__ adds an "s"] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__polygon__][[qbk_ret the number of its interior rings]]] +[[__multi_polygon__][[qbk_ret the number of the interior rings of all polygons]]] +[[__other__][[qbk_ret 0]]] +] + + +[heading Complexity] +Constant + +[heading Examples] +[num_interior_rings] +[num_interior_rings_output] + diff --git a/libs/geometry/doc/reference/algorithms/num_points.qbk b/libs/geometry/doc/reference/algorithms/num_points.qbk new file mode 100644 index 000000000..b59ea1b09 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/num_points.qbk @@ -0,0 +1,38 @@ +[/============================================================================ + 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__ 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] ] +[[__point__][[qbk_ret 1]]] +[[__segment__][[qbk_ret 2]]] +[[__box__][[qbk_ret 4]]] +[[__range__][[qbk_ret boost::size(geometry)]]] +[[__other__][[qbk_ret the sum of the number of points of its elements]]] +[[Open geometries][[qbk_ret the sum of the number of points of its elements, it adds one for open (per ring) if specified]]] +[[Closed geometries][[qbk_ret the sum of the number of points of its elements]]] +] + + +[heading Complexity] +Constant or Linear + +[heading Examples] +[num_points] +[num_points_output] + diff --git a/libs/geometry/doc/reference/algorithms/overlaps.qbk b/libs/geometry/doc/reference/algorithms/overlaps.qbk new file mode 100644 index 000000000..9f1a75265 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/overlaps.qbk @@ -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] diff --git a/libs/geometry/doc/reference/algorithms/perimeter.qbk b/libs/geometry/doc/reference/algorithms/perimeter.qbk new file mode 100644 index 000000000..66d924542 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/perimeter.qbk @@ -0,0 +1,31 @@ +[/============================================================================ + 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__ 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] ] +[[__0dim__][Returns zero]] +[[__1dim__][Returns zero]] +[[__2dim__][Returns the perimeter]] +] + + +[heading Complexity] +Linear diff --git a/libs/geometry/doc/reference/algorithms/reverse.qbk b/libs/geometry/doc/reference/algorithms/reverse.qbk new file mode 100644 index 000000000..282964e29 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/reverse.qbk @@ -0,0 +1,40 @@ +[/============================================================================ + 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__ reverse] + +[heading_conformance_no_ogc __this_function__] +[conformance_std __this_function__..std::__this_function__ function] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__point__][__does_nothing__]] +[[__segment__][__nyiversion__]] +[[__box__][__does_nothing__]] +[[__linestring__][Reverses the __linestring__]] +[[__ring__][Reverses the __ring__]] +[[__polygon__][Reverses the exterior ring and all interior rings in the polygon]] +[[__multi_point__][__does_nothing__]] +[[__multi_linestring__][Reverses all contained linestrings individually]] +[[__multi_polygon__][Reverses all contained polygons individually]] +] + +[note The reverse of a (multi)polygon or ring might make a valid geometry invalid because the (counter)clockwise orientation reverses.] + +[heading Complexity] +Linear + +[heading Example] +[reverse] +[reverse_output] + diff --git a/libs/geometry/doc/reference/algorithms/simplify.qbk b/libs/geometry/doc/reference/algorithms/simplify.qbk new file mode 100644 index 000000000..9d0b718bd --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/simplify.qbk @@ -0,0 +1,35 @@ +[/============================================================================ + 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__ 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] + +[heading Image(s)] +[$svg_simplify_country.png] diff --git a/libs/geometry/doc/reference/algorithms/simplify_inserter.qbk b/libs/geometry/doc/reference/algorithms/simplify_inserter.qbk new file mode 100644 index 000000000..ca29cabd8 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/simplify_inserter.qbk @@ -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 Examples] +[simplify_inserter] +[simplify_inserter_output] + diff --git a/libs/geometry/doc/reference/algorithms/sym_difference.qbk b/libs/geometry/doc/reference/algorithms/sym_difference.qbk new file mode 100644 index 000000000..549f077ae --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/sym_difference.qbk @@ -0,0 +1,29 @@ +[/============================================================================ + 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__ sym_difference] + +[heading_conformance_ogc __this_function__..SymDifference] + +[include reference/algorithms/difference_behavior.qbk] + +[include reference/algorithms/geometry_rules.qbk] + +[heading Example] +[sym_difference] +[sym_difference_output] + +[heading See also] +* [link geometry.reference.algorithms.difference difference] +* [link geometry.reference.algorithms.intersection intersection] +* [link geometry.reference.algorithms.union_ union] + diff --git a/libs/geometry/doc/reference/algorithms/touches.qbk b/libs/geometry/doc/reference/algorithms/touches.qbk new file mode 100644 index 000000000..56e502c93 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/touches.qbk @@ -0,0 +1,19 @@ +[/============================================================================ + 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__ touches] + +[heading_conformance_ogc __this_function__..Touches] +[? __one_parameter__ The version with one parameter is additional and not described in the OGC standard] + +[note only implemented for polygon/multi_polygon] + diff --git a/libs/geometry/doc/reference/algorithms/transform.qbk b/libs/geometry/doc/reference/algorithms/transform.qbk new file mode 100644 index 000000000..6b404b117 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/transform.qbk @@ -0,0 +1,32 @@ +[/============================================================================ + 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__ transform] + +[heading_conformance_no_ogc __this_function__] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__sph__ (degree) / __sph__ (radian)][Transforms coordinates from degree to radian, or vice versa]] +[[__sph__ / __cart__ (3D)][Transforms coordinates from spherical coordinates to X,Y,Z, or vice versa, on a unit sphere]] +[[__sph__ (degree, with radius) / __sph__ (radian, with radius)][Transforms coordinates from degree to radian, or vice versa. Third coordinate (radius) is untouched]] +[[__sph__ (with radius) / __cart__ (3D)][Transforms coordinates from spherical coordinates to X,Y,Z, or vice versa, on a unit sphere. Third coordinate (radius) is taken into account]] +] + +[heading Complexity] +Linear + +[heading Example] +[transform] +[transform_output] + diff --git a/libs/geometry/doc/reference/algorithms/transform_with_strategy.qbk b/libs/geometry/doc/reference/algorithms/transform_with_strategy.qbk new file mode 100644 index 000000000..a393e7894 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/transform_with_strategy.qbk @@ -0,0 +1,19 @@ +[/============================================================================ + 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 Complexity] +Linear + +[heading Example] +[transform_with_strategy] +[transform_with_strategy_output] + diff --git a/libs/geometry/doc/reference/algorithms/union.qbk b/libs/geometry/doc/reference/algorithms/union.qbk new file mode 100644 index 000000000..0a7a1099a --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/union.qbk @@ -0,0 +1,33 @@ +[/============================================================================ + 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__ union] + +[heading_conformance_ogc __this_function__..Union] +[note __boost_geometry__ adds an underscore to avoid using the `union` keyword] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[[qbk_out __polygon__]][Calculates union polygons of input (multi)polygons and/or boxes]] +] + +[include reference/algorithms/geometry_rules.qbk] + +[heading Example] +[union] +[union_output] + +[heading See also] +* [link geometry.reference.algorithms.intersection intersection] +* [link geometry.reference.algorithms.difference difference] +* [link geometry.reference.algorithms.sym_difference sym_difference (symmetric difference)] diff --git a/libs/geometry/doc/reference/algorithms/unique.qbk b/libs/geometry/doc/reference/algorithms/unique.qbk new file mode 100644 index 000000000..92144dbf1 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/unique.qbk @@ -0,0 +1,39 @@ +[/============================================================================ + 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 __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 +[[Case] [Behavior] ] +[[__point__][__does_nothing__]] +[[__segment__][__does_nothing__]] +[[__box__][__does_nothing__]] +[[__linestring__][__applies_unique__]] +[[__ring__][__applies_unique__]] +[[__polygon__][__applies_unique__ in all rings]] +[[__multi_point__][__does_nothing__. Even if two equal points happen to be stored consecutively, they are kept]] +[[__multi_linestring__][__applies_unique__ in all contained linestrings]] +[[__multi_polygon__][__applies_unique__ in all contained polygons (all rings)]] +] + +[heading Complexity] +Linear + +[heading Example] +[unique] +[unique_output] + diff --git a/libs/geometry/doc/reference/algorithms/within.qbk b/libs/geometry/doc/reference/algorithms/within.qbk new file mode 100644 index 000000000..db63e07e3 --- /dev/null +++ b/libs/geometry/doc/reference/algorithms/within.qbk @@ -0,0 +1,35 @@ +[/============================================================================ + 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__ 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 + within a polygon, but not vice versa.] + +[heading Notes] +If a point is located exactly on the border of a geometry, the result depends on the strategy. +The default strategy ([link geometry.reference.strategies.strategy_within_winding Winding (coordinate system agnostic)]) +returns false in that case. + +If a polygon has a reverse oriented (e.g. counterclockwise for a clockwise typed polygon), the result also depends on the strategy. +The default strategy returns still true if a point is completely within the reversed polygon. There is a specific strategy which returns false in this case. + +[heading Complexity] +Linear + +[heading See also] +* [link geometry.reference.algorithms.covered_by covered_by] diff --git a/libs/geometry/doc/reference/core/closure.qbk b/libs/geometry/doc/reference/core/closure.qbk new file mode 100644 index 000000000..759c413cf --- /dev/null +++ b/libs/geometry/doc/reference/core/closure.qbk @@ -0,0 +1,23 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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) +=============================================================================/] + +[note The closure is defined for any geometry type, but only has a real meaning + for areal geometry types (ring, polygon, multi_polygon) +] + +[heading Complexity] +Compile time + +[heading Example] +[closure] +[closure_output] + +[heading See also] +* [link geometry.reference.enumerations.closure_selector The closure_selector enumeration] diff --git a/libs/geometry/doc/reference/core/coordinate_dimension.qbk b/libs/geometry/doc/reference/core/coordinate_dimension.qbk new file mode 100644 index 000000000..b7e8cfce8 --- /dev/null +++ b/libs/geometry/doc/reference/core/coordinate_dimension.qbk @@ -0,0 +1,16 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Complexity] +Compile time + +[heading Example] +[dimension] +[dimension_output] diff --git a/libs/geometry/doc/reference/core/coordinate_system.qbk b/libs/geometry/doc/reference/core/coordinate_system.qbk new file mode 100644 index 000000000..b64af3afe --- /dev/null +++ b/libs/geometry/doc/reference/core/coordinate_system.qbk @@ -0,0 +1,16 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Complexity] +Compile time + +[heading Example] +[coordinate_system] +[coordinate_system_output] diff --git a/libs/geometry/doc/reference/core/coordinate_type.qbk b/libs/geometry/doc/reference/core/coordinate_type.qbk new file mode 100644 index 000000000..1e7512307 --- /dev/null +++ b/libs/geometry/doc/reference/core/coordinate_type.qbk @@ -0,0 +1,16 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Complexity] +Compile time + +[heading Example] +[coordinate_type] +[coordinate_type_output] diff --git a/libs/geometry/doc/reference/core/degree_radian.qbk b/libs/geometry/doc/reference/core/degree_radian.qbk new file mode 100644 index 000000000..09e24078f --- /dev/null +++ b/libs/geometry/doc/reference/core/degree_radian.qbk @@ -0,0 +1,14 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 example] +[degree_radian] +[degree_radian_output]
\ No newline at end of file diff --git a/libs/geometry/doc/reference/core/get_box.qbk b/libs/geometry/doc/reference/core/get_box.qbk new file mode 100644 index 000000000..e279b4024 --- /dev/null +++ b/libs/geometry/doc/reference/core/get_box.qbk @@ -0,0 +1,23 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Behavior] +[table +[[Case] [Behavior] ] +[[__box__][Returns the coordinate of a box (use min_corner, max_corner to specify which of the points to get) ]] +[[__segment__][Returns the coordinate of a segment (use 0, 1 to specify which of the two points to get) ]] +] + +[heading Complexity] +Constant + +[heading Example] +[get_box] +[get_box_output] diff --git a/libs/geometry/doc/reference/core/get_point.qbk b/libs/geometry/doc/reference/core/get_point.qbk new file mode 100644 index 000000000..a3eb0e3c7 --- /dev/null +++ b/libs/geometry/doc/reference/core/get_point.qbk @@ -0,0 +1,25 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Behavior] +[table +[[Case] [Behavior] ] +[[__point__][Returns the coordinate of a point]] +[[Circle or Sphere][Returns the coordinate of the center of a circle or sphere (currently in an extension)]] +[[__sph__][Returns the coordinate of a point, in either Radian's or Degree's, depending on specified units]] +] + +[heading Complexity] +Constant + +[heading Example] +[get_point] +[get_point_output] diff --git a/libs/geometry/doc/reference/core/interior_type.qbk b/libs/geometry/doc/reference/core/interior_type.qbk new file mode 100644 index 000000000..c7549738b --- /dev/null +++ b/libs/geometry/doc/reference/core/interior_type.qbk @@ -0,0 +1,17 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Complexity] +Compile time + +[heading Example] +[interior_type] +[interior_type_output] diff --git a/libs/geometry/doc/reference/core/max_corner.qbk b/libs/geometry/doc/reference/core/max_corner.qbk new file mode 100644 index 000000000..1d56590ec --- /dev/null +++ b/libs/geometry/doc/reference/core/max_corner.qbk @@ -0,0 +1,26 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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) +=============================================================================/] + +[section:max_corner max_corner] + +Indicates the maximal corner (upper right) of a box to be get, set or processed + +[heading Synopsis] +`` int const max_corner = 1; `` + +[include reference/core/min_max_corner.qbk] + +[heading See also] +* [link geometry.reference.constants.min_corner min_corner] +* [link geometry.reference.access.get.get_1_with_index get with index] +* [link geometry.reference.access.set.set_2_with_index set with index] + +[endsect] + diff --git a/libs/geometry/doc/reference/core/min_corner.qbk b/libs/geometry/doc/reference/core/min_corner.qbk new file mode 100644 index 000000000..a169b0475 --- /dev/null +++ b/libs/geometry/doc/reference/core/min_corner.qbk @@ -0,0 +1,25 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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) +=============================================================================/] + +[section:min_corner min_corner] + +Indicates the minimal corner (lower left) of a box to be get, set or processed + +[heading Synopsis] +`` int const min_corner = 0; `` + +[include reference/core/min_max_corner.qbk] + +[heading See also] +* [link geometry.reference.constants.max_corner max_corner] +* [link geometry.reference.access.get.get_1_with_index get with index] +* [link geometry.reference.access.set.set_2_with_index set with index] + +[endsect] diff --git a/libs/geometry/doc/reference/core/min_max_corner.qbk b/libs/geometry/doc/reference/core/min_max_corner.qbk new file mode 100644 index 000000000..704197093 --- /dev/null +++ b/libs/geometry/doc/reference/core/min_max_corner.qbk @@ -0,0 +1,31 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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) +=============================================================================/] + +[/File included by min_corner.qbk and max_corner.qbk] + +[heading Header] +Either + +`#include <boost/geometry/geometry.hpp>` + +Or + +`#include <boost/geometry/core/access.hpp>` + +[note min_corner and max_corner are only applicable for boxes and not for, + e.g., a segment] +[note min_corner should be the minimal corner of a box, but that is not + guaranteed. Use correct to make min_corner the minimal corner. + The same applies for max_corner.] + +[/Share sample with get_box] +[heading Example] +[get_box] +[get_box_output] diff --git a/libs/geometry/doc/reference/core/point_order.qbk b/libs/geometry/doc/reference/core/point_order.qbk new file mode 100644 index 000000000..84d967ee1 --- /dev/null +++ b/libs/geometry/doc/reference/core/point_order.qbk @@ -0,0 +1,24 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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) +=============================================================================/] + +[note The point order is defined for any geometry type, but only has a real meaning + for areal geometry types (ring, polygon, multi_polygon) +] + +[heading Complexity] +Compile time + +[heading Example] +[point_order] +[point_order_output] + +[heading See also] +* [link geometry.reference.enumerations.order_selector The order_selector enumeration] + diff --git a/libs/geometry/doc/reference/core/point_type.qbk b/libs/geometry/doc/reference/core/point_type.qbk new file mode 100644 index 000000000..d51d5e92c --- /dev/null +++ b/libs/geometry/doc/reference/core/point_type.qbk @@ -0,0 +1,17 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Complexity] +Compile time + +[heading Example] +[point_type] +[point_type_output] diff --git a/libs/geometry/doc/reference/core/ring_type.qbk b/libs/geometry/doc/reference/core/ring_type.qbk new file mode 100644 index 000000000..f40a26cb6 --- /dev/null +++ b/libs/geometry/doc/reference/core/ring_type.qbk @@ -0,0 +1,17 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Complexity] +Compile time + +[heading Example] +[ring_type] +[ring_type_output] diff --git a/libs/geometry/doc/reference/core/set_box.qbk b/libs/geometry/doc/reference/core/set_box.qbk new file mode 100644 index 000000000..5e944b9b2 --- /dev/null +++ b/libs/geometry/doc/reference/core/set_box.qbk @@ -0,0 +1,23 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Behavior] +[table +[[Case] [Behavior] ] +[[__box__][Sets the coordinate of a box (use min_corner, max_corner to specify which of the points to set) ]] +[[__segment__][Sets the coordinate of a segment (use 0, 1 to specify which of the two points to set) ]] +] + +[heading Complexity] +Constant + +[heading Example] +[set_box] +[set_box_output] diff --git a/libs/geometry/doc/reference/core/set_point.qbk b/libs/geometry/doc/reference/core/set_point.qbk new file mode 100644 index 000000000..ceab83853 --- /dev/null +++ b/libs/geometry/doc/reference/core/set_point.qbk @@ -0,0 +1,26 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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) +=============================================================================/] + +[note If you host both the std:: library namespace and boost::geometry:: namespace set might become ambiguous, std::set is a collection. So don't do that or refer to geometry::set then explicitly.] + +[heading Behavior] +[table +[[Case] [Behavior] ] +[[__point__][Sets the coordinate of a point]] +[[Circle or Sphere][Sets the coordinate of the center of a circle or sphere (currently in an extension)]] +[[__sph__][Sets the coordinate of a point, in either Radian's or Degree's, depending on specified units]] +] + +[heading Complexity] +Constant + +[heading Example] +[set_point] +[set_point_output] diff --git a/libs/geometry/doc/reference/core/tag.qbk b/libs/geometry/doc/reference/core/tag.qbk new file mode 100644 index 000000000..fc3089d53 --- /dev/null +++ b/libs/geometry/doc/reference/core/tag.qbk @@ -0,0 +1,29 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Metafunction result type] +The metafunction tag defines [*type] as one of the following tags: + +* point_tag +* linestring_tag +* polygon_tag +* multi_point_tag +* multi_linestring_tag +* multi_polygon_tag +* box_tag +* segment_tag +* ring_tag + +[heading Complexity] +Compile time + +[heading Example] +[tag] +[tag_output] diff --git a/libs/geometry/doc/reference/core/tag_cast.qbk b/libs/geometry/doc/reference/core/tag_cast.qbk new file mode 100644 index 000000000..7ad1bf339 --- /dev/null +++ b/libs/geometry/doc/reference/core/tag_cast.qbk @@ -0,0 +1,26 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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) +=============================================================================/] + +[note The specified tag list is handled in the specified order: as soon as a tag + inheriting the specified tag is found, it is defined as the metafunction + typedef [*type]. +] + +[note If none of the specified possible base tags is a base class of the + specified tag, the tag itself is defined as the [*type] result of the + metafunction. +] +[heading Complexity] +Compile time + +[heading Example] +[tag_cast] +[tag_cast_output] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_array.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_array.qbk new file mode 100644 index 000000000..c2a95998b --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_array.qbk @@ -0,0 +1,38 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:boost_array Boost.Array] + +Boost.Array arrays are adapted to the Boost.Geometry point concept + +[heading Description] + +A boost::array is (optionally) adapted to the Boost.Geometry +point concept. It can therefore be used in all Boost.Geometry algorithms. + +A boost::array can be the point type used by the models linestring, polygon, segment, +box, and ring + +[heading Model of] +[link geometry.reference.concepts.concept_point Point Concept] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_array.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_array] +[boost_array_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_fusion.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_fusion.qbk new file mode 100644 index 000000000..b54352dae --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_fusion.qbk @@ -0,0 +1,35 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:boost_fusion Boost.Fusion] + +Boost.Fusion adapted structs or classes are adapted to the Boost.Geometry point concept + +[heading Description] + +Boost.Fusion adapted structs are (optionally) adapted to the Boost.Geometry +point concept. They can therefore be used in many Boost.Geometry algorithms. + +[heading Model of] +[link geometry.reference.concepts.concept_point Point Concept] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_fusion.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_fusion] +[boost_fusion_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_polygon/point_data.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_polygon/point_data.qbk new file mode 100644 index 000000000..ff013ed17 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_polygon/point_data.qbk @@ -0,0 +1,36 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:point_data Boost.Polygon's point_data] + +The Boost.Polygon point type (boost::polygon::point_data) is adapted to the Boost.Geometry Point Concept. + +[heading Description] + +Boost.Polygon's points (as well as polygons) can be used by Boost.Geometry. The +two libraries can therefore be used together. Using a boost::polygon::point_data<...>, +algorithms from both Boost.Polygon and Boost.Geometry can be called. + +[heading Model of] +[link geometry.reference.concepts.concept_point Point Concept] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_polygon.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_polygon] +[boost_polygon_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_polygon/polygon_data.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_polygon/polygon_data.qbk new file mode 100644 index 000000000..e37628cb2 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_polygon/polygon_data.qbk @@ -0,0 +1,36 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:polygon_data Boost.Polygon's polygon_data] + +Boost.Polygon's polygon type (boost::polygon::polygon_data) is adapted to the Boost.Geometry Ring Concept. + +[heading Description] + +Boost.Polygon's points (as well as polygons) can be used by Boost.Geometry. The +two libraries can therefore be used together. Using a boost::polygon::point_data<...>, +algorithms from both Boost.Polygon and Boost.Geometry can be called. + +[heading Model of] +[link geometry.reference.concepts.concept_ring Ring Concept] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_polygon.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_polygon] +[boost_polygon_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_polygon/polygon_with_holes_data.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_polygon/polygon_with_holes_data.qbk new file mode 100644 index 000000000..52655a6f2 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_polygon/polygon_with_holes_data.qbk @@ -0,0 +1,37 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:polygon_with_holes_data Boost.Polygon's polygon_with_holes_data] + +Boost.Polygon's polygon type supporting holes (boost::polygon::polygon_with_holes_data) +is adapted to the Boost.Geometry Polygon Concept. + +[heading Description] + +Boost.Polygon's points (as well as polygons) can be used by Boost.Geometry. The +two libraries can therefore be used together. Using a boost::polygon::point_data<...>, +algorithms from both Boost.Polygon and Boost.Geometry can be called. + +[heading Model of] +[link geometry.reference.concepts.concept_polygon Polygon Concept] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_polygon.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_polygon] +[boost_polygon_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_polygon/rectangle_data.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_polygon/rectangle_data.qbk new file mode 100644 index 000000000..48b80416d --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_polygon/rectangle_data.qbk @@ -0,0 +1,36 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:rectangle_data Boost.Polygon's rectangle_data] + +Boost.Polygon's rectangle type (boost::polygon::rectangle_data) is adapted to the Boost.Geometry Point Concept. + +[heading Description] + +Boost.Polygon's points (as well as polygons) can be used by Boost.Geometry. The +two libraries can therefore be used together. Using a boost::polygon::point_data<...>, +algorithms from both Boost.Polygon and Boost.Geometry can be called. + +[heading Model of] +[link geometry.reference.concepts.concept_box Box Concept] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_polygon.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_polygon] +[boost_polygon_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_range/adapts_model.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_range/adapts_model.qbk new file mode 100644 index 000000000..47e35e032 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_range/adapts_model.qbk @@ -0,0 +1,19 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +The __adaptor__ takes over the model of the original geometry, which might be: + +* a linestring +* a ring +* a multi_point +* a multi_linestring +* a multi_polygon diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_range/filtered.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_range/filtered.qbk new file mode 100644 index 000000000..c101b1d27 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_range/filtered.qbk @@ -0,0 +1,36 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:filtered Boost.Range filtered] + +[def __adaptor__ Boost.Range filtered range adaptor] + +__adaptor__ is adapted to Boost.Geometry + +[heading Description] + +__adaptor__ filters a range. + +[heading Model of] +[include adapts_model.qbk] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_range/filtered.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_range_filtered] +[boost_range_filtered_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_range/reversed.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_range/reversed.qbk new file mode 100644 index 000000000..56121f31c --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_range/reversed.qbk @@ -0,0 +1,36 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:reversed Boost.Range reversed] + +[def __adaptor__ Boost.Range reversed range adaptor] + +__adaptor__ is adapted to Boost.Geometry + +[heading Description] + +__adaptor__ reverses a range. + +[heading Model of] +[include adapts_model.qbk] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_range/reversed.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_range_reversed] +[boost_range_reversed_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_range/sliced.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_range/sliced.qbk new file mode 100644 index 000000000..9acf41753 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_range/sliced.qbk @@ -0,0 +1,36 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:sliced Boost.Range sliced] + +[def __adaptor__ Boost.Range sliced range adaptor] + +__adaptor__ is adapted to Boost.Geometry + +[heading Description] + +__adaptor__ creates a slice of a range (usually a linestring) + +[heading Model of] +[include adapts_model.qbk] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_range/sliced.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_range_sliced] +[boost_range_sliced_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_range/strided.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_range/strided.qbk new file mode 100644 index 000000000..911941ebe --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_range/strided.qbk @@ -0,0 +1,37 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:strided Boost.Range strided] + +[def __adaptor__ Boost.Range strided range adaptor] + +__adaptor__ is adapted to Boost.Geometry + +[heading Description] + +__adaptor__ makes a strided range (usually begin a linestring or ring) such that +traversal is performed in steps of n. + +[heading Model of] +[include adapts_model.qbk] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_range/strided.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_range_strided] +[boost_range_strided_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_range/uniqued.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_range/uniqued.qbk new file mode 100644 index 000000000..48621370c --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_range/uniqued.qbk @@ -0,0 +1,36 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:uniqued Boost.Range uniqued] + +[def __adaptor__ Boost.Range uniqued range adaptor] + +__adaptor__ is adapted to Boost.Geometry + +[heading Description] + +__adaptor__ makes a range unique + +[heading Model of] +[include adapts_model.qbk] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_range/uniqued.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_range_uniqued] +[boost_range_uniqued_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/boost_tuple.qbk b/libs/geometry/doc/reference/geometries/adapted/boost_tuple.qbk new file mode 100644 index 000000000..a49124382 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/boost_tuple.qbk @@ -0,0 +1,47 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:boost_tuple Boost.Tuple] + +Boost.Tuple tuples with arithmetic elements can be used as +points within Boost.Geometry + +[heading Description] + +Boost.Tuple fixed sized collections, such as boost::tuple<double, double>, are +(optionally) adapted to the Boost.Geometry point concept. + +Boost.Tuple pairs or triples might have mutually different types, such as a +boost::tuple<float, double>. Boost.Geometry reports the first type as its +[link geometry.reference.core.coordinate_type coordinate_type]. + +Boost.Geometry supports Boost.Tuple pairs, triples, quadruples, etc up to +tuples with 10 elements (though most algorithms do not support so many +dimensions). + +A tuple can be the point type used by the models linestring, polygon, segment, +box, and ring + +[heading Model of] +[link geometry.reference.concepts.concept_point Point Concept] + +[heading Header] +`#include <boost/geometry/geometries/adapted/boost_tuple.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[boost_tuple] +[boost_tuple_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/adapted/c_array.qbk b/libs/geometry/doc/reference/geometries/adapted/c_array.qbk new file mode 100644 index 000000000..221c55ff0 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/adapted/c_array.qbk @@ -0,0 +1,40 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2008-2012 Bruno Lalande, Paris, France. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + + 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) +=============================================================================/] + +[section:c_array C array] + +C arrays are adapted to the Boost.Geometry point concept + +[heading Description] + +C arrays, such as double[2] or int[3], are (optionally) adapted to the Boost.Geometry +point concept. They can therefore be used in many Boost.Geometry algorithms. + +Note that a C array cannot be the point type of a linestring or a polygon. The reason +for that is that a std::vector does not allow containing C arrays +(this is not related to Boost.Geometry). The C array is therefore limited to +the point type. + +[heading Model of] +[link geometry.reference.concepts.concept_point Point Concept] + +[heading Header] +`#include <boost/geometry/geometries/adapted/c_array.hpp>` + +__not_in_boost_geometry_hpp__ + +[heading Example] +[c_array] +[c_array_output] + +[endsect] + diff --git a/libs/geometry/doc/reference/geometries/point.qbk b/libs/geometry/doc/reference/geometries/point.qbk new file mode 100644 index 000000000..0d756a2b7 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/point.qbk @@ -0,0 +1,18 @@ +[/============================================================================ + 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 Examples] +[point] +[point_output] + +[include reference/geometries/point_assign_warning.qbk] + diff --git a/libs/geometry/doc/reference/geometries/point_assign_warning.qbk b/libs/geometry/doc/reference/geometries/point_assign_warning.qbk new file mode 100644 index 000000000..0ab0bc6c7 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/point_assign_warning.qbk @@ -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] diff --git a/libs/geometry/doc/reference/geometries/register/point.qbk b/libs/geometry/doc/reference/geometries/register/point.qbk new file mode 100644 index 000000000..9132d4996 --- /dev/null +++ b/libs/geometry/doc/reference/geometries/register/point.qbk @@ -0,0 +1,17 @@ +[/============================================================================ + 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) +=============================================================================/] + +[caution Use the macro outside any namespace] +[note A point can include a namespace] +[heading Examples] +[register_point_2d] +[register_point_2d_output] diff --git a/libs/geometry/doc/reference/io/svg.qbk b/libs/geometry/doc/reference/io/svg.qbk new file mode 100644 index 000000000..be76303d3 --- /dev/null +++ b/libs/geometry/doc/reference/io/svg.qbk @@ -0,0 +1,16 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Example] +[svg_mapper] +[svg_mapper_output] + +[heading See also] +* [link geometry.reference.io.svg.svg The SVG manipulator] diff --git a/libs/geometry/doc/reference/views/box_view.qbk b/libs/geometry/doc/reference/views/box_view.qbk new file mode 100644 index 000000000..cd3949175 --- /dev/null +++ b/libs/geometry/doc/reference/views/box_view.qbk @@ -0,0 +1,16 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Complexity] +Compile time + +[heading Example] +[box_view] +[box_view_output] diff --git a/libs/geometry/doc/reference/views/segment_view.qbk b/libs/geometry/doc/reference/views/segment_view.qbk new file mode 100644 index 000000000..2b1e6ca14 --- /dev/null +++ b/libs/geometry/doc/reference/views/segment_view.qbk @@ -0,0 +1,16 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + + 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 Complexity] +Compile time + +[heading Example] +[segment_view] +[segment_view_output] |