mirror of https://github.com/CGAL/cgal
Misc doc cleaning
This commit is contained in:
parent
13b4060644
commit
e4e52c8391
|
|
@ -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}
|
||||
|
|
|
|||
|
|
@ -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,13 +47,10 @@ 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 <class InputIterator, class OutputIterator, class Traits>
|
||||
OutputIterator
|
||||
ch_bykat( InputIterator first,
|
||||
InputIterator beyond,
|
||||
ch_bykat(InputIterator first, InputIterator beyond,
|
||||
OutputIterator result,
|
||||
const Traits & ch_traits = Default_traits);
|
||||
|
||||
|
|
|
|||
|
|
@ -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,8 +53,7 @@ in the worst case for \f$ n\f$ input points with \f$ h\f$ extreme points.
|
|||
*/
|
||||
template <class InputIterator, class OutputIterator, class Traits>
|
||||
OutputIterator
|
||||
ch_eddy( InputIterator first,
|
||||
InputIterator beyond,
|
||||
ch_eddy(InputIterator first, InputIterator beyond,
|
||||
OutputIterator result,
|
||||
const Traits& ch_traits = Default_traits);
|
||||
|
||||
|
|
|
|||
|
|
@ -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,8 +51,7 @@ in the worst case for \f$ n\f$ input points.
|
|||
*/
|
||||
template <class InputIterator, class OutputIterator, class Traits>
|
||||
OutputIterator
|
||||
ch_graham_andrew( InputIterator first,
|
||||
InputIterator beyond,
|
||||
ch_graham_andrew(InputIterator first, InputIterator beyond,
|
||||
OutputIterator result,
|
||||
const Traits& ch_traits = Default_traits);
|
||||
|
||||
|
|
|
|||
|
|
@ -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,12 +47,10 @@ 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 <class ForwardIterator, class OutputIterator, class Traits>
|
||||
OutputIterator
|
||||
ch_jarvis( ForwardIterator first,
|
||||
ForwardIterator beyond,
|
||||
ch_jarvis(ForwardIterator first, ForwardIterator beyond,
|
||||
OutputIterator result,
|
||||
const Traits& ch_traits = Default_traits);
|
||||
|
||||
|
|
|
|||
|
|
@ -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,11 +45,10 @@ 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 <class InputIterator, class OutputIterator>
|
||||
OutputIterator
|
||||
ch_melkman( InputIterator first, InputIterator last,
|
||||
ch_melkman(InputIterator first, InputIterator beyond,
|
||||
OutputIterator result,
|
||||
const Traits& ch_traits = Default_traits);
|
||||
|
||||
|
|
|
|||
|
|
@ -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}
|
||||
|
||||
<OL>
|
||||
|
|
@ -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 <class InputIterator, class OutputIterator>
|
||||
OutputIterator
|
||||
upper_hull_points_2(InputIterator first, InputIterator beyond,
|
||||
OutputIterator result,
|
||||
const Traits& ch_traits = Default_traits);
|
||||
|
||||
} /* namespace CGAL */
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
Loading…
Reference in New Issue