reference.qbk 11.2 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
[/============================================================================
  Boost.Geometry (aka GGL, Generic Geometry Library)

  Copyright (c) 2009-2017 Barend Gehrels, Amsterdam, the Netherlands.
  Copyright (c) 2009-2017 Mateusz Loskot, London, UK.
  Copyright (c) 2009-2017 Bruno Lalande, Paris, France.
  Copyright (c) 2013-2017 Adam Wulkiewicz, Lodz, Poland.

  This file was modified by Oracle on 2014-2021.
  Modifications copyright (c) 2014-2021, Oracle and/or its affiliates.

  Contributed and/or modified by Vissarion Fysikopoulos, on behalf of Oracle
  Contributed and/or modified by Menelaos Karavelas, on behalf of Oracle
  Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle

  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:reference Reference]


[section:access Access Functions]

[/ This section is not ordered alfabetically 
   to have get/set first and then the rings]

[section:get get]
[include generated/get.qbk]
[endsect]

[section:set set]
[include generated/set.qbk]
[endsect]

[section:exterior_ring exterior_ring]
[include generated/exterior_ring.qbk]
[endsect]

[section:interior_rings interior_rings]
[include generated/interior_rings.qbk]
[endsect]

[endsect] [/access functions]

[section:adapted Adapted models]
[include reference/geometries/adapted/c_array.qbk]
[include reference/geometries/adapted/std_array.qbk]
[include reference/geometries/adapted/boost_array.qbk]
[include reference/geometries/adapted/boost_fusion.qbk]
[include reference/geometries/adapted/boost_tuple.qbk]
[section:boost_polygon Boost.Polygon]
[include reference/geometries/adapted/boost_polygon/point_data.qbk]
[include reference/geometries/adapted/boost_polygon/rectangle_data.qbk]
[include reference/geometries/adapted/boost_polygon/polygon_data.qbk]
[include reference/geometries/adapted/boost_polygon/polygon_with_holes_data.qbk]
[endsect]
[section:boost_range Boost.Range]
[include reference/geometries/adapted/boost_range/filtered.qbk]
[include reference/geometries/adapted/boost_range/reversed.qbk]
[include reference/geometries/adapted/boost_range/sliced.qbk]
[include reference/geometries/adapted/boost_range/strided.qbk]
[/ include reference/geometries/adapted/boost_range/uniqued.qbk]
[endsect]
[section:register Macro's for adaption]
[include generated/register.qbk]
[endsect]
[endsect]

[section:algorithms Algorithms]

[section:area area]
[include generated/area.qbk]
[endsect]

[section:assign assign]
[include generated/assign.qbk]
[endsect]

[include generated/append.qbk]

[section:azimuth azimuth]
[include generated/azimuth.qbk]
[endsect]

[section:buffer buffer]
[include generated/buffer.qbk]
[endsect]

[section:centroid centroid]
[include generated/centroid.qbk]
[endsect]

[include generated/clear.qbk]

[section:closest_points closest_points]
[include generated/closest_points.qbk]
[endsect]

[include generated/convert.qbk]

[section:convex_hull convex_hull]
[include generated/convex_hull.qbk]
[endsect]

[section:correct correct]
[include generated/correct.qbk]
[endsect]

[section:covered_by covered_by]
[include generated/covered_by.qbk]
[endsect]

[section:crosses crosses]
[include generated/crosses.qbk]
[endsect]

[section:densify densify]
[include generated/densify.qbk]
[endsect]

[section:difference difference]
[include generated/difference.qbk]
[endsect]

[section:discrete_frechet_distance discrete_frechet_distance]
[include generated/discrete_frechet_distance.qbk]
[endsect]

[section:discrete_hausdorff_distance discrete_hausdorff_distance]
[include generated/discrete_hausdorff_distance.qbk]
[endsect]

[section:disjoint disjoint]
[include generated/disjoint.qbk]
[endsect]

[section:distance distance]
[include generated/distance.qbk]
[endsect]

[section:envelope envelope]
[include generated/envelope.qbk]
[endsect]

[section:equals equals]
[include generated/equals.qbk]
[endsect]

[section:expand expand]
[include generated/expand.qbk]
[endsect]

[section:for_each for_each]
[include generated/for_each.qbk]
[endsect]

[section:intersection intersection]
[include generated/intersection.qbk]
[endsect]

[section:intersects intersects]
[include generated/intersects.qbk]
[endsect]

[include generated/is_empty.qbk]

[section:is_simple is_simple]
[include generated/is_simple.qbk]
[endsect]

[section:is_valid is_valid]
[include generated/is_valid.qbk]
[endsect]

[section:length length]
[include generated/length.qbk]
[endsect]

[section:line_interpolate line_interpolate]
[include generated/line_interpolate.qbk]
[endsect]

[section:make make]
[include generated/make.qbk]
[endsect]

[include generated/num_geometries.qbk]
[include generated/num_interior_rings.qbk]
[include generated/num_points.qbk]
[include generated/num_segments.qbk]

[section:overlaps overlaps]
[include generated/overlaps.qbk]
[endsect]

[section:perimeter perimeter]
[include generated/perimeter.qbk]
[endsect]

[section:relate relate]
[include generated/relate.qbk]
[endsect]

[section:relation relation]
[include generated/relation.qbk]
[endsect]

[include generated/reverse.qbk]


[section:simplify simplify]
[include generated/simplify.qbk]
[endsect]

[section:sym_difference sym_difference]
[include generated/sym_difference.qbk]
[endsect]

[section:touches touches]
[include generated/touches.qbk]
[endsect]

[section:transform transform]
[include generated/transform.qbk]
[endsect]

[section:union_ union_]
[include generated/union.qbk]
[endsect]

[include generated/unique.qbk]

[section:within within]
[include generated/within.qbk]
[endsect]

[endsect] [/algorithms]

[section:arithmetic Arithmetic]
[include generated/arithmetic.qbk]
[endsect] 

[section:concepts Concepts]
[include concept/point.qbk]
[include concept/linestring.qbk]
[include concept/polygon.qbk]
[include concept/multi_point.qbk]
[include concept/multi_linestring.qbk]
[include concept/multi_polygon.qbk]
[include concept/box.qbk]
[include concept/ring.qbk]
[include concept/segment.qbk]
[endsect] [/concepts]

[section:constants Constants]
[include reference/core/min_corner.qbk]
[include reference/core/max_corner.qbk]
[endsect] 

[section:cs Coordinate Systems]
[include generated/cartesian.qbk]
[include generated/spherical.qbk]
[include generated/spherical_equatorial.qbk]
[include generated/geographic.qbk]
[endsect] [/coordinate systems]

[section:core Core Metafunctions]
[include generated/closure.qbk]
[include generated/coordinate_system.qbk]
[include generated/coordinate_type.qbk]
[include generated/cs_tag.qbk]
[include generated/degree.qbk]
[include generated/dimension.qbk]
[include generated/interior_type.qbk]
[include generated/point_order.qbk]
[include generated/point_type.qbk]
[include generated/radian.qbk]
[include generated/ring_type.qbk]
[include generated/tag.qbk]
[include generated/tag_cast.qbk]
[endsect] [/core metafunctions]

[section:de9im DE-9IM]
[include generated/de9im_mask.qbk]
[include generated/de9im_matrix.qbk]
[include generated/de9im_static_mask.qbk]
[endsect] 

[section:enumerations Enumerations]
[include generated/enum.qbk]
[endsect] 

[section:exceptions Exceptions]
[include generated/exception.qbk]
[include generated/centroid_exception.qbk]
[endsect] 


[section:io IO (input/output)]
[section:dsv DSV (Delimiter-Separated Values)]
[include generated/dsv.qbk]
[endsect]
[section:wkt WKT (Well-Known Text)]
[include reference/io/wkt_format.qbk]
[include generated/wkt.qbk]
[endsect]
[section:svg SVG (Scalable Vector Graphics)]
[include generated/svg.qbk]
[include generated/svg_mapper.qbk]
[endsect]
[endsect] 


[section:iterators Iterators]
[include generated/closing_iterator.qbk]
[include generated/circular_iterator.qbk]
[include generated/ever_circling_iterator.qbk]
[endsect] 


[section:models Models]

[include generated/point.qbk]
[include generated/point_xy.qbk]
[include generated/point_xyz.qbk]
[include generated/linestring.qbk]
[include generated/polygon.qbk]
[include generated/multi_point.qbk]
[include generated/multi_linestring.qbk]
[include generated/multi_polygon.qbk]
[include generated/box.qbk]
[include generated/ring.qbk]
[include generated/segment.qbk]
[include generated/referring_segment.qbk]
[endsect]


[section:spatial_indexes Spatial Indexes]

[/section:rtree R-tree]
[include index/generated/rtree.qbk]
[include index/generated/rtree_functions.qbk]
[section:parameters R-tree parameters (boost::geometry::index::)]
[include index/generated/rtree_linear.qbk]
[include index/generated/rtree_quadratic.qbk]
[include index/generated/rtree_rstar.qbk]
[include index/generated/rtree_dynamic_linear.qbk]
[include index/generated/rtree_dynamic_quadratic.qbk]
[include index/generated/rtree_dynamic_rstar.qbk]
[endsect]
[/endsect]

[section:observers Observers (boost::geometry::index::)]
[include index/generated/indexable.qbk]
[include index/generated/equal_to.qbk]
[endsect]
[include index/generated/inserters.qbk]
[include index/generated/adaptors.qbk]

[include index/generated/predicates.qbk]
[/include index/generated/nearest_relations.qbk]

[endsect]

[section:srs SRS]
[include generated/srs_spheroid.qbk]
[endsect]

[section:strategies Strategies]
[include generated/area_cartesian.qbk]
[include generated/area_spherical.qbk]
[include generated/area_geographic.qbk]
[include generated/buffer_join_round.qbk]
[include generated/buffer_join_miter.qbk]
[include generated/buffer_end_round.qbk]
[include generated/buffer_end_flat.qbk]
[include generated/buffer_distance_symmetric.qbk]
[include generated/buffer_distance_asymmetric.qbk]
[include generated/buffer_point_circle.qbk]
[include generated/buffer_point_square.qbk]
[include generated/buffer_geographic_point_circle.qbk]
[include generated/buffer_side_straight.qbk]
[include generated/centroid_average.qbk]
[include generated/centroid_bashein_detmer.qbk]
[include generated/densify_cartesian.qbk]
[include generated/densify_geographic.qbk]
[include generated/densify_spherical.qbk]
[include generated/distance_pythagoras.qbk]
[include generated/distance_pythagoras_box_box.qbk]
[include generated/distance_pythagoras_point_box.qbk]
[include generated/distance_haversine.qbk]
[include generated/distance_projected_point.qbk]
[include generated/distance_cross_track.qbk]
[include generated/distance_cross_track_point_box.qbk]
[include generated/line_interpolate_cartesian.qbk]
[include generated/line_interpolate_geographic.qbk]
[include generated/line_interpolate_spherical.qbk]
[include generated/side_side_by_triangle.qbk]
[include generated/side_side_by_cross_track.qbk]
[include generated/side_spherical_side_formula.qbk]
[include generated/side_geographic.qbk]
[include generated/simplify_douglas_peucker.qbk]
[include generated/transform_inverse_transformer.qbk]
[include generated/transform_map_transformer.qbk]
[include generated/transform_rotate_transformer.qbk]
[include generated/transform_scale_transformer.qbk]
[include generated/transform_translate_transformer.qbk]
[include generated/transform_matrix_transformer.qbk]
[include generated/within_winding.qbk]
[include generated/within_franklin.qbk]
[include generated/within_crossings_multiply.qbk]
[endsect] 


[section:views Views]
[include generated/box_view.qbk]
[include generated/segment_view.qbk]
[include generated/closeable_view.qbk]
[include generated/reversible_view.qbk]
[include generated/identity_view.qbk]
[endsect] 


[endsect] [/reference]