From 2c13449f27cff9b2630f8a548df08f1aa1410213 Mon Sep 17 00:00:00 2001 From: cjamin Date: Tue, 4 Oct 2016 13:27:32 +0000 Subject: Mention farthest search option everywhere git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/subsampling_and_spatialsearching@1621 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 098ada4430780a45eb01a2b25be275752370a08e --- src/Spatial_searching/include/gudhi/Kd_tree_search.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'src') diff --git a/src/Spatial_searching/include/gudhi/Kd_tree_search.h b/src/Spatial_searching/include/gudhi/Kd_tree_search.h index ff630e9d..314342b6 100644 --- a/src/Spatial_searching/include/gudhi/Kd_tree_search.h +++ b/src/Spatial_searching/include/gudhi/Kd_tree_search.h @@ -41,19 +41,19 @@ namespace spatial_searching { /** * \class Kd_tree_search Kd_tree_search.h gudhi/Kd_tree_search.h - * \brief Spatial tree data structure to perform (approximate) nearest neighbor search. + * \brief Spatial tree data structure to perform (approximate) nearest and farthest neighbor search. * * \ingroup spatial_searching * * \details * The class Kd_tree_search is a tree-based data structure, based on * CGAL dD spatial searching data structures. - * It provides a simplified API to perform (approximate) nearest neighbor searches. Contrary to CGAL default behavior, the tree + * It provides a simplified API to perform (approximate) nearest and farthest neighbor searches. Contrary to CGAL default behavior, the tree * does not store the points themselves, but stores indices. * - * There are two types of queries: the k-nearest neighbor query, where k is fixed and the k nearest points are - * computed right away, - * and the incremental nearest neighbor query, where no number of neighbors is provided during the call, as the + * There are two types of queries: the k-nearest or k-farthest neighbor query, where k is fixed and the k nearest + * or farthest points are computed right away, + * and the incremental nearest or farthest neighbor query, where no number of neighbors is provided during the call, as the * neighbors will be computed incrementally when the iterator on the range is incremented. * * \tparam K must be a model of the K_neighbor_search; typedef typename K_neighbor_search::Tree Tree; typedef typename K_neighbor_search::Distance Distance; - /// \brief The range returned by a k-nearest neighbor search. + /// \brief The range returned by a k-nearest or k-farthest neighbor search. /// Its value type is `std::pair` where `first` is the index /// of a point P and `second` is the squared distance between P and the query point. typedef K_neighbor_search KNS_range; @@ -100,7 +100,7 @@ public: typedef CGAL::Orthogonal_incremental_neighbor_search< STraits, Distance, CGAL::Sliding_midpoint, Tree> Incremental_neighbor_search; - /// \brief The range returned by an incremental nearest neighbor search. + /// \brief The range returned by an incremental nearest or farthest neighbor search. /// Its value type is `std::pair` where `first` is the index /// of a point P and `second` is the squared distance between P and the query point. typedef Incremental_neighbor_search INS_range; -- cgit v1.2.3