mirror of https://github.com/CGAL/cgal
56 lines
1.9 KiB
Plaintext
56 lines
1.9 KiB
Plaintext
/// \defgroup PkgPointSet2 2D Range and Neighbor Search Reference
|
|
/// \defgroup PkgPointSet2Concepts Concepts
|
|
/// \ingroup PkgPointSet2
|
|
|
|
/// \defgroup PkgPointSet2RangeSearch Range Search
|
|
/// \ingroup PkgPointSet2
|
|
|
|
/// \defgroup PkgPointSet2NeighborSearch Nearest Neighbor Search
|
|
/// \ingroup PkgPointSet2
|
|
|
|
/*!
|
|
\addtogroup PkgPointSet2
|
|
\todo check generated documentation
|
|
\cgalPkgDescriptionBegin{2D Range and Neighbor Search,PkgPointSet2Summary}
|
|
\cgalPkgPicture{Point_set_2/fig/point_set.png}
|
|
\cgalPkgSummaryBegin
|
|
\cgalPkgAuthor{Matthias Bäsken}
|
|
\cgalPkgDesc{This package supports circular, triangular, and isorectangular range search queries as well as (k) nearest neighbor search queries on 2D point sets. In contrast to the spatial searching package, this package uses a Delaunay triangulation as underlying data structure.}
|
|
\cgalPkgManuals{Chapter_2D_Range_and_Neighbor_Search,PkgPointSet2}
|
|
\cgalPkgSummaryEnd
|
|
\cgalPkgShortInfoBegin
|
|
\cgalPkgSince{2.1}
|
|
\cgalPkgDependsOn{\ref PkgTriangulation2Summary}
|
|
\cgalPkgBib{cgal:b-ss2}
|
|
\cgalPkgLicense{\ref licensesGPL "GPL"}
|
|
\cgalPkgShortInfoEnd
|
|
\cgalPkgDescriptionEnd
|
|
|
|
The two dimensional point set is a class for geometric queries. It
|
|
supports circular, triangular and iso rectangular range searches and
|
|
nearest neighbor searches. The point set is inherited from the \cgal
|
|
Delaunay triangulation data type. That means that it is a dynamic
|
|
data structure supporting the insertion and deletion of points.
|
|
|
|
This package also provides function template versions of the range
|
|
search and nearest neighbor query operations. They all have to be
|
|
templated by the type of a \cgal Delaunay triangulation and provide
|
|
functionality similar to the corresponding member functions of the
|
|
point set class.
|
|
|
|
\cgalClassifedRefPages
|
|
|
|
## Concepts ##
|
|
- `PointSetTraits`
|
|
|
|
## Classes ##
|
|
- `CGAL::Point_set_2`
|
|
|
|
## Functions ##
|
|
- `CGAL::nearest_neighbor()`
|
|
- `CGAL::nearest_neighbors()`
|
|
- `CGAL::range_search()`
|
|
|
|
*/
|
|
|