diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h index fcd3f8f108e..d67f62dc03c 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h @@ -6,30 +6,26 @@ namespace CGAL { `Hilbert_policy` is a policy class which can be used to parameterize a strategy policy in order to specify the strategy for spatial sorting. -`Hilbert_policy` -or -`Hilbert_policy` -can be passed to -as parameter to -`hilbert_sort` to choose the sorting policy. +`Hilbert_policy` or `Hilbert_policy` +can be passed as parameter to +`hilbert_sort()` to choose the sorting policy. -### Parameters ### -`Tag` can only be either `Median` or `Middle` currently. +\tparam Tag must be either `Median` or `Middle`. \models ::DefaultConstructible, CopyConstructible \sa `Median` \sa `Middle` -\sa `Hilbert_sort__median_policy` -\sa `Hilbert_sort__middle_policy` +\sa `Hilbert_sort_median_policy` +\sa `Hilbert_sort_middle_policy` */ template< typename Tag > class Hilbert_policy { public: -/// @} + }; /* end Hilbert_policy */ } /* end namespace CGAL */ @@ -41,19 +37,9 @@ namespace CGAL { A typedef to `Hilbert_policy`. -\sa `Median` -\sa `Middle` -\sa `Hilbert_policy` -\sa `Hilbert_sort__middle_policy` - */ -class Hilbert_sort_median_policy { -public: - -/// @} - -}; /* end Hilbert_sort_median_policy */ + typedef Hilbert_policy Hilbert_sort_median_policy; } /* end namespace CGAL */ namespace CGAL { @@ -63,19 +49,9 @@ namespace CGAL { A typedef to `Hilbert_policy`. -\sa `Median` -\sa `Middle` -\sa `Hilbert_sort__median_policy` -\sa `Hilbert_policy` - */ -class Hilbert_sort_middle_policy { -public: - -/// @} - -}; /* end Hilbert_sort_middle_policy */ + typedef Hilbert_policy Hilbert_sort_middle_policy; } /* end namespace CGAL */ namespace CGAL { @@ -101,7 +77,6 @@ as parameter to class Median { public: -/// @} }; /* end Median */ } /* end namespace CGAL */ @@ -129,7 +104,6 @@ as parameter to class Middle { public: -/// @} }; /* end Middle */ } /* end namespace CGAL */ diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h index 8cc3f1116dc..f5aa1afb936 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h @@ -32,7 +32,7 @@ Hilbert_sort_2(const Traits &traits = Traits()); /*! sorts the range [`begin`, `end`). -\requires `RandomAccessIterator::value_type` equals to `Traits::Point_2`. +\requires `std::iterator_traits::value_type` equals to `Traits::Point_2`. */ template void operator() (RandomAccessIterator begin, RandomAccessIterator end) const; diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h index 62004a53417..bd8113788ac 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h @@ -31,7 +31,7 @@ Hilbert_sort_3(const Traits &traits = Traits()); /*! sorts the range [`begin`, `end`). -\requires `RandomAccessIterator::value_type` equals to `Traits::Point_3`. +\requires `std::iterator_traits::value_type` equals to `Traits::Point_3`. */ template void operator() (RandomAccessIterator begin, RandomAccessIterator end) const; diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h index d04bad53b04..abd96c16539 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h @@ -31,7 +31,7 @@ Hilbert_sort_d(const Traits &traits = Traits()); /*! sorts the range [`begin`, `end`). -\requires `RandomAccessIterator::value_type` equals to `Traits::Point_d`. +\requires `std::iterator_traits::value_type` equals to `Traits::Point_d`. */ template void operator() (RandomAccessIterator begin, RandomAccessIterator end) const; diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h index d40ee2833a5..b5fef4e76c2 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h @@ -8,10 +8,9 @@ reorder of the keys instead of the points, the comparisons being done on the ass In other words, the traits provides to a spatial sort algorithm a point type which is a key, while the actual point type is `Base_traits::Point_2`. -### Requirements ### -`Base_traits` is a model for `SpatialSortingTraits_2`. -`PointPropertyMap` is a model of boost::ReadablePropertyMap +\tparam Base_traits must be a model for `SpatialSortingTraits_2`. +\tparam PointPropertyMap must be a model of boost::ReadablePropertyMap with `Base_traits::Point_2` as `value_type`. \models ::SpatialSortingTraits_2 diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h index 896f20a866b..edb694466f9 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h @@ -8,10 +8,9 @@ reorder of the keys instead of the points, the comparisons being done on the ass In other words, the traits provides to a spatial sort algorithm a point type which is a key, while the actual point type is `Base_traits::Point_3`. -### Requirements ### -`Base_traits` is a model for `SpatialSortingTraits_3`. -`PointPropertyMap` is a model of boost::ReadablePropertyMap +\tparam Base_traits must be a model for `SpatialSortingTraits_3`. +\tparam PointPropertyMap must be a model of boost::ReadablePropertyMap with `Base_traits::Point_3` as `value_type`. \models ::SpatialSortingTraits_3 diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h index 30158520849..7fbc73f6984 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h @@ -8,10 +8,9 @@ reorder of the keys instead of the points, the comparisons being done on the ass In other words, the traits provides to a spatial sort algorithm a point type which is a key, while the actual point type is `Base_traits::Point_d`. -### Requirements ### -`Base_traits` is a model for `SpatialSortingTraits_d`. -`PointPropertyMap` is a model of boost::ReadablePropertyMap +\tparam Base_traits must be a model for `SpatialSortingTraits_d`. +\tparam PointPropertyMap must be a model of boost::ReadablePropertyMap with `Base_traits::Point_d` as `value_type`. \models ::SpatialSortingTraits_d diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/hilbert_sort.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/hilbert_sort.h index f3433fdf4b9..c610530ae57 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/hilbert_sort.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/hilbert_sort.h @@ -9,14 +9,14 @@ along a Hilbert curve. sorts the range [`begin`,`end`) in place. The default traits class `Default_traits` is the kernel in which the type -`RandomAccessIterator::value_type` is defined. +`std::iterator_traits::value_type` is defined. The default policy is `Hilbert_sort_median_policy()` and the other option is `Hilbert_sort_middle_policy()`. ### Requirements ###
    -
  1. `RandomAccessIterator::value_type` is convertible to +
  2. `std::iterator_traits::value_type` is convertible to `Traits::Point_2`, `Traits::Point_3`, or `Traits::Point_d`.
  3. `Traits` is a model for concept `SpatialSortingTraits_2`, `SpatialSortingTraits_3`, or `SpatialSortingTraits_d`. diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/spatial_sort.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/spatial_sort.h index 15f59d512f7..2d6ed36517d 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/spatial_sort.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/spatial_sort.h @@ -11,7 +11,7 @@ of being close in the order. sorts the range [`begin`,`end`) in place. The default traits class `Default_traits` is the kernel in which the type -`RandomAccessIterator::value_type` is defined. +`std::iterator_traits::value_type` is defined. The default policy is `Hilbert_sort_median_policy()` and the other option is `Hilbert_sort_middle_policy()`. @@ -21,7 +21,7 @@ The default values for the thresholds and the ratio depends on the dimension. ### Requirements ###
      -
    1. `RandomAccessIterator::value_type` is convertible to +
    2. `std::iterator_traits::value_type` is convertible to `Traits::Point_2`, `Traits::Point_3`, or `Traits::Point_d`.
    3. `Traits` is a model for concept `SpatialSortingTraits_2`, `SpatialSortingTraits_3`, or `SpatialSortingTraits_d`. diff --git a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h index 4fd534b9d32..9ef807a45fd 100644 --- a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h @@ -9,7 +9,7 @@ primitives (objects and predicates) that the sorting algorithms use. `SpatialSortingTraits_d` defines the complete set of primitives required in these functions and functors. -\hasModel Any \cgal \f$ d\f$ dimensional kernel. +\hasModel Any \cgal `d`-dimensional kernel. \hasModel `CGAL::Spatial_sort_traits_adapter_d` */ diff --git a/Spatial_sorting/doc/Spatial_sorting/Spatial_sorting.txt b/Spatial_sorting/doc/Spatial_sorting/Spatial_sorting.txt index 0623728b58c..b848ab80b40 100644 --- a/Spatial_sorting/doc/Spatial_sorting/Spatial_sorting.txt +++ b/Spatial_sorting/doc/Spatial_sorting/Spatial_sorting.txt @@ -141,9 +141,8 @@ as an alternative. \cgalexample{Spatial_sorting/myPoint.cpp} -## Sorting Arbitrary Types ## +## Sorting Arbitrary Types ## {#secsort_any_type} -\anchor secsort_any_type The spatial sorting traits class provides a point type and functors for comparing, for example, the `x`-coordinates of two points. @@ -157,9 +156,9 @@ which allows to obtain a point from whatever you want to sort. The following examples illustrate the usage of these traits class adapters. -## Sorting Using Pairs of Points and Integers ## +## Sorting Using Pairs of Points and Integers ## {#secsort_any_type_2} + -\anchor secsort_any_type_2 In this example program, the sorted sequence of points is retrieved using a vector of pairs of points and integers. \cgalexample{Spatial_sorting/sp_sort_using_property_map_2.cpp}