From e17378e43e5ab1fc35152c39b9cb8a9accf7f3ff Mon Sep 17 00:00:00 2001 From: Simon Giraudot Date: Thu, 5 Mar 2020 12:19:26 +0100 Subject: [PATCH] Update doc --- Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h | 8 ++++---- .../doc/Spatial_searching/Spatial_searching.txt | 9 ++++++--- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h index 91292fe82ad..c27d0378a9a 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h @@ -23,7 +23,7 @@ in a dynamically allocated array (e.g., `Epick_d` with dynamic dimension) — we says "to a lesser extent" because the points are re-created by the kd-tree in a cache-friendly order after its construction, so the coordinates are more likely to be stored in a near-optimal order on the -heap. When EnablePointsCache` is set to `Tag_true`, the points +heap. When `EnablePointsCache` is set to `Tag_true`, the points coordinates will be cached in an optimal way. This will increase memory consumption but provide better search performance. See also the `GeneralDistance` and `FuzzyQueryItem` concepts for @@ -157,14 +157,14 @@ template void insert(InputIterator first, InputIterator be /*! Removes the point `p` from the `k-d` tree. It uses `equal_to_p` to identify the point after locating it, which can matter in particular when 2 points are -in the same place. `Identify_point` is a unary functor that takes a `Point_d` +in the same place. `IdentifyPoint` is a unary functor that takes a `Point_d` and returns a `bool`. This is a limited and naive implementation that does not rebalance the tree. On the other hand, the tree remains valid and ready for queries. If the internal data structure is not already built, for instance because the last operation was an insertion, it first calls `build()`. */ -template -void remove(Point_d p, Identify_point equal_to_p); +template +void remove(Point_d p, IdentifyPoint identify_point); /*! Removes point `p`, calling the 2-argument function `remove()` with a functor diff --git a/Spatial_searching/doc/Spatial_searching/Spatial_searching.txt b/Spatial_searching/doc/Spatial_searching/Spatial_searching.txt index bfd9058ffd7..b621d7372de 100644 --- a/Spatial_searching/doc/Spatial_searching/Spatial_searching.txt +++ b/Spatial_searching/doc/Spatial_searching/Spatial_searching.txt @@ -527,9 +527,12 @@ additional requirements when using such a cache. \section Spatial_searchingImplementationHistory Implementation History -The initial implementation of this package was done by Hans Tangelder and -Andreas Fabri. It was optimized in speed and memory consumption by Markus -Overtheil during an internship at GeometryFactory in 2014. +The initial implementation of this package was done by Hans Tangelder +and Andreas Fabri. It was optimized in speed and memory consumption by +Markus Overtheil during an internship at GeometryFactory in 2014. The +`EnablePointsCache` feature was introduced by ClĂ©ment Jamin in +2019. The parallel `kd` tree build function was introduced by Simon +Giraudot in 2020. */ } /* namespace CGAL */