ceph/src/boost/libs/geometry/doc/reference.qbk

   1 [/============================================================================
   2   Boost.Geometry (aka GGL, Generic Geometry Library)
   3
   4   Copyright (c) 2009-2014 Barend Gehrels, Amsterdam, the Netherlands.
   5   Copyright (c) 2009-2014 Mateusz Loskot, London, UK.
   6   Copyright (c) 2009-2014 Bruno Lalande, Paris, France.
   7   Copyright (c) 2013-2014 Adam Wulkiewicz, Lodz, Poland.
   8
   9   This file was modified by Oracle on 2014.
  10   Modifications copyright (c) 2014, Oracle and/or its affiliates.
  11
  12   Contributed and/or modified by Menelaos Karavelas, on behalf of Oracle
  13
  14   Use, modification and distribution is subject to the Boost Software License,
  15   Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  16   http://www.boost.org/LICENSE_1_0.txt)
  17 =============================================================================/]
  18
  19 [section:reference Reference]
  20
  21
  22 [section:access Access Functions]
  23
  24 [/ This section is not ordered alfabetically
  25    to have get/set first and then the rings]
  26
  27 [section:get get]
  28 [include generated/get.qbk]
  29 [endsect]
  30
  31 [section:set set]
  32 [include generated/set.qbk]
  33 [endsect]
  34
  35 [section:exterior_ring exterior_ring]
  36 [include generated/exterior_ring.qbk]
  37 [endsect]
  38
  39 [section:interior_rings interior_rings]
  40 [include generated/interior_rings.qbk]
  41 [endsect]
  42
  43 [endsect] [/access functions]
  44
  45 [section:adapted Adapted models]
  46 [include reference/geometries/adapted/c_array.qbk]
  47 [include reference/geometries/adapted/boost_array.qbk]
  48 [include reference/geometries/adapted/boost_fusion.qbk]
  49 [include reference/geometries/adapted/boost_tuple.qbk]
  50 [section:boost_polygon Boost.Polygon]
  51 [include reference/geometries/adapted/boost_polygon/point_data.qbk]
  52 [include reference/geometries/adapted/boost_polygon/rectangle_data.qbk]
  53 [include reference/geometries/adapted/boost_polygon/polygon_data.qbk]
  54 [include reference/geometries/adapted/boost_polygon/polygon_with_holes_data.qbk]
  55 [endsect]
  56 [section:boost_range Boost.Range]
  57 [include reference/geometries/adapted/boost_range/filtered.qbk]
  58 [include reference/geometries/adapted/boost_range/reversed.qbk]
  59 [include reference/geometries/adapted/boost_range/sliced.qbk]
  60 [include reference/geometries/adapted/boost_range/strided.qbk]
  61 [/ include reference/geometries/adapted/boost_range/uniqued.qbk]
  62 [endsect]
  63 [section:register Macro's for adaption]
  64 [include generated/register.qbk]
  65 [endsect]
  66 [endsect]
  67
  68 [section:algorithms Algorithms]
  69
  70 [section:area area]
  71 [include generated/area.qbk]
  72 [endsect]
  73
  74 [section:assign assign]
  75 [include generated/assign.qbk]
  76 [endsect]
  77
  78 [include generated/append.qbk]
  79
  80 [section:buffer buffer]
  81 [include generated/buffer.qbk]
  82 [endsect]
  83
  84 [section:centroid centroid]
  85 [include generated/centroid.qbk]
  86 [endsect]
  87
  88 [include generated/clear.qbk]
  89 [include generated/convert.qbk]
  90 [include generated/convex_hull.qbk]
  91 [include generated/correct.qbk]
  92
  93 [section:covered_by covered_by]
  94 [include generated/covered_by.qbk]
  95 [endsect]
  96
  97 [include generated/crosses.qbk]
  98
  99 [include generated/difference.qbk]
 100 [include generated/disjoint.qbk]
 101
 102 [section:distance distance]
 103 [include generated/distance.qbk]
 104 [endsect]
 105
 106 [section:envelope envelope]
 107 [include generated/envelope.qbk]
 108 [endsect]
 109
 110 [include generated/equals.qbk]
 111 [include generated/expand.qbk]
 112
 113 [section:for_each for_each]
 114 [include generated/for_each.qbk]
 115 [endsect]
 116
 117 [/section:intersection intersection]
 118 [include generated/intersection.qbk]
 119 [/endsect]
 120
 121 [section:intersects intersects]
 122 [include generated/intersects.qbk]
 123 [endsect]
 124
 125 [include generated/is_empty.qbk]
 126
 127 [include generated/is_simple.qbk]
 128
 129 [section:is_valid is_valid]
 130 [include generated/is_valid.qbk]
 131 [endsect]
 132
 133 [section:length length]
 134 [include generated/length.qbk]
 135 [endsect]
 136
 137 [section:make make]
 138 [include generated/make.qbk]
 139 [endsect]
 140
 141 [include generated/num_geometries.qbk]
 142 [include generated/num_interior_rings.qbk]
 143 [include generated/num_points.qbk]
 144 [include generated/num_segments.qbk]
 145
 146
 147 [include generated/overlaps.qbk]
 148
 149 [section:perimeter perimeter]
 150 [include generated/perimeter.qbk]
 151 [endsect]
 152
 153 [include generated/relate.qbk]
 154
 155 [include generated/relation.qbk]
 156
 157 [include generated/reverse.qbk]
 158
 159 [section:simplify simplify]
 160 [include generated/simplify.qbk]
 161 [endsect]
 162
 163 [/section:sym_difference sym_difference]
 164 [include generated/sym_difference.qbk]
 165 [/endsect]
 166
 167 [section:touches touches]
 168 [include generated/touches.qbk]
 169 [endsect]
 170
 171 [section:transform transform]
 172 [include generated/transform.qbk]
 173 [endsect]
 174
 175 [/section:union union]
 176 [include generated/union.qbk]
 177 [/endsect]
 178
 179 [include generated/unique.qbk]
 180
 181 [section:within within]
 182 [include generated/within.qbk]
 183 [endsect]
 184
 185 [endsect] [/algorithms]
 186
 187 [section:arithmetic Arithmetic]
 188 [include generated/arithmetic.qbk]
 189 [endsect]
 190
 191 [section:concepts Concepts]
 192 [include concept/point.qbk]
 193 [include concept/linestring.qbk]
 194 [include concept/polygon.qbk]
 195 [include concept/multi_point.qbk]
 196 [include concept/multi_linestring.qbk]
 197 [include concept/multi_polygon.qbk]
 198 [include concept/box.qbk]
 199 [include concept/ring.qbk]
 200 [include concept/segment.qbk]
 201 [endsect] [/concepts]
 202
 203 [section:constants Constants]
 204 [include reference/core/min_corner.qbk]
 205 [include reference/core/max_corner.qbk]
 206 [endsect]
 207
 208 [section:cs Coordinate Systems]
 209 [include generated/cartesian.qbk]
 210 [include generated/spherical.qbk]
 211 [include generated/spherical_equatorial.qbk]
 212 [include generated/geographic.qbk]
 213 [endsect] [/coordinate systems]
 214
 215 [section:core Core Metafunctions]
 216 [include generated/closure.qbk]
 217 [include generated/coordinate_system.qbk]
 218 [include generated/coordinate_type.qbk]
 219 [include generated/cs_tag.qbk]
 220 [include generated/degree.qbk]
 221 [include generated/dimension.qbk]
 222 [include generated/interior_type.qbk]
 223 [include generated/is_radian.qbk]
 224 [include generated/point_order.qbk]
 225 [include generated/point_type.qbk]
 226 [include generated/radian.qbk]
 227 [include generated/ring_type.qbk]
 228 [include generated/tag.qbk]
 229 [include generated/tag_cast.qbk]
 230 [endsect] [/core metafunctions]
 231
 232 [section:de9im DE-9IM]
 233 [include generated/de9im_mask.qbk]
 234 [include generated/de9im_matrix.qbk]
 235 [include generated/de9im_static_mask.qbk]
 236 [endsect]
 237
 238 [section:enumerations Enumerations]
 239 [include generated/enum.qbk]
 240 [endsect]
 241
 242 [section:exceptions Exceptions]
 243 [include generated/exception.qbk]
 244 [include generated/centroid_exception.qbk]
 245 [endsect]
 246
 247
 248 [section:io IO (input/output)]
 249 [section:wkt WKT (Well-Known Text)]
 250 [include reference/io/wkt_format.qbk]
 251 [include generated/wkt.qbk]
 252 [endsect]
 253 [section:svg SVG (Scalable Vector Graphics)]
 254 [include generated/svg.qbk]
 255 [include generated/svg_mapper.qbk]
 256 [endsect]
 257 [endsect]
 258
 259
 260 [section:iterators Iterators]
 261 [include generated/closing_iterator.qbk]
 262 [include generated/circular_iterator.qbk]
 263 [include generated/ever_circling_iterator.qbk]
 264 [endsect]
 265
 266
 267 [section:models Models]
 268
 269 [include generated/point.qbk]
 270 [include generated/point_xy.qbk]
 271 [include generated/linestring.qbk]
 272 [include generated/polygon.qbk]
 273 [include generated/multi_point.qbk]
 274 [include generated/multi_linestring.qbk]
 275 [include generated/multi_polygon.qbk]
 276 [include generated/box.qbk]
 277 [include generated/ring.qbk]
 278 [include generated/segment.qbk]
 279 [include generated/referring_segment.qbk]
 280 [endsect]
 281
 282
 283 [section:spatial_indexes Spatial Indexes]
 284
 285 [/section:rtree R-tree]
 286 [include index/generated/rtree.qbk]
 287 [include index/generated/rtree_functions.qbk]
 288 [section:parameters R-tree parameters (boost::geometry::index::)]
 289 [include index/generated/rtree_linear.qbk]
 290 [include index/generated/rtree_quadratic.qbk]
 291 [include index/generated/rtree_rstar.qbk]
 292 [include index/generated/rtree_dynamic_linear.qbk]
 293 [include index/generated/rtree_dynamic_quadratic.qbk]
 294 [include index/generated/rtree_dynamic_rstar.qbk]
 295 [endsect]
 296 [/endsect]
 297
 298 [section:observers Observers (boost::geometry::index::)]
 299 [include index/generated/indexable.qbk]
 300 [include index/generated/equal_to.qbk]
 301 [endsect]
 302 [include index/generated/inserters.qbk]
 303 [include index/generated/adaptors.qbk]
 304
 305 [include index/generated/predicates.qbk]
 306 [/include index/generated/nearest_relations.qbk]
 307
 308 [endsect]
 309
 310
 311 [section:strategies Strategies]
 312 [include generated/distance_pythagoras.qbk]
 313 [include generated/distance_pythagoras_box_box.qbk]
 314 [include generated/distance_pythagoras_point_box.qbk]
 315 [include generated/distance_haversine.qbk]
 316 [include generated/distance_projected_point.qbk]
 317 [include generated/distance_cross_track.qbk]
 318 [include generated/distance_cross_track_point_box.qbk]
 319 [include generated/area_surveyor.qbk]
 320 [include generated/area_huiller.qbk]
 321 [include generated/buffer_join_round.qbk]
 322 [include generated/buffer_join_miter.qbk]
 323 [include generated/buffer_end_round.qbk]
 324 [include generated/buffer_end_flat.qbk]
 325 [include generated/buffer_distance_symmetric.qbk]
 326 [include generated/buffer_distance_asymmetric.qbk]
 327 [include generated/buffer_point_circle.qbk]
 328 [include generated/buffer_point_square.qbk]
 329 [include generated/buffer_side_straight.qbk]
 330 [include generated/centroid_average.qbk]
 331 [include generated/centroid_bashein_detmer.qbk]
 332 [include generated/convex_hull_graham_andrew.qbk]
 333 [include generated/side_side_by_triangle.qbk]
 334 [include generated/side_side_by_cross_track.qbk]
 335 [include generated/side_spherical_side_formula.qbk]
 336 [include generated/simplify_douglas_peucker.qbk]
 337 [include generated/transform_inverse_transformer.qbk]
 338 [include generated/transform_map_transformer.qbk]
 339 [include generated/transform_rotate_transformer.qbk]
 340 [include generated/transform_scale_transformer.qbk]
 341 [include generated/transform_translate_transformer.qbk]
 342 [include generated/transform_ublas_transformer.qbk]
 343 [include generated/within_winding.qbk]
 344 [include generated/within_franklin.qbk]
 345 [include generated/within_crossings_multiply.qbk]
 346 [endsect]
 347
 348
 349 [section:views Views]
 350 [include generated/box_view.qbk]
 351 [include generated/segment_view.qbk]
 352 [include generated/closeable_view.qbk]
 353 [include generated/reversible_view.qbk]
 354 [include generated/identity_view.qbk]
 355 [endsect]
 356
 357
 358 [endsect] [/reference]