songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update doc

This commit is contained in:
Simon Giraudot 2020-03-05 12:19:26 +01:00
parent ab3f7140a9
commit e17378e43e
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h
View File

@ -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 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, 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 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 coordinates will be cached in an optimal way. This will
increase memory consumption but provide better search performance. increase memory consumption but provide better search performance.
See also the `GeneralDistance` and `FuzzyQueryItem` concepts for See also the `GeneralDistance` and `FuzzyQueryItem` concepts for
@ -157,14 +157,14 @@ template <class InputIterator> void insert(InputIterator first, InputIterator be
/*! /*!
Removes the point `p` from the `k-d` tree. It uses `equal_to_p` to identify 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 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 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 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 queries. If the internal data structure is not already built, for instance
because the last operation was an insertion, it first calls `build()`. because the last operation was an insertion, it first calls `build()`.
*/ */
template<class Identify_point> template<class IdentifyPoint>
void remove(Point_d p, Identify_point equal_to_p); void remove(Point_d p, IdentifyPoint identify_point);
/*! /*!
Removes point `p`, calling the 2-argument function `remove()` with a functor Removes point `p`, calling the 2-argument function `remove()` with a functor

9
Spatial_searching/doc/Spatial_searching/Spatial_searching.txt
View File

@ -527,9 +527,12 @@ additional requirements when using such a cache.
\section Spatial_searchingImplementationHistory Implementation History \section Spatial_searchingImplementationHistory Implementation History
The initial implementation of this package was done by Hans Tangelder and The initial implementation of this package was done by Hans Tangelder
Andreas Fabri. It was optimized in speed and memory consumption by Markus and Andreas Fabri. It was optimized in speed and memory consumption by
Overtheil during an internship at GeometryFactory in 2014. 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 */ } /* namespace CGAL */