diff options
Diffstat (limited to 'libs/geometry/doc/introduction.qbk')
| -rw-r--r-- | libs/geometry/doc/introduction.qbk | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/libs/geometry/doc/introduction.qbk b/libs/geometry/doc/introduction.qbk new file mode 100644 index 000000000..dfac965d5 --- /dev/null +++ b/libs/geometry/doc/introduction.qbk @@ -0,0 +1,70 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + Copyright (c) 2009-2012 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 Introduction] + +__boost_geometry__ (aka Generic Geometry Library, GGL), part of collection of +the Boost C++ Libraries, defines concepts, primitives and algorithms for solving +geometry problems. + +__boost_geometry__ contains a dimension-agnostic, coordinate-system-agnostic +and scalable kernel, based on concepts, meta-functions and tag dispatching. +On top of that kernel, algorithms are built: area, length, perimeter, centroid, +convex hull, intersection (clipping), within (point in polygon), distance, +envelope (bounding box), simplify, transform, and much more. +The library supports high precision arithmetic numbers, such as __ttmath__. + +__boost_geometry__ contains instantiable geometry classes, but library users can +also use their own. Using registration macros or traits classes their geometries +can be adapted to fulfil __boost_geometry__ concepts. + +__boost_geometry__ might be used in all domains where geometry plays a role: +mapping and GIS, game development, computer graphics and widgets, robotics, +astronomy and more. The core is designed to be as generic as possible and support +those domains. For now, the development has been mostly GIS-oriented. + +The library follows existing conventions: + +* conventions from boost +* conventions from the std library +* conventions and names from one of the __ogc__ standards on geometry and, more + specificly, from the __ogc_sf__ + +The library was first released with Boost 1.47.0 and from that point on it is +officially part of the Boost C++ Libraries. + +Latest stable version of the source code is included in the +[@http://www.boost.org/users/download/ Boost packaged releases]. +It can also be downloaded from the current +[@http://svn.boost.org/svn/boost/branches/release Boost release branch] +in the Boost Subversion repository. + +The library development upstream is available from the +[@http://svn.boost.org/svn/boost/trunk Boost trunk] in the Boost Subversion +repository. + +Note that the library [*extensions] are not distributed in the official Boost +releases, but only available +in the [@http://svn.boost.org/svn/boost/trunk/boost/geometry/extensions/ Boost +trunk] +and that they are subject to change. + +__boost_geometry__ was accepted by Boost at November 28, 2009 +([@http://permalink.gmane.org/gmane.comp.lib.boost.announce/246 review report]). + +There is a __boost_geometry__ [@http://lists.boost.org/mailman/listinfo.cgi/geometry +mailing list]. The mailing list and its messages are also accessible from +[@http://boost-geometry.203548.n3.nabble.com/ Nabble] as Boost Geometry. Also on +the Boost Developers list and on the Boost Users list __boost_geometry__ is discussed. + +[endsect] |