boost_mirror/geometry
1
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2025-05-11 13:34:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc update, added strategies, metafunctions, iterators, ranges (only structure update, not textual)

Browse Source 
[SVN r67552]
This commit is contained in:
Barend Gehrels 2011-01-01 21:54:15 +00:00
parent 3ad7294c9c
commit a90c89682e
50 changed files with 2070 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/doxy/doxygen_input/groups/groups.hpp
View File

@ -17,6 +17,11 @@
\defgroup clear clear: clear geometries
*/
/*!
\defgroup correct correct: correct geometries
*/
/*!
\defgroup get get: get geometries
*/
@ -44,3 +49,11 @@
/*!
\defgroup interior_rings interior_rings: interior_rings
*/
/*!
\defgroup ranges ranges: ranges
*/
/*!
\defgroup strategies strategies: strategies
*/

19
doc/introduction.qbk
View File

@ -1,12 +1,15 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 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)
=============================================================================/]
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 Introduction]

59
doc/make_qbk.py
View File

@ -27,11 +27,24 @@ def group_to_quickbook(section):
def model_to_quickbook(classname, section):
os.system(cmd % ("classboost_1_1geometry_1_1model_1_1" + classname, section))
def struct_to_quickbook(section):
os.system(cmd % ("structboost_1_1geometry_1_1" + section.replace("_", "__"), section))
def class_to_quickbook(section):
os.system(cmd % ("classboost_1_1geometry_1_1" + section.replace("_", "__"), section))
def strategy_to_quickbook(section):
p = section.find("::")
ns = section[:p]
strategy = section[p+2:]
os.system(cmd % ("classboost_1_1geometry_1_1strategy_1_1"
+ ns.replace("_", "__") + "_1_1" + strategy.replace("_", "__"),
ns + "_" + strategy))
call_doxygen()
algorithms = ["append", "assign", "make", "clear"
, "area", "buffer", "centroid", "combine", "convert"
, "area", "buffer", "centroid", "combine", "convert", "correct"
, "convex_hull", "difference", "disjoint", "dissolve", "distance"
, "envelope", "equals", "for_each", "intersection", "intersects"
, "length", "num_geometries", "num_interior_rings", "num_points"
@ -39,12 +52,53 @@ algorithms = ["append", "assign", "make", "clear"
, "transform", "union", "unique", "within"]
access_functions = ["get", "set", "exterior_ring", "interior_rings"
, "num_points", "num_interior_rings", "num_geometries"]
core = ["closure", "coordinate_system", "coordinate_type", "cs_tag"
, "dimension", "exception", "geometry_id", "interior_type"
, "is_areal", "is_linear", "is_multi", "is_radian", "point_order"
, "point_type", "ring_type", "tag", "topological_dimension" ]
iterators = ["box_iterator", "circular_iterator", "closing_iterator"
, "ever_circling_iterator", "segment_range_iterator"]
ranges = ["box_range", "segment_range"];
views = ["closeable_view", "reversible_view", "identity_view"]
strategies = ["distance::pythagoras", "distance::haversine"
, "distance::cross_track", "distance::projected_point"
, "within::winding", "within::franklin", "within::crossings_multiply"
, "area::by_triangles", "area::huiller"
, "centroid::bashein_detmer"
, "convex_hull::graham_andrew"
, "simplify::douglas_peucker"
, "side::side_by_triangle", "side::side_by_cross_track"
, "transform::inverse_transformer", "transform::map_transformer"
, "transform::rotate_transformer", "transform::scale_transformer"
, "transform::translate_transformer", "transform::ublas_transformer"
]
for a in algorithms:
group_to_quickbook(a)
for a in access_functions:
group_to_quickbook(a)
for a in core:
struct_to_quickbook(a)
for a in iterators:
struct_to_quickbook(a)
for a in views:
struct_to_quickbook(a)
for a in ranges:
class_to_quickbook(a)
for a in strategies:
strategy_to_quickbook(a)
group_to_quickbook("arithmetic")
group_to_quickbook("register")
@ -62,7 +116,4 @@ model_to_quickbook("linear__ring", "ring")
model_to_quickbook("referring__segment", "referring_segment")
#model_to_quickbook("structboost_1_1geometry_1_1closing__iterator", "closing_iterator")
os.system("bjam")

167
doc/quickref.xml
View File

@ -2,12 +2,16 @@
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"../../../tools/boostbook/dtd/boostbook.dtd">
<!--
Copyright (c) 2010 Mateusz Loskot (mateusz at loskot dot net)
Boost.Geometry (aka GGL, Generic Geometry Library)
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 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)
-->
<informaltable frame="all">
@ -127,22 +131,26 @@
<entry valign="top">
<bridgehead renderas="sect3">Metafunctions</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.cs_tag">cs_tag</link></member>
<member><link linkend="geometry.reference.coordinate_type">coordinate_type</link></member>
<member><link linkend="geometry.reference.coordinate_system">coordinate_system</link></member>
<member><link linkend="geometry.reference.dimension">dimension</link></member>
<member><link linkend="geometry.reference.geometry_id">geometry_id</link></member>
<member><link linkend="geometry.reference.interior_type">interior_type</link></member>
<member><link linkend="geometry.reference.is_linear">is_linear</link></member>
<member><link linkend="geometry.reference.is_multi">is_multi</link></member>
<member><link linkend="geometry.reference.is_radian">is_radian</link></member>
<member><link linkend="geometry.reference.point_order">point_order</link></member>
<member><link linkend="geometry.reference.point_type">point_type</link></member>
<member><link linkend="geometry.reference.ring_type">ring_type</link></member>
<member><link linkend="geometry.reference.replace_point_type">replace_point_type</link></member>
<member><link linkend="geometry.reference.reverse_dispatch">reverse_dispatch</link></member>
<member><link linkend="geometry.reference.tag">tag</link></member>
<member><link linkend="geometry.reference.topological_dimension">topological_dimension</link></member>
<member><link linkend="geometry.reference.core.cs_tag">cs_tag</link></member>
<member><link linkend="geometry.reference.core.coordinate_type">coordinate_type</link></member>
<member><link linkend="geometry.reference.core.coordinate_system">coordinate_system</link></member>
<member><link linkend="geometry.reference.core.dimension">dimension</link></member>
<member><link linkend="geometry.reference.core.geometry_id">geometry_id</link></member>
<member><link linkend="geometry.reference.core.interior_type">interior_type</link></member>
<!-- will be replaced by tag inheritance
<member><link linkend="geometry.reference.core.is_linear">is_linear</link></member>
<member><link linkend="geometry.reference.core.is_multi">is_multi</link></member>
-->
<member><link linkend="geometry.reference.core.is_radian">is_radian</link></member>
<member><link linkend="geometry.reference.core.point_order">point_order</link></member>
<member><link linkend="geometry.reference.core.point_type">point_type</link></member>
<member><link linkend="geometry.reference.core.ring_type">ring_type</link></member>
<!-- for internal use only (detail?)
<member><link linkend="geometry.reference.core.replace_point_type">replace_point_type</link></member>
<member><link linkend="geometry.reference.core.reverse_dispatch">reverse_dispatch</link></member>
-->
<member><link linkend="geometry.reference.core.tag">tag</link></member>
<member><link linkend="geometry.reference.core.topological_dimension">topological_dimension</link></member>
</simplelist>
</entry>
<entry valign="top">
@ -167,15 +175,19 @@
</tbody>
</tgroup>
<!-- ###### CONSTANTS ########################################################################## -->
<!-- ###### CONSTANTS / COORDINATE SYSTEMS ################################ -->
<tgroup cols="2">
<colspec colname="a"/>
<colspec colname="b"/>
<colspec colname="c"/>
<thead>
<row>
<entry valign="center" namest="a" nameend="b">
<bridgehead renderas="sect2">Constants</bridgehead>
</entry>
<entry valign="center" namest="b" nameend="c">
<bridgehead renderas="sect2">Coordinate Systems</bridgehead>
</entry>
</row>
</thead>
<tbody>
@ -195,27 +207,6 @@
<member><link linkend="geometry.reference.radian">radian</link></member>
</simplelist>
</entry>
</row>
</tbody>
</tgroup>
<!-- ###### COORDINATE SYSTEMS / ITERATORS ##################################################### -->
<tgroup cols="2">
<colspec colname="a"/>
<colspec colname="b"/>
<colspec colname="c"/>
<thead>
<row>
<entry valign="center" namest="a" nameend="a">
<bridgehead renderas="sect2">Coordinate Systems</bridgehead>
</entry>
<entry valign="center" namest="b" nameend="c">
<bridgehead renderas="sect2">Iterators</bridgehead>
</entry>
</row>
</thead>
<tbody>
<row>
<entry valign="top">
<bridgehead renderas="sect3">Classes</bridgehead>
<simplelist type="vert" columns="1">
@ -225,24 +216,42 @@
<member><link linkend="geometry.reference.cs__spherical">cs::spherical</link></member>
</simplelist>
</entry>
</row>
</tbody>
</tgroup>
<!-- ###### ITERATORS / RANGES ##################################################### -->
<tgroup cols="2">
<colspec colname="a"/>
<colspec colname="b"/>
<thead>
<row>
<entry valign="center" namest="a" nameend="a">
<bridgehead renderas="sect2">Iterators</bridgehead>
</entry>
<entry valign="center" namest="b" nameend="b">
<bridgehead renderas="sect2">Ranges</bridgehead>
</entry>
</row>
</thead>
<tbody>
<row>
<entry valign="top">
<bridgehead renderas="sect3">Metafunctions</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.range_type">range_type</link></member>
</simplelist>
<bridgehead renderas="sect3">Classes</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.circular_iterator">circular_iterator</link></member>
<member><link linkend="geometry.reference.ever_circling_iterator">ever_circling_iterator</link></member>
<member><link linkend="geometry.reference.one_section_segment_iterator">one_section_segment_iterator</link></member>
<member><link linkend="geometry.reference.section_iterator">section_iterator</link></member>
<member><link linkend="geometry.reference.segment_iterator">segment_iterator</link></member>
<member><link linkend="geometry.reference.iterators.closing_iterator">closing_iterator</link></member>
<member><link linkend="geometry.reference.iterators.circular_iterator">circular_iterator</link></member>
<member><link linkend="geometry.reference.iterators.ever_circling_iterator">ever_circling_iterator</link></member>
<member><link linkend="geometry.reference.iterators.box_iterator">one_section_segment_iterator</link></member>
<member><link linkend="geometry.reference.iterators.segment_range_iterator">segment_range_iterator</link></member>
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Functions</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.make_segment_iterator">make_segment_iterator</link></member>
<member><link linkend="geometry.reference.ranges.box_range">box_range</link></member>
<member><link linkend="geometry.reference.ranges.segment_range">segment_range</link></member>
<member><link linkend="geometry.reference.ranges.closeable_view">closeable_view</link></member>
<member><link linkend="geometry.reference.ranges.reversible_view">reversible_view</link></member>
<member><link linkend="geometry.reference.ranges.identity_view">identity_view</link></member>
</simplelist>
</entry>
</row>
@ -438,18 +447,15 @@
<entry valign="top">
<bridgehead renderas="sect3">Area</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.strategy_area">strategy_area</link></member>
<member><link linkend="geometry.reference.area_result">area_result</link></member>
<member><link linkend="geometry.reference.strategy__area__by_triangles">strategy::area::by_triangles</link></member>
<member><link linkend="geometry.reference.strategy__area__huiller">strategy::area::huiller</link></member>
<member><link linkend="geometry.reference.strategies.strategy_area_by_triangles">strategy::area::by_triangles</link></member>
<member><link linkend="geometry.reference.strategies.strategy_area_huiller">strategy::area::huiller</link></member>
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Centroid</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.strategy_centroid">strategy_centroid</link></member>
<member><link linkend="geometry.reference.strategy__centroid___bashein_detmer">strategy::centroid_::bashein_detmer</link></member>
<member><link linkend="geometry.reference.strategy__centroid___centroid_average">strategy::centroid_::centroid_average</link></member>
<member><link linkend="geometry.reference.strategies.strategy_centroid_bashein_detmer">strategy::centroid_::bashein_detmer</link></member>
<member><link linkend="geometry.reference.strategies.strategy_centroid_centroid_average">strategy::centroid_::centroid_average</link></member>
</simplelist>
</entry>
</row>
@ -457,10 +463,16 @@
<entry valign="top">
<bridgehead renderas="sect3">Distance</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.strategy__distance__projected_point">strategy::distance::projected_point</link></member>
<member><link linkend="geometry.reference.strategy__distance__pythagoras">strategy::distance::pythagoras</link></member>
<member><link linkend="geometry.reference.strategy__distance__cross_track">strategy::distance::cross_track</link></member>
<member><link linkend="geometry.reference.strategy__distance__haversine">strategy::distance::haversine</link></member>
<member><link linkend="geometry.reference.strategies.strategy_distance_projected_point">strategy::distance::projected_point</link></member>
<member><link linkend="geometry.reference.strategies.strategy_distance_pythagoras">strategy::distance::pythagoras</link></member>
<member><link linkend="geometry.reference.strategies.strategy_distance_cross_track">strategy::distance::cross_track</link></member>
<member><link linkend="geometry.reference.strategies.strategy_distance_haversine">strategy::distance::haversine</link></member>
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Convex Hull</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.strategies.strategy_convex_hull_graham_andrew">strategy::convex_hull::graham_andrew</link></member>
</simplelist>
</entry>
</row>
@ -468,15 +480,14 @@
<entry valign="top">
<bridgehead renderas="sect3">Side</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.strategy__side__course">strategy::side::course</link></member>
<member><link linkend="geometry.reference.strategy__side__side_by_triangle">strategy::side::side_by_triangle</link></member>
<member><link linkend="geometry.reference.strategy__side__side_by_cross_track">strategy::side::side_by_cross_track</link></member>
<member><link linkend="geometry.reference.strategies.strategy_side_side_by_triangle">strategy::side::side_by_triangle</link></member>
<member><link linkend="geometry.reference.strategies.strategy_side_side_by_cross_track">strategy::side::side_by_cross_track</link></member>
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Simplify</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.strategy__simplify__douglas_peucker">strategy::simplify::douglas_peucker</link></member>
<member><link linkend="geometry.reference.strategies.strategy_simplify_douglas_peucker">strategy::simplify::douglas_peucker</link></member>
</simplelist>
</entry>
</row>
@ -484,20 +495,20 @@
<entry valign="top">
<bridgehead renderas="sect3">Transform</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.strategy__transform__inverse_transformer">strategy::inverse_transformer</link></member>
<member><link linkend="geometry.reference.strategy__transform__map_transformer">strategy::map_transformer</link></member>
<member><link linkend="geometry.reference.strategy__transform__ublas_transformer">strategy::ublas_transformer</link></member>
<member><link linkend="geometry.reference.strategy__transform__translate_transformer">strategy::translate_transformer</link></member>
<member><link linkend="geometry.reference.strategy__transform__scale_transformer">strategy::scale_transformer</link></member>
<member><link linkend="geometry.reference.strategy__transform__rotate_transformer">strategy::rotate_transformer</link></member>
<member><link linkend="geometry.reference.strategies.strategy_transform_inverse_transformer">strategy::transform::inverse_transformer</link></member>
<member><link linkend="geometry.reference.strategies.strategy_transform_map_transformer">strategy::transform::map_transformer</link></member>
<member><link linkend="geometry.reference.strategies.strategy_transform_ublas_transformer">strategy::transform::ublas_transformer</link></member>
<member><link linkend="geometry.reference.strategies.strategy_transform_translate_transformer">strategy::transform::translate_transformer</link></member>
<member><link linkend="geometry.reference.strategies.strategy_transform_scale_transformer">strategy::transform::scale_transformer</link></member>
<member><link linkend="geometry.reference.strategies.strategy_transform_rotate_transformer">strategy::transform::rotate_transformer</link></member>
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Within</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.strategy__within__winding">strategy::winding</link></member>
<member><link linkend="geometry.reference.strategy__within__crossings_multiply">strategy::crossings_multiply</link></member>
<member><link linkend="geometry.reference.strategy__within__franklin">strategy::franklin</link></member>
<member><link linkend="geometry.reference.strategies.strategy_within_winding">strategy::winding</link></member>
<member><link linkend="geometry.reference.strategies.strategy_within_crossings_multiply">strategy::crossings_multiply</link></member>
<member><link linkend="geometry.reference.strategies.strategy_within_franklin">strategy::franklin</link></member>
</simplelist>
</entry>
</row>

18
doc/quickstart.qbk
View File

@ -1,12 +1,14 @@
[/==============================================================================
Copyright (c) 1995-2009 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2009 Bruno Lalande, Paris, France.
Copyright (c) 2009 Mateusz Loskot (mateusz@loskot.net)
[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
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)
===============================================================================/]
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 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)
=============================================================================/]
[section:quickstart Quick Start]

72
doc/reference.qbk
View File

@ -1,5 +1,38 @@
[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 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)
=============================================================================/]
[section:reference Reference]
[section:core Core Metafunctions]
[include reference/closure.qbk]
[include reference/coordinate_system.qbk]
[include reference/coordinate_type.qbk]
[include reference/cs_tag.qbk]
[include reference/dimension.qbk]
[include reference/exception.qbk]
[include reference/geometry_id.qbk]
[include reference/interior_type.qbk]
[include reference/is_areal.qbk]
[include reference/is_linear.qbk]
[include reference/is_multi.qbk]
[include reference/is_radian.qbk]
[include reference/point_order.qbk]
[include reference/point_type.qbk]
[include reference/ring_type.qbk]
[include reference/tag.qbk]
[include reference/topological_dimension.qbk]
[endsect] [/core metafunctions]
[section:algorithms Algorithms]
[section:area area]
@ -38,6 +71,9 @@
[include reference/convex_hull.qbk]
[endsect]
[include reference/correct.qbk]
[section:difference difference]
[include reference/difference.qbk]
[endsect]
@ -171,10 +207,46 @@
[include reference/register.qbk]
[endsect]
[section:strategies Strategies]
[include reference/distance_pythagoras.qbk]
[include reference/distance_haversine.qbk]
[include reference/distance_projected_point.qbk]
[include reference/distance_cross_track.qbk]
[include reference/area_by_triangles.qbk]
[include reference/area_huiller.qbk]
[include reference/centroid_bashein_detmer.qbk]
[include reference/convex_hull_graham_andrew.qbk]
[include reference/side_side_by_triangle.qbk]
[include reference/side_side_by_cross_track.qbk]
[include reference/simplify_douglas_peucker.qbk]
[include reference/transform_inverse_transformer.qbk]
[include reference/transform_map_transformer.qbk]
[include reference/transform_rotate_transformer.qbk]
[include reference/transform_scale_transformer.qbk]
[include reference/transform_translate_transformer.qbk]
[include reference/transform_ublas_transformer.qbk]
[include reference/within_winding.qbk]
[include reference/within_franklin.qbk]
[include reference/within_crossings_multiply.qbk]
[endsect]
[section:iterators Iterators]
[include reference/closing_iterator.qbk]
[include reference/box_iterator.qbk]
[include reference/circular_iterator.qbk]
[include reference/ever_circling_iterator.qbk]
[include reference/segment_range_iterator.qbk]
[endsect]
[section:ranges Ranges]
[include reference/box_range.qbk]
[include reference/segment_range.qbk]
[include reference/closeable_view.qbk]
[include reference/reversible_view.qbk]
[include reference/identity_view.qbk]
[endsect]
[section:arithmetic Arithmetic]

52
doc/reference/area_by_triangles.qbk Normal file
View File

@ -0,0 +1,52 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1area_1_1by__triangles.xml]
[section:strategy_area_by_triangles strategy::area::by_triangles]
[heading Description]
Calculates area using well-known triangulation algorithm
[heading Synopsis]
``template<typename PointOfSegment, typename CalculationType>
class strategy::area::by_triangles
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename PointOfSegment] [point type of segments ]]
[[typename CalculationType] []]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``void apply (PointOfSegment const &p1, PointOfSegment const &p2, summation &state)``
] [] [[* PointOfSegment const &]: ['p1]:
[* PointOfSegment const &]: ['p2]:
[* summation &]: ['state]:
]]
[[`` result (summation const &state)``
] [] [[* summation const &]: ['state]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/cartesian/area_by_triangles.hpp>`
[endsect]

63
doc/reference/area_huiller.qbk Normal file
View File

@ -0,0 +1,63 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1area_1_1huiller.xml]
[section:strategy_area_huiller strategy::area::huiller]
[heading Synopsis]
``template<typename PointOfSegment, typename CalculationType, >
class strategy::area::huiller
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename PointOfSegment] []]
[[typename CalculationType] []]
[[] [type of points of rings/polygons ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``huiller (double radius=1.0)``
] [] [[* double]: ['radius]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``void apply (PointOfSegment const &p1, PointOfSegment const &p2, excess_sum &state) const ``
] [] [[* PointOfSegment const &]: ['p1]:
[* PointOfSegment const &]: ['p2]:
[* &]: ['state]:
]]
[[`` result (excess_sum const &state) const ``
] [] [[* const &]: ['state]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/spherical/area_huiller.hpp>`
[endsect]

46
doc/reference/box_iterator.qbk Normal file
View File

@ -0,0 +1,46 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1box__iterator.xml]
[section:box_iterator box_iterator]
[heading Synopsis]
``template<typename Box>
class box_iterator
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Box] [box type on which this iterator is based on ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``box_iterator (Box const &box)``
] [] [[* Box const &]: ['box]:
]]
[[``box_iterator (Box const &box, bool)``
] [] [[* Box const &]: ['box]:
[* bool]: [']:
]]
]
[heading Header]
`#include <boost/geometry/iterators/box_iterator.hpp>`
[endsect]

53
doc/reference/box_range.qbk Normal file
View File

@ -0,0 +1,53 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1box__range.xml]
[section:box_range box_range]
[heading Synopsis]
``template<typename Box>
class box_range
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Box] [box type ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``box_range (Box const &box)``
] [] [[* Box const &]: ['box]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[`` begin () const ``
] [] [
]]
[[`` end () const ``
] [] [
]]
]
[heading Header]
`#include <boost/geometry/ranges/box_range.hpp>`
[endsect]

61
doc/reference/centroid_bashein_detmer.qbk Normal file
View File

@ -0,0 +1,61 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer.xml]
[section:strategy_centroid_bashein_detmer strategy::centroid::bashein_detmer]
[heading Description]
Calculates centroid using triangulation method published by Bashein / Detmer
Statements:
With holes:
Statements:
[heading Synopsis]
``template<typename Point, typename PointOfSegment, typename CalculationType>
class strategy::centroid::bashein_detmer
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point] [point type of centroid to calculate ]]
[[typename PointOfSegment] [point type of segments, defaults to Point ]]
[[typename CalculationType] []]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``void apply (PointOfSegment const &p1, PointOfSegment const &p2, sums &state)``
] [] [[* PointOfSegment const &]: ['p1]:
[* PointOfSegment const &]: ['p2]:
[* sums &]: ['state]:
]]
[[``bool result (sums const &state, Point &centroid)``
] [] [[* sums const &]: ['state]:
[* Point &]: ['centroid]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp>`
[endsect]

61
doc/reference/circular_iterator.qbk Normal file
View File

@ -0,0 +1,61 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1circular__iterator.xml]
[section:circular_iterator circular_iterator]
[heading Synopsis]
``template<typename Iterator>
class circular_iterator
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Iterator] [iterator on which this class is based on ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``circular_iterator (Iterator begin, Iterator end, Iterator start)``
] [] [[* Iterator]: ['begin]:
[* Iterator]: ['end]:
[* Iterator]: ['start]:
]]
[[``circular_iterator (Iterator end)``
] [] [[* Iterator]: ['end]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``void moveto (Iterator it)``
] [] [[* Iterator]: ['it]:
]]
]
[heading Header]
`#include <boost/geometry/iterators/circular_iterator.hpp>`
[endsect]

24
doc/reference/closeable_view.qbk Normal file
View File

@ -0,0 +1,24 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1closeable__view.xml]
[section:closeable_view closeable_view]
[heading Synopsis]
``template<typename Range, Close>
class closeable_view
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Range] [original range ]]
[[ Close] [specifying if it should be closed or not ]]
]
[heading Header]
`#include <boost/geometry/views/closeable_view.hpp>`
[endsect]

23
doc/reference/closure.qbk Normal file
View File

@ -0,0 +1,23 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1closure.xml]
[section:closure closure]
[heading Synopsis]
``template<typename Geometry>
class closure
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] []]
]
[heading Header]
`#include <boost/geometry/core/closure.hpp>`
[endsect]

52
doc/reference/convex_hull_graham_andrew.qbk Normal file
View File

@ -0,0 +1,52 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1convex__hull_1_1graham__andrew.xml]
[section:strategy_convex_hull_graham_andrew strategy::convex_hull::graham_andrew]
[heading Synopsis]
``template<typename InputGeometry, typename OutputPoint>
class strategy::convex_hull::graham_andrew
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename InputGeometry] []]
[[typename OutputPoint] []]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``void apply (InputGeometry const &geometry, partitions &state) const ``
] [] [[* InputGeometry const &]: ['geometry]:
[* partitions &]: ['state]:
]]
[[``template<typename OutputIterator>
void result (partitions const &state, OutputIterator out, bool clockwise) const ``
] [] [[* partitions const &]: ['state]:
[* OutputIterator]: ['out]:
[* bool]: ['clockwise]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/agnostic/hull_graham_andrew.hpp>`
[endsect]

23
doc/reference/coordinate_system.qbk Normal file
View File

@ -0,0 +1,23 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1coordinate__system.xml]
[section:coordinate_system coordinate_system]
[heading Synopsis]
``template<typename G>
class coordinate_system
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename G] []]
]
[heading Header]
`#include <boost/geometry/core/coordinate_system.hpp>`
[endsect]

23
doc/reference/coordinate_type.qbk Normal file
View File

@ -0,0 +1,23 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1coordinate__type.xml]
[section:coordinate_type coordinate_type]
[heading Synopsis]
``template<typename Geometry>
class coordinate_type
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] []]
]
[heading Header]
`#include <boost/geometry/core/coordinate_type.hpp>`
[endsect]

33
doc/reference/correct.qbk Normal file
View File

@ -0,0 +1,33 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__correct.xml]
[section:correct correct]
Corrects a geometry.
[heading Description]
Corrects a geometry
[heading Synopsis]
``template<typename Geometry>
void correct (Geometry &geometry)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/correct.hpp>`
[endsect]

29
doc/reference/cs_tag.qbk Normal file
View File

@ -0,0 +1,29 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1cs__tag.xml]
[section:cs_tag cs_tag]
[heading Synopsis]
``template<typename G>
class cs_tag
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename G] []]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/core/cs.hpp>`
[endsect]

23
doc/reference/dimension.qbk Normal file
View File

@ -0,0 +1,23 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1dimension.xml]
[section:dimension dimension]
[heading Synopsis]
``template<typename G>
class dimension
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename G] []]
]
[heading Header]
`#include <boost/geometry/core/coordinate_dimension.hpp>`
[endsect]

79
doc/reference/distance_cross_track.qbk Normal file
View File

@ -0,0 +1,79 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1cross__track.xml]
[section:strategy_distance_cross_track strategy::distance::cross_track]
[heading Description]
Class which calculates the distance of a point to a segment, using latlong points
[heading Synopsis]
``template<typename Point, typename PointOfSegment, typename CalculationType, typename Strategy>
class strategy::distance::cross_track
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point] [point type ]]
[[typename PointOfSegment] [type of point-of-segment ]]
[[typename CalculationType] []]
[[typename Strategy] []]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``cross_track ()``
] [] [
]]
[[``cross_track (return_type const &r)``
] [] [[* const &]: ['r]:
]]
[[``cross_track (Strategy const &s)``
] [] [[* Strategy const &]: ['s]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[`` apply (Point const &p, PointOfSegment const &sp1, PointOfSegment const &sp2) const ``
] [] [[* Point const &]: ['p]:
[* PointOfSegment const &]: ['sp1]:
[* PointOfSegment const &]: ['sp2]:
]]
[[`` radius () const ``
] [] [
]]
]
[heading Header]
`#include <boost/geometry/strategies/spherical/distance_cross_track.hpp>`
[endsect]

61
doc/reference/distance_haversine.qbk Normal file
View File

@ -0,0 +1,61 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1haversine.xml]
[section:strategy_distance_haversine strategy::distance::haversine]
[heading Synopsis]
``template<typename Point1, typename Point2, typename CalculationType, , >
class strategy::distance::haversine
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point1] []]
[[typename Point2] []]
[[typename CalculationType] []]
[[] [first point type ]]
[[] [optional second point type ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``haversine (calculation_type const &r=1.0)``
] [] [[* const &]: ['r]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[`` apply (Point1 const &p1, Point2 const &p2) const ``
] [] [[* Point1 const &]: ['p1]:
[* Point2 const &]: ['p2]:
]]
[[`` radius () const ``
] [] [
]]
]
[heading Header]
`#include <boost/geometry/strategies/spherical/distance_haversine.hpp>`
[endsect]

47
doc/reference/distance_projected_point.qbk Normal file
View File

@ -0,0 +1,47 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1projected__point.xml]
[section:strategy_distance_projected_point strategy::distance::projected_point]
[heading Description]
Calculates distance using projected-point method, and (optionally) Pythagoras
[heading Synopsis]
``template<typename Point, typename PointOfSegment, typename CalculationType, typename Strategy, >
class strategy::distance::projected_point
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point] []]
[[typename PointOfSegment] [segment type ]]
[[typename CalculationType] []]
[[typename Strategy] [strategy, optional, defaults to pythagoras ]]
[[] [point type ]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[`` apply (Point const &p, PointOfSegment const &p1, PointOfSegment const &p2) const ``
] [] [[* Point const &]: ['p]:
[* PointOfSegment const &]: ['p1]:
[* PointOfSegment const &]: ['p2]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/cartesian/distance_projected_point.hpp>`
[endsect]

40
doc/reference/distance_pythagoras.qbk Normal file
View File

@ -0,0 +1,40 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras.xml]
[section:strategy_distance_pythagoras strategy::distance::pythagoras]
[heading Synopsis]
``template<typename Point1, typename Point2, typename CalculationType>
class strategy::distance::pythagoras
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point1] [first point type ]]
[[typename Point2] [optional, second point type, defaults to first point type ]]
[[typename CalculationType] [optional, specify type of calculation ]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[`` apply (Point1 const &p1, Point2 const &p2)``
] [] [[* Point1 const &]: ['p1]:
[* Point2 const &]: ['p2]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/cartesian/distance_pythagoras.hpp>`
[endsect]

70
doc/reference/ever_circling_iterator.qbk Normal file
View File

@ -0,0 +1,70 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1ever__circling__iterator.xml]
[section:ever_circling_iterator ever_circling_iterator]
[heading Description]
If the iterator arrives at range.end() it restarts from the beginning. So it has to be stopped in another way. Don't call for(....; it++) because it will turn in an endless loop
[heading Synopsis]
``template<typename Iterator>
class ever_circling_iterator
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Iterator] [iterator on which this class is based on]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``ever_circling_iterator (Iterator begin, Iterator end, bool skip_first=false)``
] [] [[* Iterator]: ['begin]:
[* Iterator]: ['end]:
[* bool]: ['skip_first]:
]]
[[``ever_circling_iterator (Iterator begin, Iterator end, Iterator start, bool skip_first=false)``
] [] [[* Iterator]: ['begin]:
[* Iterator]: ['end]:
[* Iterator]: ['start]:
[* bool]: ['skip_first]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``void moveto (Iterator it)``
] [] [[* Iterator]: ['it]:
]]
]
[heading Header]
`#include <boost/geometry/iterators/ever_circling_iterator.hpp>`
[endsect]

16
doc/reference/exception.qbk Normal file
View File

@ -0,0 +1,16 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1exception.xml]
[section:exception exception]
[heading Synopsis]
``class exception
{
// ...
};
``
[heading Header]
`#include <boost/geometry/core/exception.hpp>`
[endsect]

23
doc/reference/geometry_id.qbk Normal file
View File

@ -0,0 +1,23 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1geometry__id.xml]
[section:geometry_id geometry_id]
[heading Synopsis]
``template<typename Geometry>
class geometry_id
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] []]
]
[heading Header]
`#include <boost/geometry/core/geometry_id.hpp>`
[endsect]

65
doc/reference/identity_view.qbk Normal file
View File

@ -0,0 +1,65 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1identity__view.xml]
[section:identity_view identity_view]
[heading Synopsis]
``template<typename Range>
class identity_view
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Range] [original range ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``identity_view (Range &r)``
] [] [[* Range &]: ['r]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[`` begin () const ``
] [] [
]]
[[`` end () const ``
] [] [
]]
[[`` begin ()``
] [] [
]]
[[`` end ()``
] [] [
]]
]
[heading Header]
`#include <boost/geometry/views/identity_view.hpp>`
[endsect]

26
doc/reference/interior_type.qbk Normal file
View File

@ -0,0 +1,26 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1interior__type.xml]
[section:interior_type interior_type]
[heading Description]
the interior rings should be organized as a container (std::vector, std::deque, boost::array) with boost range support. This meta function defines the type of that container.
[heading Synopsis]
``template<typename Geometry>
class interior_type
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] []]
]
[heading Header]
`#include <boost/geometry/core/interior_type.hpp>`
[endsect]

29
doc/reference/is_radian.qbk Normal file
View File

@ -0,0 +1,29 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1is__radian.xml]
[section:is_radian is_radian]
[heading Synopsis]
``template<typename CoordinateSystem>
class is_radian
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename CoordinateSystem] []]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/core/cs.hpp>`
[endsect]

23
doc/reference/point_order.qbk Normal file
View File

@ -0,0 +1,23 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1point__order.xml]
[section:point_order point_order]
[heading Synopsis]
``template<typename Geometry>
class point_order
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] []]
]
[heading Header]
`#include <boost/geometry/core/point_order.hpp>`
[endsect]

23
doc/reference/point_type.qbk Normal file
View File

@ -0,0 +1,23 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1point__type.xml]
[section:point_type point_type]
[heading Synopsis]
``template<typename Geometry>
class point_type
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] []]
]
[heading Header]
`#include <boost/geometry/core/point_type.hpp>`
[endsect]

24
doc/reference/reversible_view.qbk Normal file
View File

@ -0,0 +1,24 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1reversible__view.xml]
[section:reversible_view reversible_view]
[heading Synopsis]
``template<typename Range, Direction>
class reversible_view
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Range] [original range ]]
[[ Direction] [direction of iteration ]]
]
[heading Header]
`#include <boost/geometry/views/reversible_view.hpp>`
[endsect]

26
doc/reference/ring_type.qbk Normal file
View File

@ -0,0 +1,26 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1ring__type.xml]
[section:ring_type ring_type]
[heading Description]
a polygon contains one exterior ring and zero or more interior rings (holes). This meta function retrieves the type of the rings
[heading Synopsis]
``template<typename Geometry>
class ring_type
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] []]
]
[heading Header]
`#include <boost/geometry/core/ring_type.hpp>`
[endsect]

53
doc/reference/segment_range.qbk Normal file
View File

@ -0,0 +1,53 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1segment__range.xml]
[section:segment_range segment_range]
[heading Synopsis]
``template<typename Segment>
class segment_range
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Segment] [segment type ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``segment_range (Segment const &segment)``
] [] [[* Segment const &]: ['segment]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[`` begin () const ``
] [] [
]]
[[`` end () const ``
] [] [
]]
]
[heading Header]
`#include <boost/geometry/ranges/segment_range.hpp>`
[endsect]

65
doc/reference/segment_range_iterator.qbk Normal file
View File

@ -0,0 +1,65 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1segment__range__iterator.xml]
[section:segment_range_iterator segment_range_iterator]
[heading Synopsis]
``template<typename Segment>
class segment_range_iterator
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Segment] [segment type on which this iterator is based on ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``segment_range_iterator ()``
] [] [
]]
[[``segment_range_iterator (Segment const &segment)``
] [] [[* Segment const &]: ['segment]:
]]
[[``segment_range_iterator (Segment const &segment, bool)``
] [] [[* Segment const &]: ['segment]:
[* bool]: [']:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``< Segment > & operator= (segment_range_iterator< Segment > const &source)``
] [] [[* < Segment > const &]: ['source]:
]]
]
[heading Header]
`#include <boost/geometry/iterators/segment_range_iterator.hpp>`
[endsect]

44
doc/reference/side_side_by_cross_track.qbk Normal file
View File

@ -0,0 +1,44 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1side_1_1side__by__cross__track.xml]
[section:strategy_side_side_by_cross_track strategy::side::side_by_cross_track]
[heading Description]
from a Great Circle segment between two points: left of segment (> 0), right of segment (< 0), on segment (0)
[heading Synopsis]
``template<typename CalculationType>
class strategy::side::side_by_cross_track
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename CalculationType] [CalculationType ]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``template<typename P1, typename P2, typename P>
int apply (P1 const &p1, P2 const &p2, P const &p)``
] [] [[* P1 const &]: ['p1]:
[* P2 const &]: ['p2]:
[* P const &]: ['p]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/spherical/side_by_cross_track.hpp>`
[endsect]

44
doc/reference/side_side_by_triangle.qbk Normal file
View File

@ -0,0 +1,44 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1side_1_1side__by__triangle.xml]
[section:strategy_side_side_by_triangle strategy::side::side_by_triangle]
[heading Description]
left of segment (> 0), right of segment (< 0), on segment (0) In fact this is twice the area of a triangle
[heading Synopsis]
``template<typename CalculationType>
class strategy::side::side_by_triangle
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename CalculationType] [CalculationType ]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``template<typename P1, typename P2, typename P>
int apply (P1 const &p1, P2 const &p2, P const &p)``
] [] [[* P1 const &]: ['p1]:
[* P2 const &]: ['p2]:
[* P const &]: ['p]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/cartesian/side_by_triangle.hpp>`
[endsect]

45
doc/reference/simplify_douglas_peucker.qbk Normal file
View File

@ -0,0 +1,45 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker.xml]
[section:strategy_simplify_douglas_peucker strategy::simplify::douglas_peucker]
[heading Description]
The
[heading Synopsis]
``template<typename Point, typename PointDistanceStrategy>
class strategy::simplify::douglas_peucker
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point] [the point type ]]
[[typename PointDistanceStrategy] [point-segment distance strategy to be used ]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``template<typename Range, typename OutputIterator>
OutputIterator apply (Range const &range, OutputIterator out, double max_distance)``
] [] [[* Range const &]: ['range]:
[* OutputIterator]: ['out]:
[* double]: ['max_distance]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp>`
[endsect]

32
doc/reference/tag.qbk Normal file
View File

@ -0,0 +1,32 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1tag.xml]
[section:tag tag]
[heading Description]
All geometries tell their geometry type (point, linestring, polygon, etc) by implementing a tag traits class. This meta-function uses that traits class to retrieve the tag. If the input type is not a geometry at all, a
[heading Synopsis]
``template<typename Geometry>
class tag
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] [geometry ]]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/core/tag.hpp>`
[endsect]

32
doc/reference/topological_dimension.qbk Normal file
View File

@ -0,0 +1,32 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1topological__dimension.xml]
[section:topological_dimension topological_dimension]
[heading Description]
The topological dimension defines a point as 0-dimensional, a linestring as 1-dimensional, and a ring or polygon as 2-dimensional.
[heading Synopsis]
``template<typename Geometry>
class topological_dimension
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] []]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/core/topological_dimension.hpp>`
[endsect]

38
doc/reference/transform_inverse_transformer.qbk Normal file
View File

@ -0,0 +1,38 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1inverse__transformer.xml]
[section:strategy_transform_inverse_transformer strategy::transform::inverse_transformer]
[heading Synopsis]
``template<typename P1, typename P2>
class strategy::transform::inverse_transformer
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename P1] [first point type ]]
[[typename P2] [second point type ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``template<typename Transformer>
inverse_transformer (Transformer const &input)``
] [] [[* Transformer const &]: ['input]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/transform/inverse_transformer.hpp>`
[endsect]

65
doc/reference/transform_map_transformer.qbk Normal file
View File

@ -0,0 +1,65 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer.xml]
[section:strategy_transform_map_transformer strategy::transform::map_transformer]
[heading Synopsis]
``template<typename P1, typename P2, bool Mirror, bool SameScale, std::size_t Dimension1, std::size_t Dimension2>
class strategy::transform::map_transformer
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename P1] [first point type ]]
[[typename P2] [second point type ]]
[[bool Mirror] [if true map is mirrored upside-down (in most cases pixels are from top to bottom, while map is from bottom to top) ]]
[[bool SameScale] []]
[[std::size_t Dimension1] []]
[[std::size_t Dimension2] []]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``template<typename B, typename D>
map_transformer (B const &box, D const &width, D const &height)``
] [] [[* B const &]: ['box]:
[* D const &]: ['width]:
[* D const &]: ['height]:
]]
[[``template<typename W, typename D>
map_transformer (W const &wx1, W const &wy1, W const &wx2, W const &wy2, D const &width, D const &height)``
] [] [[* W const &]: ['wx1]:
[* W const &]: ['wy1]:
[* W const &]: ['wx2]:
[* W const &]: ['wy2]:
[* D const &]: ['width]:
[* D const &]: ['height]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/transform/map_transformer.hpp>`
[endsect]

41
doc/reference/transform_rotate_transformer.qbk Normal file
View File

@ -0,0 +1,41 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1rotate__transformer.xml]
[section:strategy_transform_rotate_transformer strategy::transform::rotate_transformer]
[heading Description]
Rotate rotates a geometry of specified angle about a fixed point (e.g. origin).
[heading Synopsis]
``template<typename P1, typename P2, typename DegreeOrRadian>
class strategy::transform::rotate_transformer
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename P1] [first point type ]]
[[typename P2] [second point type ]]
[[typename DegreeOrRadian] [degree/or/radian, type of rotation angle specification ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``rotate_transformer (angle_type const &angle)``
] [] [[* angle_type const &]: ['angle]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/transform/matrix_transformers.hpp>`
[endsect]

29
doc/reference/transform_scale_transformer.qbk Normal file
View File

@ -0,0 +1,29 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1scale__transformer.xml]
[section:strategy_transform_scale_transformer strategy::transform::scale_transformer]
[heading Description]
Scale scales a geometry up or down in all its dimensions.
[heading Synopsis]
``template<typename P1, typename P2, std::size_t Dimension1, std::size_t Dimension2>
class strategy::transform::scale_transformer
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename P1] [first point type ]]
[[typename P2] [second point type ]]
[[std::size_t Dimension1] [number of dimensions to transform to second point, optional ]]
[[std::size_t Dimension2] []]
]
[heading Header]
`#include <boost/geometry/strategies/transform/matrix_transformers.hpp>`
[endsect]

29
doc/reference/transform_translate_transformer.qbk Normal file
View File

@ -0,0 +1,29 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1translate__transformer.xml]
[section:strategy_transform_translate_transformer strategy::transform::translate_transformer]
[heading Description]
Translate moves a geometry a fixed distance in 2 or 3 dimensions.
[heading Synopsis]
``template<typename P1, typename P2, std::size_t Dimension1, std::size_t Dimension2>
class strategy::transform::translate_transformer
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename P1] [first point type ]]
[[typename P2] [second point type ]]
[[std::size_t Dimension1] [number of dimensions to transform to second point, optional ]]
[[std::size_t Dimension2] []]
]
[heading Header]
`#include <boost/geometry/strategies/transform/matrix_transformers.hpp>`
[endsect]

29
doc/reference/transform_ublas_transformer.qbk Normal file
View File

@ -0,0 +1,29 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1ublas__transformer.xml]
[section:strategy_transform_ublas_transformer strategy::transform::ublas_transformer]
[heading Description]
The strategy serves as a generic definition of affine transformation matrix and procedure of application it to given point.
[heading Synopsis]
``template<typename P1, typename P2, std::size_t Dimension1, std::size_t Dimension2>
class strategy::transform::ublas_transformer
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename P1] [first point type (source) ]]
[[typename P2] [second point type (target) ]]
[[std::size_t Dimension1] [number of dimensions to transform to second point, optional ]]
[[std::size_t Dimension2] []]
]
[heading Header]
`#include <boost/geometry/strategies/transform/matrix_transformers.hpp>`
[endsect]

52
doc/reference/within_crossings_multiply.qbk Normal file
View File

@ -0,0 +1,52 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1within_1_1crossings__multiply.xml]
[section:strategy_within_crossings_multiply strategy::within::crossings_multiply]
[heading Synopsis]
``template<typename Point, typename PointOfSegment, typename CalculationType>
class strategy::within::crossings_multiply
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point] []]
[[typename PointOfSegment] []]
[[typename CalculationType] []]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``bool apply (Point const &point, PointOfSegment const &seg1, PointOfSegment const &seg2, flags &state)``
] [] [[* Point const &]: ['point]:
[* PointOfSegment const &]: ['seg1]:
[* PointOfSegment const &]: ['seg2]:
[* flags &]: ['state]:
]]
[[``int result (flags const &state)``
] [] [[* flags const &]: ['state]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/cartesian/point_in_poly_crossings_multiply.hpp>`
[endsect]

52
doc/reference/within_franklin.qbk Normal file
View File

@ -0,0 +1,52 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1within_1_1franklin.xml]
[section:strategy_within_franklin strategy::within::franklin]
[heading Synopsis]
``template<typename Point, typename PointOfSegment, typename CalculationType>
class strategy::within::franklin
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point] []]
[[typename PointOfSegment] []]
[[typename CalculationType] []]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``bool apply (Point const &point, PointOfSegment const &seg1, PointOfSegment const &seg2, crossings &state)``
] [] [[* Point const &]: ['point]:
[* PointOfSegment const &]: ['seg1]:
[* PointOfSegment const &]: ['seg2]:
[* crossings &]: ['state]:
]]
[[``int result (crossings const &state)``
] [] [[* crossings const &]: ['state]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/cartesian/point_in_poly_franklin.hpp>`
[endsect]

52
doc/reference/within_winding.qbk Normal file
View File

@ -0,0 +1,52 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1within_1_1winding.xml]
[section:strategy_within_winding strategy::within::winding]
[heading Synopsis]
``template<typename Point, typename PointOfSegment, typename CalculationType>
class strategy::within::winding
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point] [point type of point to examine ]]
[[typename PointOfSegment] [point type of segments, defaults to Point ]]
[[typename CalculationType] []]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[``bool apply (Point const &point, PointOfSegment const &s1, PointOfSegment const &s2, counter &state)``
] [] [[* Point const &]: ['point]:
[* PointOfSegment const &]: ['s1]:
[* PointOfSegment const &]: ['s2]:
[* counter &]: ['state]:
]]
[[``int result (counter const &state)``
] [] [[* counter const &]: ['state]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/agnostic/point_in_poly_winding.hpp>`
[endsect]