diff --git a/doc/doxy/doxygen_input/groups/groups.hpp b/doc/doxy/doxygen_input/groups/groups.hpp index 17bcb7061..331ccd502 100644 --- a/doc/doxy/doxygen_input/groups/groups.hpp +++ b/doc/doxy/doxygen_input/groups/groups.hpp @@ -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 +*/ diff --git a/doc/introduction.qbk b/doc/introduction.qbk index 9b2995414..5849ac84a 100644 --- a/doc/introduction.qbk +++ b/doc/introduction.qbk @@ -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] diff --git a/doc/make_qbk.py b/doc/make_qbk.py index 3e636a189..ed286f083 100755 --- a/doc/make_qbk.py +++ b/doc/make_qbk.py @@ -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") diff --git a/doc/quickref.xml b/doc/quickref.xml index 50ad2108e..108c951de 100644 --- a/doc/quickref.xml +++ b/doc/quickref.xml @@ -2,12 +2,16 @@ - @@ -127,22 +131,26 @@ Metafunctions - cs_tag - coordinate_type - coordinate_system - dimension - geometry_id - interior_type - is_linear - is_multi - is_radian - point_order - point_type - ring_type - replace_point_type - reverse_dispatch - tag - topological_dimension + cs_tag + coordinate_type + coordinate_system + dimension + geometry_id + interior_type + + is_radian + point_order + point_type + ring_type + + tag + topological_dimension @@ -167,15 +175,19 @@ - + + Constants + + Coordinate Systems + @@ -195,27 +207,6 @@ radian - - - - - - - - - - - - - Coordinate Systems - - - Iterators - - - - - Classes @@ -225,24 +216,42 @@ cs::spherical + + + + + + + + + + + + Iterators + + + Ranges + + + + + - Metafunctions - range_type - - Classes - - circular_iterator - ever_circling_iterator - one_section_segment_iterator - section_iterator - segment_iterator + closing_iterator + circular_iterator + ever_circling_iterator + one_section_segment_iterator + segment_range_iterator - Functions - make_segment_iterator + box_range + segment_range + closeable_view + reversible_view + identity_view @@ -438,18 +447,15 @@ Area - strategy_area - area_result - strategy::area::by_triangles - strategy::area::huiller + strategy::area::by_triangles + strategy::area::huiller Centroid - strategy_centroid - strategy::centroid_::bashein_detmer - strategy::centroid_::centroid_average + strategy::centroid_::bashein_detmer + strategy::centroid_::centroid_average @@ -457,10 +463,16 @@ Distance - strategy::distance::projected_point - strategy::distance::pythagoras - strategy::distance::cross_track - strategy::distance::haversine + strategy::distance::projected_point + strategy::distance::pythagoras + strategy::distance::cross_track + strategy::distance::haversine + + + + Convex Hull + + strategy::convex_hull::graham_andrew @@ -468,15 +480,14 @@ Side - strategy::side::course - strategy::side::side_by_triangle - strategy::side::side_by_cross_track + strategy::side::side_by_triangle + strategy::side::side_by_cross_track Simplify - strategy::simplify::douglas_peucker + strategy::simplify::douglas_peucker @@ -484,20 +495,20 @@ Transform - strategy::inverse_transformer - strategy::map_transformer - strategy::ublas_transformer - strategy::translate_transformer - strategy::scale_transformer - strategy::rotate_transformer + strategy::transform::inverse_transformer + strategy::transform::map_transformer + strategy::transform::ublas_transformer + strategy::transform::translate_transformer + strategy::transform::scale_transformer + strategy::transform::rotate_transformer Within - strategy::winding - strategy::crossings_multiply - strategy::franklin + strategy::winding + strategy::crossings_multiply + strategy::franklin diff --git a/doc/quickstart.qbk b/doc/quickstart.qbk index 212171303..288057039 100644 --- a/doc/quickstart.qbk +++ b/doc/quickstart.qbk @@ -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] diff --git a/doc/reference.qbk b/doc/reference.qbk index 702ae4ab5..ca0d96333 100644 --- a/doc/reference.qbk +++ b/doc/reference.qbk @@ -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] diff --git a/doc/reference/area_by_triangles.qbk b/doc/reference/area_by_triangles.qbk new file mode 100644 index 000000000..8a28d64c0 --- /dev/null +++ b/doc/reference/area_by_triangles.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/area_huiller.qbk b/doc/reference/area_huiller.qbk new file mode 100644 index 000000000..1dd2a5fde --- /dev/null +++ b/doc/reference/area_huiller.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/box_iterator.qbk b/doc/reference/box_iterator.qbk new file mode 100644 index 000000000..b4a90c0ce --- /dev/null +++ b/doc/reference/box_iterator.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/box_range.qbk b/doc/reference/box_range.qbk new file mode 100644 index 000000000..ab93a9c94 --- /dev/null +++ b/doc/reference/box_range.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/centroid_bashein_detmer.qbk b/doc/reference/centroid_bashein_detmer.qbk new file mode 100644 index 000000000..3e4b7530a --- /dev/null +++ b/doc/reference/centroid_bashein_detmer.qbk @@ -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 +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 ¢roid)`` + +] [] [[* sums const &]: ['state]: + +[* Point &]: ['centroid]: + + + + +]] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/circular_iterator.qbk b/doc/reference/circular_iterator.qbk new file mode 100644 index 000000000..49ddc4833 --- /dev/null +++ b/doc/reference/circular_iterator.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/closeable_view.qbk b/doc/reference/closeable_view.qbk new file mode 100644 index 000000000..8f5062ffc --- /dev/null +++ b/doc/reference/closeable_view.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/closure.qbk b/doc/reference/closure.qbk new file mode 100644 index 000000000..89599bee9 --- /dev/null +++ b/doc/reference/closure.qbk @@ -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 +class closure +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Geometry] []] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/convex_hull_graham_andrew.qbk b/doc/reference/convex_hull_graham_andrew.qbk new file mode 100644 index 000000000..bf7416977 --- /dev/null +++ b/doc/reference/convex_hull_graham_andrew.qbk @@ -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 +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 +void result (partitions const &state, OutputIterator out, bool clockwise) const `` + +] [] [[* partitions const &]: ['state]: + +[* OutputIterator]: ['out]: + +[* bool]: ['clockwise]: + + + + +]] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/coordinate_system.qbk b/doc/reference/coordinate_system.qbk new file mode 100644 index 000000000..ca9b5ba97 --- /dev/null +++ b/doc/reference/coordinate_system.qbk @@ -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 +class coordinate_system +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename G] []] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/coordinate_type.qbk b/doc/reference/coordinate_type.qbk new file mode 100644 index 000000000..799d49bc9 --- /dev/null +++ b/doc/reference/coordinate_type.qbk @@ -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 +class coordinate_type +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Geometry] []] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/correct.qbk b/doc/reference/correct.qbk new file mode 100644 index 000000000..fad80951b --- /dev/null +++ b/doc/reference/correct.qbk @@ -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 +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 ` + +Or + +`#include ` + + +[endsect] + diff --git a/doc/reference/cs_tag.qbk b/doc/reference/cs_tag.qbk new file mode 100644 index 000000000..17de0ecfb --- /dev/null +++ b/doc/reference/cs_tag.qbk @@ -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 +class cs_tag +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename G] []] +] + +[heading Header] +Either + +`#include ` + +Or + +`#include ` + +[endsect] + diff --git a/doc/reference/dimension.qbk b/doc/reference/dimension.qbk new file mode 100644 index 000000000..8cd8338e0 --- /dev/null +++ b/doc/reference/dimension.qbk @@ -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 +class dimension +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename G] []] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/distance_cross_track.qbk b/doc/reference/distance_cross_track.qbk new file mode 100644 index 000000000..a9b3857a9 --- /dev/null +++ b/doc/reference/distance_cross_track.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/distance_haversine.qbk b/doc/reference/distance_haversine.qbk new file mode 100644 index 000000000..7ce0345ce --- /dev/null +++ b/doc/reference/distance_haversine.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/distance_projected_point.qbk b/doc/reference/distance_projected_point.qbk new file mode 100644 index 000000000..4e1cbe105 --- /dev/null +++ b/doc/reference/distance_projected_point.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/distance_pythagoras.qbk b/doc/reference/distance_pythagoras.qbk new file mode 100644 index 000000000..f26f98292 --- /dev/null +++ b/doc/reference/distance_pythagoras.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/ever_circling_iterator.qbk b/doc/reference/ever_circling_iterator.qbk new file mode 100644 index 000000000..c053c3332 --- /dev/null +++ b/doc/reference/ever_circling_iterator.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/exception.qbk b/doc/reference/exception.qbk new file mode 100644 index 000000000..3b844db12 --- /dev/null +++ b/doc/reference/exception.qbk @@ -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 ` + +[endsect] + diff --git a/doc/reference/geometry_id.qbk b/doc/reference/geometry_id.qbk new file mode 100644 index 000000000..a1b967fdd --- /dev/null +++ b/doc/reference/geometry_id.qbk @@ -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 +class geometry_id +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Geometry] []] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/identity_view.qbk b/doc/reference/identity_view.qbk new file mode 100644 index 000000000..49188383e --- /dev/null +++ b/doc/reference/identity_view.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/interior_type.qbk b/doc/reference/interior_type.qbk new file mode 100644 index 000000000..700b8debf --- /dev/null +++ b/doc/reference/interior_type.qbk @@ -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 +class interior_type +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Geometry] []] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/is_radian.qbk b/doc/reference/is_radian.qbk new file mode 100644 index 000000000..88de32fbc --- /dev/null +++ b/doc/reference/is_radian.qbk @@ -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 +class is_radian +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename CoordinateSystem] []] +] + +[heading Header] +Either + +`#include ` + +Or + +`#include ` + +[endsect] + diff --git a/doc/reference/point_order.qbk b/doc/reference/point_order.qbk new file mode 100644 index 000000000..006a92b06 --- /dev/null +++ b/doc/reference/point_order.qbk @@ -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 +class point_order +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Geometry] []] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/point_type.qbk b/doc/reference/point_type.qbk new file mode 100644 index 000000000..997eda438 --- /dev/null +++ b/doc/reference/point_type.qbk @@ -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 +class point_type +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Geometry] []] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/reversible_view.qbk b/doc/reference/reversible_view.qbk new file mode 100644 index 000000000..8bff505fe --- /dev/null +++ b/doc/reference/reversible_view.qbk @@ -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 +class reversible_view +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Range] [original range ]] +[[ Direction] [direction of iteration ]] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/ring_type.qbk b/doc/reference/ring_type.qbk new file mode 100644 index 000000000..7c19eb0b9 --- /dev/null +++ b/doc/reference/ring_type.qbk @@ -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 +class ring_type +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Geometry] []] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/segment_range.qbk b/doc/reference/segment_range.qbk new file mode 100644 index 000000000..783af74d2 --- /dev/null +++ b/doc/reference/segment_range.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/segment_range_iterator.qbk b/doc/reference/segment_range_iterator.qbk new file mode 100644 index 000000000..0b3d7357f --- /dev/null +++ b/doc/reference/segment_range_iterator.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/side_side_by_cross_track.qbk b/doc/reference/side_side_by_cross_track.qbk new file mode 100644 index 000000000..8ccd28626 --- /dev/null +++ b/doc/reference/side_side_by_cross_track.qbk @@ -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 +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 +int apply (P1 const &p1, P2 const &p2, P const &p)`` + +] [] [[* P1 const &]: ['p1]: + +[* P2 const &]: ['p2]: + +[* P const &]: ['p]: + + + + +]] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/side_side_by_triangle.qbk b/doc/reference/side_side_by_triangle.qbk new file mode 100644 index 000000000..7a9adb6df --- /dev/null +++ b/doc/reference/side_side_by_triangle.qbk @@ -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 +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 +int apply (P1 const &p1, P2 const &p2, P const &p)`` + +] [] [[* P1 const &]: ['p1]: + +[* P2 const &]: ['p2]: + +[* P const &]: ['p]: + + + + +]] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/simplify_douglas_peucker.qbk b/doc/reference/simplify_douglas_peucker.qbk new file mode 100644 index 000000000..cbde40575 --- /dev/null +++ b/doc/reference/simplify_douglas_peucker.qbk @@ -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 +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 +OutputIterator apply (Range const &range, OutputIterator out, double max_distance)`` + +] [] [[* Range const &]: ['range]: + +[* OutputIterator]: ['out]: + +[* double]: ['max_distance]: + + + + +]] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/tag.qbk b/doc/reference/tag.qbk new file mode 100644 index 000000000..97d8d6eca --- /dev/null +++ b/doc/reference/tag.qbk @@ -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 +class tag +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Geometry] [geometry ]] +] + +[heading Header] +Either + +`#include ` + +Or + +`#include ` + +[endsect] + diff --git a/doc/reference/topological_dimension.qbk b/doc/reference/topological_dimension.qbk new file mode 100644 index 000000000..65209d449 --- /dev/null +++ b/doc/reference/topological_dimension.qbk @@ -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 +class topological_dimension +{ + // ... +}; +`` + +[heading Template parameter(s)] +[table +[[Parameter] [Description]] +[[typename Geometry] []] +] + +[heading Header] +Either + +`#include ` + +Or + +`#include ` + +[endsect] + diff --git a/doc/reference/transform_inverse_transformer.qbk b/doc/reference/transform_inverse_transformer.qbk new file mode 100644 index 000000000..3599c6075 --- /dev/null +++ b/doc/reference/transform_inverse_transformer.qbk @@ -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 +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 +inverse_transformer (Transformer const &input)`` + +] [] [[* Transformer const &]: ['input]: + + + + +]] +] + +[heading Header] +`#include ` + +[endsect] + diff --git a/doc/reference/transform_map_transformer.qbk b/doc/reference/transform_map_transformer.qbk new file mode 100644 index 000000000..e607d4986 --- /dev/null +++ b/doc/reference/transform_map_transformer.qbk @@ -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 +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 +map_transformer (B const &box, D const &width, D const &height)`` + +] [] [[* B const &]: ['box]: + +[* D const &]: ['width]: + +[* D const &]: ['height]: + + + + +]] +[[``template +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 ` + +[endsect] + diff --git a/doc/reference/transform_rotate_transformer.qbk b/doc/reference/transform_rotate_transformer.qbk new file mode 100644 index 000000000..92b0fac8c --- /dev/null +++ b/doc/reference/transform_rotate_transformer.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/transform_scale_transformer.qbk b/doc/reference/transform_scale_transformer.qbk new file mode 100644 index 000000000..298192f03 --- /dev/null +++ b/doc/reference/transform_scale_transformer.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/transform_translate_transformer.qbk b/doc/reference/transform_translate_transformer.qbk new file mode 100644 index 000000000..cf8a0b1d1 --- /dev/null +++ b/doc/reference/transform_translate_transformer.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/transform_ublas_transformer.qbk b/doc/reference/transform_ublas_transformer.qbk new file mode 100644 index 000000000..80d694624 --- /dev/null +++ b/doc/reference/transform_ublas_transformer.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/within_crossings_multiply.qbk b/doc/reference/within_crossings_multiply.qbk new file mode 100644 index 000000000..afc4d5931 --- /dev/null +++ b/doc/reference/within_crossings_multiply.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/within_franklin.qbk b/doc/reference/within_franklin.qbk new file mode 100644 index 000000000..1821f00e8 --- /dev/null +++ b/doc/reference/within_franklin.qbk @@ -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 +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 ` + +[endsect] + diff --git a/doc/reference/within_winding.qbk b/doc/reference/within_winding.qbk new file mode 100644 index 000000000..516cdac5d --- /dev/null +++ b/doc/reference/within_winding.qbk @@ -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 +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 ` + +[endsect] +