From 3fc151b0dd2d373da99b7c5b82339882f4ca57a6 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Wed, 30 Nov 2016 10:32:40 +0100 Subject: [PATCH] polish, e.g. P -> pm --- BGL/include/CGAL/boost/graph/helpers.h | 2 +- .../Convex_hull_3/dual/halfspace_intersection_3.h | 4 ++-- .../halfspace_intersection_with_constructions_3.h | 4 ++-- .../doc/Convex_hull_3/CGAL/convex_hull_3.h | 14 +++++++------- .../CGAL/convex_hull_3_to_face_graph.h | 6 +++--- .../doc/Convex_hull_3/CGAL/convexity_check_3.h | 2 +- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/BGL/include/CGAL/boost/graph/helpers.h b/BGL/include/CGAL/boost/graph/helpers.h index 398f6627b1b..51cd7d040ad 100644 --- a/BGL/include/CGAL/boost/graph/helpers.h +++ b/BGL/include/CGAL/boost/graph/helpers.h @@ -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` diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_3.h index ec4b2058d4d..9fcdbd8e5f9 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_3.h @@ -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 void halfspace_intersection_3 (PlaneIterator begin, PlaneIterator end, - PolygonMesh &P, + PolygonMesh &pm, boost::optional::value_type>::Kernel::Point_3> > origin = boost::none); } /* namespace CGAL */ diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_with_constructions_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_with_constructions_3.h index 636fa8163fe..db5da7908b4 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_with_constructions_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_3/dual/halfspace_intersection_with_constructions_3.h @@ -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 void halfspace_intersection_with_constructions_3(PlaneIterator pbegin, PlaneIterator pend, - PolygonMesh &P, + PolygonMesh &pm, boost::optional::value_type>::Kernel::Point_3> > origin = boost::none, const Traits & ch_traits = Default_traits); diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h index f10e2e5101f..59fa52ef06b 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h @@ -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 et al. \cgalCite{bdh-qach-96}. */ template -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` diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3_to_face_graph.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3_to_face_graph.h index 73cfad6c0bf..8a68a384b0f 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3_to_face_graph.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3_to_face_graph.h @@ -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 -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 */ diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/convexity_check_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/convexity_check_3.h index 53a7c0f461e..cc3ed5dd840 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/convexity_check_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/convexity_check_3.h @@ -23,7 +23,7 @@ determine convexity and requires \f$ O(e + f)\f$ time for a polyhedron with */ template -bool is_strongly_convex_3(PolygonMesh& P, +bool is_strongly_convex_3(PolygonMesh& pm, const Traits& traits = Default_traits); } /* namespace CGAL */