songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Misc doc cleaning

This commit is contained in:
Mael Rouxel-Labbé 2022-07-01 23:46:10 +02:00
parent 13b4060644
commit e4e52c8391
8 changed files with 46 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h
View File

@ -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 <class ForwardIterator, class OutputIterator, class Traits>
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 */

12
Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h
View File

@ -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 <class InputIterator, class OutputIterator, class Traits>
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 */

10
Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h
View File

@ -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 <class InputIterator, class OutputIterator, class Traits>
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 */

16
Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h
View File

@ -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 <class InputIterator, class OutputIterator, class Traits>
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 <class BidirectionalIterator, class OutputIterator,
class Traits>
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 */

19
Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h
View File

@ -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 <class ForwardIterator, class OutputIterator, class Traits>
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 <class ForwardIterator, class OutputIterator, class Traits>
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 */

10
Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h
View File

@ -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 <class InputIterator, class OutputIterator>
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 */

13
Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h
View File

@ -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>
@ -136,8 +135,8 @@ of \f$ O(n \log n)\f$ for \f$ n\f$ input points.
template <class InputIterator, class OutputIterator>
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 <class InputIterator, class OutputIterator>
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 */

2
Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h
View File

@ -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;