• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/============================================================================
2  Boost.Geometry (aka GGL, Generic Geometry Library)
3
4  Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
5  Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
6  Copyright (c) 2009-2012 Bruno Lalande, Paris, France.
7
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=============================================================================/]
12
13
14[section Introduction]
15
16__boost_geometry__  (aka Generic Geometry Library, GGL), part of collection of
17the Boost C++ Libraries, defines concepts, primitives and algorithms for solving
18geometry problems.
19
20__boost_geometry__  contains a dimension-agnostic, coordinate-system-agnostic
21and scalable kernel, based on concepts, meta-functions and tag dispatching.
22On top of that kernel, algorithms are built: area, length, perimeter, centroid,
23convex hull, intersection (clipping), within (point in polygon), distance,
24envelope (bounding box), simplify, transform, and much more.
25The library supports high precision arithmetic numbers, such as __ttmath__.
26
27__boost_geometry__  contains instantiable geometry classes, but library users can
28also use their own. Using registration macros or traits classes their geometries
29can be adapted to fulfil __boost_geometry__  concepts.
30
31__boost_geometry__  might be used in all domains where geometry plays a role:
32mapping and GIS, game development, computer graphics and widgets, robotics,
33astronomy and more. The core is designed to be as generic as possible and support
34those domains. For now, the development has been mostly GIS-oriented.
35
36The library follows existing conventions:
37
38* conventions from boost
39* conventions from the std library
40* conventions and names from one of the __ogc__ standards on geometry and, more
41    specificly, from the __ogc_sf__
42
43The library was first released with Boost 1.47.0 and from that point on it is
44officially part of the Boost C++ Libraries.
45
46Latest stable version of the source code is included in the
47[@http://www.boost.org/users/download/ Boost packaged releases].
48It can also be downloaded from the [@http://github.com/boostorg/boost Boost GitHub repository] (master branch).
49
50The library development upstream is available from the
51[@https://github.com/boostorg/geometry/tree/develop Boost.Geometry (develop branch)].
52
53Note that the library [*extensions] are not distributed in the official Boost
54releases, but only available
55in the [@https://github.com/boostorg/geometry/tree/develop Boost.Geometry (develop branch)]
56and that they are subject to change.
57
58__boost_geometry__ was accepted by Boost at November 28, 2009
59([@http://permalink.gmane.org/gmane.comp.lib.boost.announce/246 review report]).
60
61There is a __boost_geometry__ [@http://lists.boost.org/mailman/listinfo.cgi/geometry
62mailing list]. The mailing list and its messages are also accessible from
63[@http://boost-geometry.203548.n3.nabble.com/ Nabble] as Boost Geometry. Also on
64the [@http://lists.boost.org/mailman/listinfo.cgi/boost
65Boost Developers list] and on the [@http://lists.boost.org/mailman/listinfo.cgi/boost-users
66Boost Users list] __boost_geometry__ is discussed.
67
68[endsect]
69