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

Tiny doc improvements

This commit is contained in:
Mael Rouxel-Labbé 2020-11-30 18:48:37 +01:00
parent 653dc4896f
commit c4c4b5b79d
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h
View File

@ -36,27 +36,27 @@ typedef unspecified_type FT;
/// @{
/*!
Test whether the query item contains `p`.
tests whether the query item contains `p`.
*/
bool contains(Point_d p) const;
/*!
Optional: must be defined when used with a `Kd_tree` where `EnablePointsCache`
is set to `Tag_true`.
Test whether the query item contains the point whose Cartesian coordinates
\note Optional: must be defined when used with a `Kd_tree` where `EnablePointsCache` is set to `Tag_true`.
tests whether the query item contains the point whose Cartesian coordinates
are contained in the range [`begin`, `end`).
*/
template <typename Coord_iterator>
bool contains_point_given_as_coordinates(Coord_iterator begin, Coord_iterator end) const;
/*!
Test whether the inner approximation of the spatial object intersects a rectangle
tests whether the inner approximation of the spatial object intersects a rectangle
associated with a node of a tree.
*/
bool inner_range_intersects(const Kd_tree_rectangle<FT,Dimension>& rectangle) const;
/*!
Test whether the outer approximation of the spatial object encloses the rectangle
tests whether the outer approximation of the spatial object encloses the rectangle
associated with a node of a tree.
*/
bool outer_range_contains(const Kd_tree_rectangle<FT,Dimension>& rectangle) const;