reference.qbk 11 KB

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