From 72f48d7e8d902813c36e52b650cc692fee3f64cf Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Fri, 23 Nov 2012 13:59:31 +0100 Subject: [PATCH] Polish dD Spatial Searching --- .../Spatial_searching/CGAL/Euclidean_distance.h | 2 +- .../CGAL/Euclidean_distance_sphere_point.h | 2 +- .../doc/Spatial_searching/CGAL/Fuzzy_iso_box.h | 2 +- .../doc/Spatial_searching/CGAL/Fuzzy_sphere.h | 2 +- .../CGAL/Incremental_neighbor_search.h | 14 +++++++------- .../Spatial_searching/CGAL/K_neighbor_search.h | 12 ++++++------ .../doc/Spatial_searching/CGAL/Kd_tree.h | 6 +++--- .../doc/Spatial_searching/CGAL/Kd_tree_node.h | 4 ++-- .../Spatial_searching/CGAL/Kd_tree_rectangle.h | 2 +- .../CGAL/Manhattan_distance_iso_box_point.h | 2 +- .../Orthogonal_incremental_neighbor_search.h | 14 +++++++------- .../CGAL/Orthogonal_k_neighbor_search.h | 17 ++++++++--------- .../Spatial_searching/CGAL/Point_container.h | 7 ++----- .../doc/Spatial_searching/CGAL/Search_traits.h | 2 +- .../Spatial_searching/CGAL/Search_traits_2.h | 6 +++--- .../Spatial_searching/CGAL/Search_traits_3.h | 6 +++--- .../Spatial_searching/CGAL/Search_traits_d.h | 7 +++---- .../doc/Spatial_searching/CGAL/Splitters.h | 6 +++--- .../CGAL/Weighted_Minkowski_distance.h | 2 +- .../Concepts/RangeSearchTraits.h | 4 ++-- .../Spatial_searching/Concepts/SearchTraits.h | 2 +- .../Spatial_searching/Concepts/SpatialTree.h | 2 +- 22 files changed, 59 insertions(+), 64 deletions(-) diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h index 77ab8631b95..8bcf8f4ac0e 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h @@ -10,7 +10,7 @@ To optimize distance computations squared distances are used. ### Parameters ### Expects for the first template argument a model of the concept -`SearchTraits`, for example `CGAL::Search_traits_2 >`. +`SearchTraits`, for example `Search_traits_2 >`. \cgalModels `OrthogonalDistance` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h index c69d05c4d96..fe7936bcdaa 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h @@ -12,7 +12,7 @@ Euclidean distance between a \f$ d\f$-dimensional sphere and a ### Parameters ### Expects for the template argument a model of the concept `SearchTraits`, -for example `CGAL::Cartesian_d`. +for example `Simple_cartesian_d`. \cgalModels `GeneralDistance` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h index ed1cae51817..db40785bfc8 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h @@ -63,7 +63,7 @@ Fuzzy_iso_box(Traits::Base::Point_d p, Traits::Base::Point_d q, FT epsilon=FT(0) /// @{ /*! -test whether `b` contains `p`. +test whether the fuzzy iso box contains `p`. */ bool contains(Point_d p) const; diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h index a6592d30412..9c4064bc610 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h @@ -59,7 +59,7 @@ Fuzzy_sphere(Traits::Base::Point_d center, FT radius, FT epsilon=FT(0), Traits t /// @{ /*! -test whether \f$ s\f$ contains \f$ p\f$. +test whether the fuzzy sphere contains `p`. */ bool contains(const Point_d& p) const; diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h index d4d76554d27..10b55ff4c67 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h @@ -9,20 +9,20 @@ on a tree. The tree may have extended or unextended nodes. ### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, -for example `CGAL::Search_traits_2 >`. +for example `Search_traits_2 >`. Expects for the second template argument a model of the concept `GeneralDistance`. If `Traits` is -`CGAL::Search_traits_adapter` -the default type is `CGAL::Distance_for_point_adapter >`, -and `CGAL::Euclidean_distance` otherwise. +`Search_traits_adapter` +the default type is `Distance_for_point_adapter >`, +and `Euclidean_distance` otherwise. Expects for third template argument a model of the concept `Splitter`. -The default type is `CGAL::Sliding_midpoint`. +The default type is `Sliding_midpoint`. Expects for fourth template argument a model of the concept `SpatialTree`. -The default type is `CGAL::Kd_tree`. The -template argument `CGAL::Tag_false` makes that the tree is built with unextended nodes. +The default type is `Kd_tree`. The +template argument `Tag_false` makes that the tree is built with unextended nodes. \sa `CGAL::Orthogonal_incremental_neighbor_search` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h index 965db709000..6529598971d 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h @@ -10,17 +10,17 @@ extended or unextended nodes. ### Parameters ### Expects for the first template argument an implementation of the concept `SearchTraits`, -for example `CGAL::Cartesian_d`. +for example `Simple_cartesian`. Expects for the second template argument a model of the concept `GeneralDistance`. If `Traits` is -`CGAL::Search_traits_adapter` -the default type is `CGAL::Distance_for_point_adapter >`, -and `CGAL::Euclidean_distance` otherwise. +`Search_traits_adapter` +the default type is `Distance_for_point_adapter >`, +and `Euclidean_distance` otherwise. Expects for fourth template argument an implementation of the concept `SpatialTree`. -The default type is `CGAL::Kd_tree`. The -template argument `CGAL::Tag_false` makes that the tree is built with unextended nodes. +The default type is `Kd_tree`. The +template argument `Tag_false` makes that the tree is built with unextended nodes. \sa `CGAL::Orthogonal_k_neighbor_search` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h index f3c13f61ea1..0c68351a7e7 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h @@ -8,13 +8,13 @@ The class `Kd_tree` defines a `k-d` tree. ### Parameters ### Expects for the first template argument a model of the concept -`SearchTraits`, for example `CGAL::Search_traits_2 >`. +`SearchTraits`, for example `Search_traits_2 >`. Expects for the second template argument a model for the concept `Splitter`. It defaults to `Sliding_midpoint`. -Expects for the third template argument `CGAL::Tag_true`, if the -tree shall be built with extended nodes, and `CGAL::Tag_false` otherwise. +Expects for the third template argument `Tag_true`, if the +tree shall be built with extended nodes, and `Tag_false` otherwise. \sa Tree \sa `CGAL::Kd_tree_node` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h index 8c5cf9dacaa..040daa91d91 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h @@ -5,7 +5,7 @@ namespace CGAL { The class `Kd_tree_node` implements a node class for a `k-d` tree. -\cgalAdvanced A node is either a leaf node, an internal node or an +A node is either a leaf node, an internal node or an extended internal node. A leaf node contains one or more points. An internal node contains a pointer to its lower child, a pointer to its upper child, and a pointer to its separator. An extended internal @@ -15,7 +15,7 @@ extended node's rectangle along the node's cutting dimension. ### Parameters ### Expects for the template argument a model of the concept `SearchTraits`, -for example `CGAL::Search_traits_2 >`, or `CGAL::Cartesian_d`. +for example `Search_traits_2 >`, or `Cartesian_d`. */ template< typename Traits, typename Splitter, typename UseExtendedNode > diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_rectangle.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_rectangle.h index f929eed5692..ae130a7529a 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_rectangle.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_rectangle.h @@ -31,7 +31,7 @@ in each dimension. Kd_tree_rectangle(int d); /*! -Constructs the bounding box of the points in the range [`begin,end`), where the value +Constructs the bounding box of the points in the range `[begin,end)`, where the value type of `PointIter` can be used by operators of functors `Construct_cartesian_const_iterator_d` to define iterators with value type `FT`. */ diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h b/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h index dd2f5a57845..20720046906 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h @@ -13,7 +13,7 @@ and a `d`-dimensional iso-box defined as a `k-d` tree rectangle. ### Parameters ### Expects for the template argument a model for the concept -`SearchTraits`, for example `CGAL::Search_traits_3 >`. +`SearchTraits`, for example `Search_traits_3 >`. \cgalModels `GeneralDistance` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h index ec327b9e9c2..20bba94d980 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h @@ -8,20 +8,20 @@ The class `Orthogonal_incremental_neighbor_search` implements incremental neares ### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, -for example `CGAL::Search_traits_2 >`. +for example `Search_traits_2 >`. Expects for the second template argument a model of the concept `GeneralDistance`. If `Traits` is -`CGAL::Search_traits_adapter` -the default type is `CGAL::Distance_for_point_adapter >`, -and `CGAL::Euclidean_distance` otherwise. +`Search_traits_adapter` +the default type is `Distance_for_point_adapter >`, +and `Euclidean_distance` otherwise. Expects for third template argument a model of the concept `Splitter`. -The default type is `CGAL::Sliding_midpoint`. +The default type is `Sliding_midpoint`. Expects for fourth template argument a model of the concept `SpatialTree`. -The default type is `CGAL::Kd_tree`. The -template argument must be `CGAL::Tag_true` because orthogonal search needs extended +The default type is `Kd_tree`. The +template argument must be `Tag_true` because orthogonal search needs extended kd tree nodes. \sa `CGAL::Incremental_neighbor_search` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h index 09363787b30..71ac43b4527 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h @@ -10,23 +10,22 @@ using an orthogonal distance class. ### Parameters ### Expects for the first template argument an implementation of the concept `SearchTraits`, -for example `CGAL::Search_traits_2 >`. +for example `Search_traits_2 >`. Expects for the second template argument a model of the concept `GeneralDistance`. If `Traits` is -`CGAL::Search_traits_adapter` -the default type is `CGAL::Distance_adapter >`, -and `CGAL::Euclidean_distance` otherwise. +`Search_traits_adapter` +the default type is `Distance_adapter >`, +and `Euclidean_distance` otherwise. -The default type is -`CGAL::Euclidean_distance`. +The default type is `Euclidean_distance`. Expects for third template argument a model of the concept `Splitter`. -The default type is `CGAL::Sliding_midpoint`. +The default type is `Sliding_midpoint`. Expects for fourth template argument an implementation of the concept `SpatialTree`. -The default type is `CGAL::Kd_tree`. The -template argument must be `CGAL::Tag_true` because orthogonal search needs extended +The default type is `Kd_tree`. The +template argument must be `Tag_true` because orthogonal search needs extended kd tree nodes. \sa `CGAL::K_neighbor_search` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h b/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h index 200d2a00d6a..1ae10ae76d5 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h @@ -10,11 +10,8 @@ rectangle is called the associated rectangle. Provides a method to split a container and a number of methods to support the implementation of splitting rules. -### Parameters ### - -Expects for the template argument an implementation for -`d`-dimensional points of the concept `SearchTraits`, for example -`CGAL::Cartesian_d`. +\tparam Traits must be model of the concept `SearchTraits`, for example +`Simple_cartesian`. \sa `SearchTraits` \sa `SpatialSeparator` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h index 074dd410bb4..553a6f904cc 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgSpatialSearchingD +\ingroup SearchTraitsClasses The class `Search_traits` can be used as a template parameter of the kd tree and the search classes. It is a mere wrapper for the geometric types needed diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h index 72555c4424e..f51b03cc9ed 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h @@ -9,7 +9,7 @@ and the search classes. ### Parameters ### Expects for the template argument a model of the concept `Kernel`, -for example `CGAL::Cartesian` or `CGAL::Simple_cartesian`. +for example `Simple_cartesian` or `Simple_cartesian`. \cgalModels `SearchTraits` \cgalModels `RangeSearchTraits` @@ -46,13 +46,13 @@ Sphere type. typedef Kernel::Circle_2 Sphere_d; /*! -An iterator over the Cartesian coordinates. +An iterator over the %Cartesian coordinates. */ typedef Kernel::Cartesian_const_iterator_2 Cartesian_const_iterator_d; /*! A functor with -two function operators, which return the begin and past the end iterator for the Cartesian coordinates. +two function operators, which return the begin and past the end iterator for the %Cartesian coordinates. The functor for begin has as argument a `Point_d`. The functor for the past the end iterator, has as argument a `Point_d` and an `int`. */ diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h index 319d1b93fa3..584b82d342a 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h @@ -9,7 +9,7 @@ and the search classes. `Kernel` must be a \cgal kernel. ### Parameters ### Expects for the template argument a model of the concept `Kernel`, -for example `CGAL::Cartesian` or `CGAL::Simple_cartesian`. +for example `Simple_cartesian` or `Simple_cartesian`. \cgalModels `SearchTraits` \cgalModels `RangeSearchTraits` @@ -46,14 +46,14 @@ Sphere type. typedef Kernel::Sphere_3 Sphere_d; /*! -An iterator over the Cartesian +An iterator over the %Cartesian coordinates. */ typedef Kernel::Cartesian_const_iterator_3 Cartesian_const_iterator_d; /*! A functor with -two function operators, which return the begin and past the end iterator for the Cartesian coordinates. +two function operators, which return the begin and past the end iterator for the %Cartesian coordinates. The functor for begin has as argument a `Point_d`. The functor for the past the end iterator, has as argument a `Point_d` and an `int`. */ diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h index 09f4366ec56..31efabfc1ae 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h @@ -11,7 +11,7 @@ and the search classes. `Kernel` must be a \cgal kernel. ### Parameters ### Expects for the template argument a model of the concept `Kernel_d`, -for example `CGAL::Cartesian_d` or `CGAL::Homogeneous_d`. +for example `Cartesian_d`. \cgalModels `SearchTraits` \cgalModels `RangeSearchTraits` @@ -49,14 +49,13 @@ Sphere type. typedef Kernel::Sphere_d Sphere_d; /*! -An iterator over the Cartesian -coordinates. +An iterator over the %Cartesian coordinates. */ typedef Kernel::Cartesian_const_iterator_d Cartesian_const_iterator; /*! A functor with -two function operators, which return the begin and past the end iterator for the Cartesian coordinates. +two function operators, which return the begin and past the end iterator for the %Cartesian coordinates. The functor for begin has as argument a `Point_d`. The functor for the past the end iterator, has as argument a `Point_d` and an `int`. */ diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h b/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h index 019e4e12df0..4307df3bb15 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h @@ -17,11 +17,11 @@ the ratio of the resulting rectangles. ### Parameters ### Expects for the first template argument a model of -the concept `::SearchTraits`, -for example `Cartesian_d`. +the concept `SearchTraits`, +for example `Simple_cartesian`. Expects for the second template argument a model of the concept `SpatialSeparator`. -It has as default value the type, `CGAL::Plane_separator`. +It has as default value the type, `Plane_separator`. \cgalModels `Splitter` diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h b/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h index c1840ec1ce1..8c502d4e65c 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h @@ -13,7 +13,7 @@ the transformed distance \f$ {\sigma_{i=1}^{i=d} \, w_i(r_i-q_i)^p}\f$ instead o ### Parameters ### Expects for the template argument a model of the concept -`SearchTraits`, for example `CGAL::Search_traits_2`. +`SearchTraits`, for example `Search_traits_2`. \cgalModels `OrthogonalDistance` diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h b/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h index a2185590b68..46de7b70d1a 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h @@ -25,12 +25,12 @@ public: /// @{ /*! -Iso box type. It is only needed for range search queries. +Iso box type, which is only needed for range search queries. */ typedef Hidden_type Iso_box_d; /*! -Sphere type. It is only needed for range search queries. +Sphere type, which is only needed for range search queries. */ typedef Hidden_type Sphere_d; diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h b/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h index e7dd1db89d2..9e8d8185a96 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h @@ -42,7 +42,7 @@ typedef Hidden_type Cartesian_const_iterator_d; /*! Functor with operators to construct iterators on the first and the past-the-end iterator for the %Cartesian coordinates of a point. This functor must -provides the type `result_type` that must be the same a `Cartesian_const_iterator_d`. +provide the type `result_type` that must be the same a `Cartesian_const_iterator_d`. */ typedef Hidden_type Construct_cartesian_const_iterator_d; diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h index 98fc39d7934..58c67950034 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h @@ -106,7 +106,7 @@ Returns a const handle to the root node of the tree. Node_const_handle root() const; /*! -returns a const +Returns a const reference to the bounding box of the root node of the tree. */ const Kd_tree_rectangle& bounding_box() const;