• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/============================================================================
2  Boost.Geometry (aka GGL, Generic Geometry Library)
3
4  Copyright (c) 2009-2019 Barend Gehrels, Amsterdam, the Netherlands.
5  Copyright (c) 2009-2019 Mateusz Loskot, London, UK.
6  Copyright (c) 2009-2019 Bruno Lalande, Paris, France.
7  Copyright (c) 2011-2019 Adam Wulkiewicz, Lodz, Poland.
8
9  Use, modification and distribution is subject to the Boost Software License,
10  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
11  http://www.boost.org/LICENSE_1_0.txt)
12=============================================================================/]
13
14[library Geometry
15    [quickbook 1.5]
16    [authors [Gehrels, Barend], [Lalande, Bruno], [Loskot, Mateusz], [Wulkiewicz, Adam], [Karavelas, Menelaos], [Fisikopoulos, Vissarion]]
17    [copyright 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates]
18    [purpose Documentation of Boost.Geometry library]
19    [license
20        Distributed under the Boost Software License, Version 1.0.
21        (See accompanying file LICENSE_1_0.txt or copy at
22        [@http://www.boost.org/LICENSE_1_0.txt])
23    ]
24    [id geometry]
25    [category geometry]
26]
27
28[/Behavior]
29[def __0dim__  pointlike (e.g. point)]
30[def __1dim__  linear (e.g. linestring)]
31[def __2dim__  areal (e.g. polygon)]
32[def __single__  single (e.g. point, polygon)]
33[def __multi__  multiple (e.g. multi_point, multi_polygon)]
34[def __cart__  Cartesian]
35[def __sph__  Spherical]
36[def __geo__  Geographic]
37[def __rev__  Reversed polygon (coordinates not according their orientiation)]
38[def __empty__ Empty (e.g. polygon without points)]
39[def __box__  Box]
40[def __rectangle__  Rectangle]
41[def __segment__  Segment]
42[def __point__  Point]
43[def __linestring__  Linestring]
44[def __polygon__  Polygon]
45[def __ring__  Ring]
46[def __multi_point__  Multi Point]
47[def __multi_linestring__  Multi Linestring]
48[def __multi_polygon__  Multi Polygon]
49[def __range__  Rangelike (linestring, ring)]
50[def __other__  Other geometries]
51[def __nyiversion__  Not yet supported in this version]
52
53[def __not_in_boost_geometry_hpp__ The standard header `boost/geometry.hpp` does not include this header.]
54
55
56[/Parts]
57[def __ret_zero__ Returns zero]
58[def __ret_one__ Returns 1]
59[def __does_nothing__ Nothing happens, geometry is unchanged]
60[def __cs_units__ in the same units as the input coordinates]
61[def __sph1__ on a unit sphere (or another sphere, if specified as such in the constructor of the strategy)]
62[template qbk_ret[what] Returns [what]]
63[template qbk_out[what] GeometryOut is a [what]]
64
65[def __boost__ Boost]
66[def __boost_geometry__ Boost.Geometry]
67[def __boost_array__ Boost.Array]
68[def __boost_fusion__ Boost.Fusion]
69[def __boost_mpl__ Boost.MPL]
70[def __boost_range__ Boost.Range]
71[def __boost_tuple__ Boost.Tuple]
72[def __boost_gil__ [@http://www.boost.org/libs/gil/ Boost.GIL]]
73[def __boost_bb__ Boost.Build]
74
75[def __ttmath__ [@http://www.ttmath.org/ ttmath]]
76[def __ogc__ [@http://www.opengeospatial.org OGC]]
77
78[def __ogc_sf__ [@http://www.opengeospatial.org/standards/sfa OGC Simple Feature Specification]]
79
80[/Templates]
81[template concept[name type]
82The [name] Concept describes the requirements for a [type] type.
83All algorithms in Boost.Geometry will check any geometry arguments against the concept requirements.
84]
85
86[template heading_conformance_no_ogc[function]
87[heading Conformance]
88The function [function] is not defined by OGC.
89]
90
91[template heading_conformance_ogc[function ogc_function]
92[heading Conformance]
93The function [function] implements function [ogc_function] from the __ogc_sf__.
94]
95
96[template conformance_std[function std_function]
97The function [function] conforms to the [std_function] of the C++ std-library.
98]
99
100[template see_boost_range_sample[concept]
101[note See also the sample in the [@../../../range/doc/html/range/reference/extending/method_2.html Boost.Range documentation]
102  showing how a type can be adapted to a Boost.Range to fulfill the concept of a [concept]
103]
104]
105
106
107[heading Contributions]
108
109Boost.Geometry contains contributions by:
110
111* Akira Takahashi (adaption of Boost.Fusion)
112* Alfredo Correa (adaption of Boost.Array)
113* Andrew Hundt (varray container, aka. static_vector)
114* Federico Fern\u00E1ndez (preliminary version of R-tree spatial index)
115* Karsten Ahnert (patch for cross-track distance)
116* Mats Taraldsvik (documentation: adapting a legacy model)
117* Matt Amos (fixes for point_on_surface)
118* Samuel Debionne (variant support for distance, assign, crosses, intersection, ...)
119* Adeel Ahmad (Karney's solution of direct and inverse geodesic problems)
120* Yaghyavardhan Singh Khangarot (discrete Frechet and Hausdorff distance)
121* Tinko Bartels (Delaunay triangulation, Voronoi diagram, random point generation, ...)
122* Caian Benedicto (patch for temporary allocator support)
123
124[include imports.qbk]
125
126[include introduction.qbk]
127[include compiling.qbk]
128
129[include design_rationale.qbk]
130[include quickstart.qbk]
131
132[section Spatial Indexes]
133[include index/index.qbk]
134[endsect]
135
136[include reference.qbk]
137
138[include matrix.qbk]
139[section Reference Alphabetical Index]
140'''<index><title/></index>'''
141[endsect]
142
143[section Examples]
144[include example_adapting_a_legacy_geometry_object_model.qbk]
145[endsect]
146
147[include release_notes.qbk]
148
149[/ TODO: [include guidelines.qbk] /]
150[include about_documentation.qbk]
151[include acknowledgments.qbk]
152