groups.hpp 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. // Boost.Geometry (aka GGL, Generic Geometry Library)
  2. //
  3. // Copyright (c) 2011-2012 Barend Gehrels, Amsterdam, the Netherlands.
  4. // This file was modified by Oracle on 2018.
  5. // Modifications copyright (c) 2018, Oracle and/or its affiliates.
  6. // Contributed and/or modified by Vissarion Fysikopoulos, on behalf of Oracle
  7. // Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
  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. // File defining groups for Doxygen.
  12. // Note that group descriptions are (currently) not used.
  13. /*!
  14. \defgroup access access: get/set coordinate values, make objects, clear geometries, append point(s)
  15. \defgroup append append: append points to geometries
  16. \defgroup area area: calculate area of a Geometry
  17. \defgroup arithmetic arithmetic: arithmetic operations on points
  18. \defgroup assign assign: assign values to geometries
  19. \defgroup buffer buffer: calculate buffer of a geometry
  20. \defgroup centroid centroid: calculate centroid (center of gravity) of a geometry
  21. \defgroup clear clear: clear geometries
  22. \defgroup compare compare: define compare functors for points
  23. \defgroup concepts geometry concepts: defines and checks concepts for geometries
  24. \defgroup convert convert: convert geometries from one type to another
  25. \defgroup convex_hull convex hull: calculate the convex hull of a geometry
  26. \defgroup core core: meta-functions for geometry types
  27. \defgroup correct correct: correct geometries
  28. \defgroup covered_by covered_by: detect if a geometry is inside or on the border of another geometry, a.o. point-in-polygon (border included)
  29. \defgroup crosses crosses: detect if two geometries crosses each other
  30. \defgroup cs coordinate systems
  31. \defgroup densify densify: add points to geometry, keeping shape
  32. \defgroup difference difference: difference of two geometries
  33. \defgroup discrete_frechet_distance discrete_frechet_distance : calculate discrete frechet distance between two geometries
  34. \defgroup discrete_hausdorff_distance discrete_hausdorff_distance : calculate discrete hausdorff distance between two geometries
  35. \defgroup disjoint disjoint: detect if geometries are not spatially related
  36. \defgroup distance distance: calculate distance between two geometries
  37. \defgroup dsv: stream DSV (Delimiter-Separated Values)
  38. \defgroup enum enum: enumerations
  39. \defgroup envelope envelope: calculate envelope (minimum bounding rectangle) of a geometry
  40. \defgroup equals equals: detect if two geometries are spatially equal
  41. \defgroup expand expand: add a geometry to a bounding box
  42. \defgroup exterior_ring exterior_ring: exterior_ring
  43. \defgroup for_each for_each: apply a functor to each point or segment of a geometry
  44. \defgroup geometries geometries: geometries provided by default
  45. \defgroup get get: get geometries
  46. \defgroup interior_rings interior_rings: interior_rings
  47. \defgroup intersection intersection: calculate new geometry
  48. \defgroup intersects intersects: detect if a geometry self-intersects or if two geometries intersect
  49. \defgroup is_empty is_empty: detect if a geometry is the empty set
  50. \defgroup is_simple is_simple: detect if a geometry is simple
  51. \defgroup is_valid is_valid: detect if a geometry is valid
  52. \defgroup iterators iterators: iterators
  53. \defgroup length length: calculate length of a linear geometry
  54. \defgroup line_interpolate line_interpolate: interpolates points on a linestring
  55. \defgroup make make: construct geometries
  56. \defgroup num_geometries number of geometries: calculate the number of geometries in a multi-geometry
  57. \defgroup num_interior_rings number of interior rings: calculate the number of interior rings
  58. \defgroup num_points number of points: calculate number of points of a geometry
  59. \defgroup num_segments number of segments: calculate number of segments of a geometry
  60. \defgroup overlaps overlaps: detect overlap between two geometries
  61. \defgroup perimeter perimeter: calculate perimeter of a geometry
  62. \defgroup projection projection: Projection struct's, classes
  63. \defgroup projections projections: Projections
  64. \defgroup ranges ranges: ranges
  65. \defgroup register register: Macros for registration
  66. \defgroup relate relate: check spatial relation between two geometries
  67. \defgroup relation relation: calculate spatial relation between two geometries
  68. \defgroup reverse reverse: reverse a geometry
  69. \defgroup selected selection: check if a geometry is "selected" by a point
  70. \defgroup set set: set geometries
  71. \defgroup simplify simplify: remove points from a geometry, keeping shape (simplification or generalization)
  72. \defgroup srs srs: Spatial Reference System definition
  73. \defgroup strategies strategies: strategies
  74. \defgroup svg svg: Stream SVG (Scalable Vector Graphics)
  75. \defgroup sym_difference sym_difference: sym_difference of two geometries
  76. \defgroup touches touches: detect if a geometry self-touches or if two geometries touch
  77. \defgroup traits traits: adapt geometries
  78. \defgroup transform transform: apply transformations on geometries
  79. \defgroup union union: calculate new geometry containing geometries A or B
  80. \defgroup unique unique: make a geometry unique w.r.t. points,
  81. \defgroup within within: detect if a geometry is inside another geometry, a.o. point-in-polygon
  82. \defgroup wkt wkt: parse and stream WKT (Well-Known Text)
  83. */