ceph/src/boost/libs/geometry/doc/doxy/doxygen_input/groups/groups.hpp

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