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 2016-11-28 08:22:17 +01:00
parent 332ae157f6
commit f451517eb3
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_3.h
View File

@ -9,9 +9,9 @@ If `origin` is given then it must be a point strictly inside the polyhedron. If
This version does not construct the dual points explicitely but uses a special traits class for the function `CGAL::convex_hull_3()` to handle predicates on dual points without constructing them.
\attention Halfspaces are considered as lower halfspaces that is to say if the plane's equation is \f$ a\, x +b\, y +c\, z + d = 0 \f$ then the corresponding halfspace is defined by \f$ a\, x +b\, y +c\, z + d \le 0 \f$ .
\attention The point type of `origin` and the point type of the vertices of `Polyhedron` must come from the same \cgal %Kernel.
\attention
\pre if provided, `origin` is inside the intersection of halfspaces defined by the range `[begin, end)`.
\pre The point type of `origin` and the point type of the vertices of `Polyhedron` must come from the same \cgal %Kernel.\pre if provided, `origin` is inside the intersection of halfspaces defined by the range `[begin, end)`.
\pre The computed intersection must be a bounded convex polyhedron.
\tparam PlaneIterator must be an input iterator where the value type must be `Polyhedron::Traits::Plane_3`

2
Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_with_constructions_3.h
View File

@ -8,8 +8,8 @@ If `origin` is given then it must be a point strictly inside the polyhedron. If
This version constructs explicitly the dual points using the convex hull algorithm parametrized with the given traits class.
\attention Halfspaces are considered as lower halfspaces that is to say if the plane's equation is \f$ a\, x +b\, y +c\, z + d = 0 \f$ then the corresponding halfspace is defined by \f$ a\, x +b\, y +c\, z + d \le 0 \f$ .
\attention The value type of `PlaneIterator` and the point type of `origin` must come from the same \cgal Kernel.
\pre The value type of `PlaneIterator` and the point type of `origin` must come from the same \cgal Kernel.
\pre if provided, `origin` is inside the intersection of halfspaces defined by the range `[begin, end)`.
\pre The computed intersection must be a bounded convex polyhedron.