libs/geometry/doc/geometry.qbk

   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 [library Geometry
  14     [quickbook 1.5]
  15     [authors [Gehrels, Barend], [Lalande, Bruno], [Loskot, Mateusz]]
  16     [copyright 2009-2012 Barend Gehrels, Bruno Lalande, Mateusz Loskot]
  17     [purpose Documentation of Boost.Geometry library]
  18     [license
  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])
  22     ]
  23     [id geometry]
  24     [category geometry]
  25 ]
  26
  27 [/Behavior]
  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)]
  38 [def __box__  Rectangle]
  39 [def __segment__  Segment]
  40 [def __point__  Point]
  41 [def __linestring__  Linestring]
  42 [def __polygon__  Polygon]
  43 [def __ring__  Ring]
  44 [def __multi_point__  Multi Point]
  45 [def __multi_linestring__  Multi Linestring]
  46 [def __multi_polygon__  Multi Polygon]
  47 [def __range__  Rangelike (linestring, ring)]
  48 [def __other__  Other geometries]
  49 [def __nyiversion__  Not yet supported in this version]
  50
  51 [def __not_in_boost_geometry_hpp__ The standard header `boost/geometry.hpp` does not include this header.]
  52
  53
  54 [/Parts]
  55 [def __ret_zero__ Returns zero]
  56 [def __ret_one__ Returns 1]
  57 [def __does_nothing__ Nothing happens, geometry is unchanged]
  58 [def __cs_units__ in the same units as the input coordinates]
  59 [def __sph1__ on a unit sphere (or another sphere, if specified as such in the constructor of the strategy)]
  60 [template qbk_ret[what] Returns [what]]
  61 [template qbk_out[what] GeometryOut is a [what]]
  62
  63 [def __boost__ Boost]
  64 [def __boost_geometry__ Boost.Geometry]
  65 [def __boost_array__ Boost.Array]
  66 [def __boost_fusion__ Boost.Fusion]
  67 [def __boost_mpl__ Boost.MPL]
  68 [def __boost_range__ Boost.Range]
  69 [def __boost_tuple__ Boost.Tuple]
  70 [def __boost_gil__ [@http://www.boost.org/libs/gil/ Boost.GIL]]
  71 [def __boost_bb__ Boost.Build]
  72
  73 [def __ttmath__ [@http://www.ttmath.org/ ttmath]]
  74 [def __ogc__ [@http://www.opengeospatial.org OGC]]
  75
  76 [def __ogc_sf__ [@http://www.opengeospatial.org/standards/sfa OGC Simple Feature Specification]]
  77
  78 [/Templates]
  79 [template concept[name type]
  80 The [name] Concept describes the requirements for a [type] type.
  81 All algorithms in Boost.Geometry will check any geometry arguments against the concept requirements.
  82 ]
  83
  84 [template heading_conformance_no_ogc[function]
  85 [heading Conformance]
  86 The function [function] is not defined by OGC.
  87 ]
  88
  89 [template heading_conformance_ogc[function ogc_function]
  90 [heading Conformance]
  91 The function [function] implements function [ogc_function] from the __ogc_sf__.
  92 ]
  93
  94 [template conformance_std[function std_function]
  95 The function [function] conforms to the [std_function] of the C++ std-library.
  96 ]
  97
  98 [template see_boost_range_sample[concept]
  99 [note See also the sample in the [@../../../range/doc/html/range/reference/extending/method_2.html Boost.Range documentation]
 100   showing how a type can be adapted to a Boost.Range to fulfill the concept of a [concept]
 101 ]
 102 ]
 103
 104
 105 [heading Contributions]
 106
 107 Boost.Geometry contains contributions by:
 108
 109 * Akira Takahashi (adaption of Boost.Fusion)
 110 * Alfredo Correa (adaption of Boost.Array)
 111 * Adam Wulkiewicz (spatial indexes) [footnote Currently an extension]
 112 * Federico Fern\u00E1ndez (spatial indexes) [footnote Currently an extension]
 113
 114 [include imports.qbk]
 115
 116 [include introduction.qbk]
 117 [include quickstart.qbk]
 118
 119 [include design_rationale.qbk]
 120 [include compiling.qbk]
 121
 122 [section Indexes]
 123 [include matrix.qbk]
 124 [section Alphabetical Index]
 125 '''<index><title/></index>'''
 126 [endsect]
 127 [endsect]
 128
 129 [include reference.qbk]
 130
 131 [include release_notes.qbk]
 132
 133 [include about_documentation.qbk]
 134 [include acknowledgments.qbk]