diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h index f84b4b41c02..4df696cd96e 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h @@ -9,6 +9,7 @@ The resulting sequence is placed starting at position `result`, and the past-the-end iterator for the resulting sequence is returned. It is not specified at which point the cyclic sequence of extreme points is cut into a linear sequence. + \pre The source range [`first`,`beyond`) does not contain `result`. The default traits class `Default_traits` is the kernel in which the value type of `ForwardIterator` is defined. @@ -36,6 +37,8 @@ functions that return instances of these types: \sa `CGAL::ch_graham_andrew()` \sa `CGAL::ch_jarvis()` \sa `CGAL::ch_melkman()` +\sa `CGAL::lower_hull_points_2()` +\sa `CGAL::upper_hull_points_2()` \sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} @@ -49,7 +52,7 @@ points. template OutputIterator ch_akl_toussaint(ForwardIterator first, ForwardIterator beyond, -OutputIterator result, -const Traits& ch_traits = Default_traits()); + OutputIterator result, + const Traits& ch_traits = Default_traits()); } /* namespace CGAL */ diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h index 9327cc59c86..03ca5875518 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h @@ -9,6 +9,7 @@ The resulting sequence is placed starting at position `result`, and the past-the-end iterator for the resulting sequence is returned. It is not specified at which point the cyclic sequence of extreme points is cut into a linear sequence. + \pre The source range [`first`,`beyond`) does not contain `result`. The default traits class `Default_traits` is the kernel in which the @@ -36,6 +37,8 @@ functions that return instances of these types: \sa `CGAL::ch_graham_andrew()` \sa `CGAL::ch_jarvis()` \sa `CGAL::ch_melkman()` +\sa `CGAL::lower_hull_points_2()` +\sa `CGAL::upper_hull_points_2()` \sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} @@ -44,14 +47,11 @@ This function implements the non-recursive variation of Eddy's algorithm \cgalCite{e-nchap-77} described in \cgalCite{b-chfsp-78}. This algorithm requires \f$ O(n h)\f$ time in the worst case for \f$ n\f$ input points with \f$ h\f$ extreme points. - - */ template OutputIterator -ch_bykat( InputIterator first, -InputIterator beyond, -OutputIterator result, -const Traits & ch_traits = Default_traits); +ch_bykat(InputIterator first, InputIterator beyond, + OutputIterator result, + const Traits & ch_traits = Default_traits); } /* namespace CGAL */ diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h index 42959f2130b..9a023d34070 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h @@ -9,6 +9,7 @@ The resulting sequence is placed starting at position `result`, and the past-the-end iterator for the resulting sequence is returned. It is not specified at which point the cyclic sequence of extreme points is cut into a linear sequence. + \pre The source range [`first`,`beyond`) does not contain `result`. The default traits class `Default_traits` is the kernel in which the @@ -36,6 +37,8 @@ functions that return instances of these types: \sa `CGAL::ch_graham_andrew()` \sa `CGAL::ch_jarvis()` \sa `CGAL::ch_melkman()` +\sa `CGAL::lower_hull_points_2()` +\sa `CGAL::upper_hull_points_2()` \sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} @@ -50,9 +53,8 @@ in the worst case for \f$ n\f$ input points with \f$ h\f$ extreme points. */ template OutputIterator -ch_eddy( InputIterator first, -InputIterator beyond, -OutputIterator result, -const Traits & ch_traits = Default_traits); +ch_eddy(InputIterator first, InputIterator beyond, + OutputIterator result, + const Traits& ch_traits = Default_traits); } /* namespace CGAL */ diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h index 1ec47707c41..20119b4243b 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h @@ -9,8 +9,8 @@ The resulting sequence is placed starting at position `result`, and the past-the-end iterator for the resulting sequence is returned. It is not specified at which point the cyclic sequence of extreme points is cut into a linear sequence. -\pre The source range [`first`,`beyond`) does not contain `result`. +\pre The source range [`first`,`beyond`) does not contain `result`. The default traits class `Default_traits` is the kernel in which the value type of `InputIteratore` is defined. @@ -34,7 +34,6 @@ functions that return instances of these types: \sa `CGAL::ch_akl_toussaint()` \sa `CGAL::ch_bykat()` \sa `CGAL::ch_eddy()` -\sa `CGAL::ch_graham_andrew_scan()` \sa `CGAL::ch_jarvis()` \sa `CGAL::ch_melkman()` \sa `CGAL::convex_hull_2()` @@ -52,10 +51,9 @@ in the worst case for \f$ n\f$ input points. */ template OutputIterator -ch_graham_andrew( InputIterator first, -InputIterator beyond, -OutputIterator result, -const Traits & ch_traits = Default_traits); +ch_graham_andrew(InputIterator first, InputIterator beyond, + OutputIterator result, + const Traits& ch_traits = Default_traits); } /* namespace CGAL */ @@ -125,8 +123,8 @@ template OutputIterator ch_graham_andrew_scan( BidirectionalIterator first, -BidirectionalIterator beyond, -OutputIterator result, -const Traits& ch_traits = Default_traits); + BidirectionalIterator beyond, + OutputIterator result, + const Traits& ch_traits = Default_traits); } /* namespace CGAL */ diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h index 54061777377..41478fb06f9 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h @@ -9,6 +9,7 @@ The resulting sequence is placed starting at position `result`, and the past-the-end iterator for the resulting sequence is returned. It is not specified at which point the cyclic sequence of extreme points is cut into a linear sequence. + \pre The source range [`first`,`beyond`) does not contain `result`. The default traits class `Default_traits` is the kernel in which the @@ -36,6 +37,8 @@ functions that return instances of these types: \sa `CGAL::ch_graham_andrew()` \sa `CGAL::ch_jarvis_march()` \sa `CGAL::ch_melkman()` +\sa `CGAL::lower_hull_points_2()` +\sa `CGAL::upper_hull_points_2()` \sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} @@ -44,14 +47,12 @@ This function uses the Jarvis march (gift-wrapping) algorithm \cgalCite{j-ichfs-73}. This algorithm requires \f$ O(n h)\f$ time in the worst case for \f$ n\f$ input points with \f$ h\f$ extreme points. - */ template OutputIterator -ch_jarvis( ForwardIterator first, -ForwardIterator beyond, -OutputIterator result, -const Traits & ch_traits = Default_traits); +ch_jarvis(ForwardIterator first, ForwardIterator beyond, + OutputIterator result, + const Traits& ch_traits = Default_traits); } /* namespace CGAL */ @@ -106,9 +107,9 @@ is an element of range [`first`,`beyond`). template OutputIterator ch_jarvis_march(ForwardIterator first, ForwardIterator beyond, -const Traits::Point_2& start_p, -const Traits::Point_2& stop_p, -OutputIterator result, -const Traits& ch_traits = Default_traits); + const Traits::Point_2& start_p, + const Traits::Point_2& stop_p, + OutputIterator result, + const Traits& ch_traits = Default_traits); } /* namespace CGAL */ diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h index 8e89546ea15..d4375657e98 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h @@ -8,6 +8,7 @@ of the points in the range [`first`, `beyond`). The resulting sequence is placed starting at position `result`, and the past-the-end iterator for the resulting sequence is returned. + \pre The source range [`first`,`beyond`) corresponds to a simple polyline. [`first`,`beyond`) does not contain `result`. The default traits class `Default_traits` is the kernel in which the @@ -35,6 +36,8 @@ functions that return instances of these types: \sa `CGAL::ch_graham_andrew()` \sa `CGAL::ch_jarvis()` \sa `CGAL::ch_melkman()` +\sa `CGAL::lower_hull_points_2()` +\sa `CGAL::upper_hull_points_2()` \sa `CGAL::convex_hull_2()` \cgalHeading{Implementation} @@ -42,12 +45,11 @@ functions that return instances of these types: It uses an implementation of Melkman's algorithm \cgalCite{m-olcch-87}. Running time of this is linear. - */ template OutputIterator -ch_melkman( InputIterator first, InputIterator last, -OutputIterator result, -const Traits& ch_traits = Default_traits); +ch_melkman(InputIterator first, InputIterator beyond, + OutputIterator result, + const Traits& ch_traits = Default_traits); } /* namespace CGAL */ diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h index 03a10a0ff22..0e54242c874 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h @@ -13,10 +13,9 @@ The resulting sequence is placed starting at position `result`, and the past-the-end iterator for the resulting sequence is returned. It is not specified at which point the cyclic sequence of extreme points is cut into a linear sequence. + \pre The source range [`first`,`beyond`) does not contain `result`. - - \cgalHeading{Requirements}
    @@ -136,8 +135,8 @@ of \f$ O(n \log n)\f$ for \f$ n\f$ input points. template OutputIterator lower_hull_points_2(InputIterator first, InputIterator beyond, -OutputIterator result, -const Traits & ch_traits = Default_traits ); + OutputIterator result, + const Traits& ch_traits = Default_traits ); } /* namespace CGAL */ @@ -195,12 +194,10 @@ This function uses Andrew's variant of Graham's scan algorithm \cgalCite{a-aeach-79}, \cgalCite{m-mdscg-84}. The algorithm has worst-case running time of \f$ O(n \log n)\f$ for \f$ n\f$ input points. - */ template OutputIterator upper_hull_points_2(InputIterator first, InputIterator beyond, -OutputIterator result, -const Traits & ch_traits = Default_traits ); - + OutputIterator result, + const Traits& ch_traits = Default_traits); } /* namespace CGAL */ diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h index 95bad9f653f..74534126ab7 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h @@ -43,7 +43,7 @@ typedef R::Less_xy_2 Less_xy_2; typedef R::Less_yx_2 Less_yx_2; /*! -This internal functor builds and caches the line on the first call to its `operator()`. +This internal functor builds and cache the line on the first call to its `operator()`. */ typedef unspecified_type Compare_signed_distance_to_line_2;