1 [/============================================================================
2 Boost.Geometry (aka GGL, Generic Geometry Library)
4 Copyright (c) 2009-2015 Barend Gehrels, Amsterdam, the Netherlands.
5 Copyright (c) 2009-2015 Mateusz Loskot, London, UK.
6 Copyright (c) 2009-2015 Bruno Lalande, Paris, France.
8 Use, modification and distribution is subject to the Boost Software License,
9 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
10 http://www.boost.org/LICENSE_1_0.txt)
11 =============================================================================/]
15 [authors [Gehrels, Barend], [Lalande, Bruno], [Loskot, Mateusz], [Wulkiewicz, Adam], [Karavelas, Menelaos]]
16 [copyright 2009-2015 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates]
17 [purpose Documentation of Boost.Geometry library]
19 Distributed under the Boost Software License, Version 1.0.
20 (See accompanying file LICENSE_1_0.txt or copy at
21 [@http://www.boost.org/LICENSE_1_0.txt])
28 [def __0dim__ pointlike (e.g. point)]
29 [def __1dim__ linear (e.g. linestring)]
30 [def __2dim__ areal (e.g. polygon)]
31 [def __single__ single (e.g. point, polygon)]
32 [def __multi__ multiple (e.g. multi_point, multi_polygon)]
33 [def __cart__ Cartesian]
34 [def __sph__ Spherical]
35 [def __geo__ Geographic]
36 [def __rev__ Reversed polygon (coordinates not according their orientiation)]
37 [def __empty__ Empty (e.g. polygon without points)]
39 [def __rectangle__ Rectangle]
40 [def __segment__ Segment]
42 [def __linestring__ Linestring]
43 [def __polygon__ Polygon]
45 [def __multi_point__ Multi Point]
46 [def __multi_linestring__ Multi Linestring]
47 [def __multi_polygon__ Multi Polygon]
48 [def __range__ Rangelike (linestring, ring)]
49 [def __other__ Other geometries]
50 [def __nyiversion__ Not yet supported in this version]
52 [def __not_in_boost_geometry_hpp__ The standard header `boost/geometry.hpp` does not include this header.]
56 [def __ret_zero__ Returns zero]
57 [def __ret_one__ Returns 1]
58 [def __does_nothing__ Nothing happens, geometry is unchanged]
59 [def __cs_units__ in the same units as the input coordinates]
60 [def __sph1__ on a unit sphere (or another sphere, if specified as such in the constructor of the strategy)]
61 [template qbk_ret[what] Returns [what]]
62 [template qbk_out[what] GeometryOut is a [what]]
65 [def __boost_geometry__ Boost.Geometry]
66 [def __boost_array__ Boost.Array]
67 [def __boost_fusion__ Boost.Fusion]
68 [def __boost_mpl__ Boost.MPL]
69 [def __boost_range__ Boost.Range]
70 [def __boost_tuple__ Boost.Tuple]
71 [def __boost_gil__ [@http://www.boost.org/libs/gil/ Boost.GIL]]
72 [def __boost_bb__ Boost.Build]
74 [def __ttmath__ [@http://www.ttmath.org/ ttmath]]
75 [def __ogc__ [@http://www.opengeospatial.org OGC]]
77 [def __ogc_sf__ [@http://www.opengeospatial.org/standards/sfa OGC Simple Feature Specification]]
80 [template concept[name type]
81 The [name] Concept describes the requirements for a [type] type.
82 All algorithms in Boost.Geometry will check any geometry arguments against the concept requirements.
85 [template heading_conformance_no_ogc[function]
87 The function [function] is not defined by OGC.
90 [template heading_conformance_ogc[function ogc_function]
92 The function [function] implements function [ogc_function] from the __ogc_sf__.
95 [template conformance_std[function std_function]
96 The function [function] conforms to the [std_function] of the C++ std-library.
99 [template see_boost_range_sample[concept]
100 [note See also the sample in the [@../../../range/doc/html/range/reference/extending/method_2.html Boost.Range documentation]
101 showing how a type can be adapted to a Boost.Range to fulfill the concept of a [concept]
106 [heading Contributions]
108 Boost.Geometry contains contributions by:
110 * Akira Takahashi (adaption of Boost.Fusion)
111 * Alfredo Correa (adaption of Boost.Array)
112 * Andrew Hundt (varray container, aka. static_vector)
113 * Federico Fern\u00E1ndez (preliminary version of R-tree spatial index)
114 * Karsten Ahnert (patch for cross-track distance)
115 * Mats Taraldsvik (documentation: adapting a legacy model)
116 * Matt Amos (fixes for point_on_surface)
117 * Samuel Debionne (variant support for distance, assign, crosses, intersection, ...)
119 [include imports.qbk]
121 [include introduction.qbk]
122 [include compiling.qbk]
124 [include design_rationale.qbk]
125 [include quickstart.qbk]
127 [section Spatial Indexes]
128 [include index/index.qbk]
131 [include reference.qbk]
134 [section Reference Alphabetical Index]
135 '''<index><title/></index>'''
139 [include example_adapting_a_legacy_geometry_object_model.qbk]
142 [include release_notes.qbk]
144 [/ TODO: [include guidelines.qbk] /]
145 [include about_documentation.qbk]
146 [include acknowledgments.qbk]