Merge pull request #5231 from MaelRL/Spatial_search-Clean_concept-GF

Rename 'D' to 'Dimension'
This commit is contained in:
Laurent Rineau 2020-12-04 17:15:38 +01:00
commit da6cbdcf4a
1 changed files with 9 additions and 9 deletions

View File

@ -18,7 +18,7 @@ public:
/*!
Dimension Tag.
*/
typedef unspecified_type D;
typedef unspecified_type Dimension;
/*!
represents a `d`-dimensional point.
@ -36,30 +36,30 @@ 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,D>& rectangle) const;
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,D>& rectangle) const;
bool outer_range_contains(const Kd_tree_rectangle<FT,Dimension>& rectangle) const;
/// @}