cgal/Spatial_searching/doc/Spatial_searching/PackageDescription.txt

115 lines
4.1 KiB
Plaintext

/// \defgroup PkgSpatialSearchingDRef dD Spatial Searching Reference
/// \defgroup PkgSpatialSearchingDConcepts Concepts
/// \ingroup PkgSpatialSearchingDRef
/// \defgroup SearchClasses Search Classes
/// \ingroup PkgSpatialSearchingDRef
/// \defgroup RangeQueryItemClasses Range Query Item Classes
/// \ingroup PkgSpatialSearchingDRef
/// \defgroup SearchTraitsClasses Search Traits Classes
/// \ingroup PkgSpatialSearchingDRef
/// \defgroup DistanceClasses Distance Classes
/// \ingroup PkgSpatialSearchingDRef
/// \defgroup SplitterClasses Splitter Classes
/// \ingroup PkgSpatialSearchingDRef
/// \defgroup AdvancedClasses Advanced Classes
/// \ingroup PkgSpatialSearchingDRef
/*!
\addtogroup PkgSpatialSearchingDRef
\cgalPkgDescriptionBegin{dD Spatial Searching,PkgSpatialSearchingD}
\cgalPkgPicture{windowQuery.png}
\cgalPkgSummaryBegin
\cgalPkgAuthors{Hans Tangelder and Andreas Fabri}
\cgalPkgDesc{This package implements exact and approximate distance browsing by providing exact and approximate algorithms for range searching, k-nearest and k-furthest neighbor searching, as well as incremental nearest and incremental furthest neighbor searching, where the query items are points in dD Euclidean space.}
\cgalPkgManuals{Chapter_dD_Spatial_Searching,PkgSpatialSearchingDRef}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{3.0}
\cgalPkgBib{cgal:tf-ssd}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{2D Spatial Searching,spatial_searching.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
This package provides data structures and algorithms for exact and approximate distance browsing,
supporting
- both nearest and furthest neighbor searching,
- both exact and approximate searching,
- (approximate) range searching,
- (approximate) `k`-nearest and `k`-furthest neighbor searching,
- (approximate) incremental nearest and incremental furthest neighbor searching,
- query items representing points and spatial objects.
The spatial searching package consists of the following concepts and
classes that are described in the reference pages.
\cgalClassifedRefPages
\cgalCRPSection{Search Classes}
- `CGAL::K_neighbor_search<Traits, GeneralDistance, Splitter, SpatialTree>`
- `CGAL::Incremental_neighbor_search<Traits, GeneralDistance, Splitter, SpatialTree>`
- `CGAL::Orthogonal_incremental_neighbor_search<Traits, OrthogonalDistance, Splitter, SpatialTree>`
- `CGAL::Orthogonal_k_neighbor_search<Traits, OrthogonalDistance, Splitter, SpatialTree>`
- `CGAL::Kd_tree<Traits, Splitter, UseExtendedNode>`
\cgalCRPSection{%Range Query Item Classes}
- `CGAL::Fuzzy_iso_box<Traits>`
- `CGAL::Fuzzy_sphere<Traits>`
\cgalCRPSection{Search Traits Classes}
- `CGAL::Search_traits_2<Kernel>`
- `CGAL::Search_traits_3<Kernel>`
- `CGAL::Search_traits_d<Kernel>`
- `CGAL::Search_traits<NT,Point,CartesianIterator,ConstructCartesianIterator,ConstructMinVertex,ConstructMaxVertex>`
- `CGAL::Search_traits_adapter<Key,PointPropertyMap,BaseTraits>`
\cgalCRPSection{Distance Classes}
- `CGAL::Euclidean_distance<Traits>`
- `CGAL::Euclidean_distance_sphere_point<Traits>`
- `CGAL::Manhattan_distance_iso_box_point<Traits>`
- `CGAL::Weighted_Minkowski_distance<Traits>`
- `CGAL::Distance_adapter<Key,PointPropertyMap,Base_distance>`
\cgalCRPSection{%Splitter Classes}
- `CGAL::Sliding_midpoint<Traits, SpatialSeparator>`
- `CGAL::Sliding_fair<Traits, SpatialSeparator>`
- `CGAL::Fair<Traits, SpatialSeparator>`
- `CGAL::Median_of_max_spread<Traits, SpatialSeparator>`
- `CGAL::Median_of_rectangle<Traits, SpatialSeparator>`
- `CGAL::Midpoint_of_max_spread<Traits, SpatialSeparator>`
- `CGAL::Midpoint_of_rectangle<Traits, SpatialSeparator>`
\cgalCRPSection{Advanced Classes}
- `CGAL::Kd_tree_node<Traits, Splitter, UseExtendedNode>`
- `CGAL::Kd_tree_leaf_node<Traits, Splitter, UseExtendedNode>`
- `CGAL::Kd_tree_internal_node<Traits, Splitter, UseExtendedNode>`
- `CGAL::Kd_tree_rectangle<FT,Dimension>`
- `CGAL::Plane_separator<FT>`
- `CGAL::Point_container<Traits>`
\cgalCRPSection{Concepts}
- `FuzzyQueryItem`
- `GeneralDistance`
- `OrthogonalDistance`
- `SearchTraits`
- `SearchGeomTraits_3`
- `SearchGeomTraits_2`
- `RangeSearchTraits`
- `SpatialSeparator`
- `SpatialTree`
- `Splitter`
*/