polish, e.g. P -> pm

This commit is contained in:
Andreas Fabri 2016-11-30 10:32:40 +01:00
parent 9ee11501ac
commit 3fc151b0dd
6 changed files with 16 additions and 16 deletions

View File

@ -699,7 +699,7 @@ clear_impl(FaceGraph& g)
* `remove_edge()`, `remove_vertex()`, and `remove_face()` for each
* edge, vertex or face.
*
* If the graph has a member function `clear`, it will be called
* If the graph has a member function `clear()`, it will be called
* instead.
*
* @tparam FaceGraph model of `MutableHalfedgeGraph` and `MutableFaceGraph`

View File

@ -3,7 +3,7 @@ namespace CGAL {
/*!
\ingroup PkgConvexHull3Functions
\brief computes robustly the intersection of the halfspaces defined by the planes contained in the range [`begin`, `end`) without constructing the dual points. The result is stored in the polyhedron `P`.
\brief computes robustly the intersection of the halfspaces defined by the planes contained in the range [`begin`, `end`) without constructing the dual points. The result is stored in the polyhedron `pm`.
If `origin` is given then it must be a point strictly inside the polygon mesh. If an interior point is not given then it is computed using a linear program and thus is slower.
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.
@ -25,7 +25,7 @@ This version does not construct the dual points explicitely but uses a special t
template <class PlaneIterator, class PolygonMesh>
void halfspace_intersection_3 (PlaneIterator begin, PlaneIterator end,
PolygonMesh &P,
PolygonMesh &pm,
boost::optional<Kernel_traits<std::iterator_traits<PlaneIterator>::value_type>::Kernel::Point_3> > origin = boost::none);
} /* namespace CGAL */

View File

@ -3,7 +3,7 @@ namespace CGAL {
/*!
\ingroup PkgConvexHull3Functions
\brief computes the intersection of the halfspaces defined by the planes contained in the range [`begin`, `end`). The result is stored in the polyhedron `P`.
\brief computes the intersection of the halfspaces defined by the planes contained in the range [`begin`, `end`). The result is stored in the polyhedron `pm`.
If `origin` is given then it must be a point strictly inside the polyhedron. If an interior point is not given then it is computed using a linear program and thus is slower.
This version constructs explicitly the dual points using the convex hull algorithm parametrized with the given traits class.
@ -24,7 +24,7 @@ This version constructs explicitly the dual points using the convex hull algorit
template <class PlaneIterator, class PolygonMesh, class Traits>
void halfspace_intersection_with_constructions_3(PlaneIterator pbegin,
PlaneIterator pend,
PolygonMesh &P,
PolygonMesh &pm,
boost::optional<Kernel_traits<std::iterator_traits<PlaneIterator>::value_type>::Kernel::Point_3> > origin = boost::none,
const Traits & ch_traits = Default_traits);

View File

@ -4,11 +4,11 @@ namespace CGAL {
\ingroup PkgConvexHull3Functions
\brief computes the convex hull of the set of points in the range
[`first`, `last`). The polyhedron `P` is cleared, then
the convex hull is stored in `P`. Note that the convex hull will be triangulated,
that is `P` will contain only triangular facets.
[`first`, `last`). The polyhedron `pm` is cleared, then
the convex hull is stored in `pm`. Note that the convex hull will be triangulated,
that is `pm` will contain only triangular facets.
\attention This function does not compute the plane equations of the faces of `P`.
\attention This function does not compute the plane equations of the faces of `pm`.
\pre There are at least four points in the range
[`first`, `last`) not all of which are collinear.
@ -36,7 +36,7 @@ Barnard <I>et al.</I> \cgalCite{bdh-qach-96}.
*/
template <class InputIterator, class PolygonMesh, class Traits>
void convex_hull_3(InputIterator first, InputIterator last, PolygonMesh& P, const Traits& ch_traits = Default_traits);
void convex_hull_3(InputIterator first, InputIterator last, PolygonMesh& pm, const Traits& ch_traits = Default_traits);
/*!
\ingroup PkgConvexHull3Functions
@ -47,14 +47,14 @@ a triangle, or a polyhedron, is stored in `ch_object`.
In the case the result is a polyhedron, the convex hull will be triangulated,
that is the polyhedron will contain only triangular facets.
\attention This function does not compute the plane equations of the faces of `P`
\attention This function does not compute the plane equations of the faces of `pm`
in case the result is a polyhedron.
\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`.
For the purposes of checking the postcondition that the convex hull
is valid, `Traits` must also be a model of the concept
`IsStronglyConvexTraits_3`. Furthermore, `Traits` must define a type `PolygonMesh` that is a model of
`IsStronglyConvexTraits_3`. Furthermore, `Traits` must define a type `Polygon_mesh` that is a model of
`MutableFaceGraph`.
If the kernel `R` of the points determined by the value type of `InputIterator`

View File

@ -5,9 +5,9 @@ namespace CGAL {
fills a polyhedron with the convex hull of a set of 3D points contained in a 3D triangulation of \cgal.
The polyhedron `P` is cleared and the convex hull of the set of 3D points is stored in `P`.
The polyhedron `P` is cleared and the convex hull of the set of 3D points is stored in `pm`.
\attention This function does not compute the plane equations of the faces of `P`.
\attention This function does not compute the plane equations of the faces of `pm`.
\pre `T.dimension()`==3.
@ -19,6 +19,6 @@ The polyhedron `P` is cleared and the convex hull of the set of 3D points is sto
*/
template <class Triangulation, class PolygonMesh>
void convex_hull_3_to_face_graph(const Triangulation& T,PolygonMesh& P);
void convex_hull_3_to_face_graph(const Triangulation& T,PolygonMesh& pm);
} /* namespace CGAL */

View File

@ -23,7 +23,7 @@ determine convexity and requires \f$ O(e + f)\f$ time for a polyhedron with
*/
template<class PolygonMesh, class Traits>
bool is_strongly_convex_3(PolygonMesh& P,
bool is_strongly_convex_3(PolygonMesh& pm,
const Traits& traits = Default_traits);
} /* namespace CGAL */