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

Improve doc

This commit is contained in:
Andreas Fabri 2019-05-24 17:32:14 +02:00
parent d6801852cc
commit 4ac7d2004d
2 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
\ingroup PkgConvexHull3Functions \ingroup PkgConvexHull3Functions
\brief computes the convex hull of the set of points in the range \brief computes the convex hull of the set of points in the range
[`first`, `last`). The polyhedron `pm` is cleared, then [`first`, `last`). The polygon mesh `pm` is cleared, then
the convex hull is stored in `pm`. Note that the convex hull will be triangulated, the convex hull is stored in `pm`. Note that the convex hull will be triangulated,
that is `pm` will contain only triangular facets. that is `pm` will contain only triangular facets.
if the convex hull is a point or a segment, endpoints will be added in `pm` as isolated vertices. if the convex hull is a point or a segment, endpoints will be added in `pm` as isolated vertices.
@ -39,9 +39,9 @@ void convex_hull_3(InputIterator first, InputIterator last, PolygonMesh& pm, con
\brief computes the convex hull of the set of points in the range \brief computes the convex hull of the set of points in the range
[`first`, `last`). The result, which may be a point, a segment, [`first`, `last`). The result, which may be a point, a segment,
a triangle, or a polyhedron, is stored in `ch_object`. a triangle, or a polygon mesh, is stored in `ch_object`.
In the case the result is a polyhedron, the convex hull will be triangulated, In the case the result is a polygon mesh, the convex hull will be triangulated,
that is the polyhedron will contain only triangular facets. that is the polygon mesh will contain only triangular facets.
\tparam InputIterator must be an input iterator with a value type equivalent to `Traits::Point_3`. \tparam InputIterator must be an input iterator with a value type equivalent to `Traits::Point_3`.
\tparam Traits must be model of the concept `ConvexHullTraits_3`. \tparam Traits must be model of the concept `ConvexHullTraits_3`.

14
Convex_hull_3/doc/Convex_hull_3/Convex_hull_3.txt
View File

@ -49,11 +49,19 @@ computing the hull.
The function `convex_hull_3()` is parameterized by a traits class, The function `convex_hull_3()` is parameterized by a traits class,
which specifies the types and geometric primitives to be used in the which specifies the types and geometric primitives to be used in the
computation. If input points from a kernel with exact predicates computation. As the function constructs 3D planes from three input
points, we cannot simply pass a kernel with inexact constructions as
optional argument for the traits class.
If input points from a kernel with exact predicates
and non-exact constructions are used, and a certified result is expected, and non-exact constructions are used, and a certified result is expected,
the traits `Convex_hull_traits_3<R>` should be used the traits `Convex_hull_traits_3<R>` should be used
(`R` being the input kernel). Note that the default traits class takes this into (`R` being the input kernel).
account. If the constructions from a kernel are exact this kernel can be used
directly as a traits class.
Note that the default traits class takes this into account, that is the
above considerations are only important for custom traits classes.
\subsubsection Convex_hull_3Example Example \subsubsection Convex_hull_3Example Example