From c645600c2e33cde00a7b362d08a91e5fa4d87cc4 Mon Sep 17 00:00:00 2001 From: Efi Fogel Date: Wed, 24 Feb 2016 19:09:56 +0200 Subject: [PATCH] Removed redundant anchor --- .../CGAL/Polygon_convex_decomposition_2.h | 64 +++++++++---------- .../CGAL/Polygon_nop_decomposition_2.h | 2 - .../Polygon_triangulation_decomposition_2.h | 2 - .../CGAL/Polygon_vertical_decomposition_2.h | 2 - ...mall_side_angle_bisector_decomposition_2.h | 2 - 5 files changed, 29 insertions(+), 43 deletions(-) diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h index eef8d2ea2ba..881bfb39dee 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_convex_decomposition_2.h @@ -3,22 +3,20 @@ namespace CGAL { /*! \ingroup PkgMinkowskiSum2 -\anchor mink_refGreene_decomp - -The `Greene_convex_decomposition_2` class implements the approximation algorithm of -Greene for the decomposition of an input polygon into convex -sub-polygons \cgalCite{g-dpcp-83}. This algorithm takes \f$ O(n \log n)\f$ -time and \f$ O(n)\f$ space, where \f$ n\f$ is the size of the input polygon, -and outputs a decomposition whose size is guaranteed to be no more -than four times the size of the optimal decomposition. +The `Greene_convex_decomposition_2` class implements the approximation algorithm of +Greene for the decomposition of an input polygon into convex +sub-polygons \cgalCite{g-dpcp-83}. This algorithm takes \f$ O(n \log n)\f$ +time and \f$ O(n)\f$ space, where \f$ n\f$ is the size of the input polygon, +and outputs a decomposition whose size is guaranteed to be no more +than four times the size of the optimal decomposition. \tparam Kernel must be a geometric kernel that can be used for the polygon. -\tparam Container must be a container that can be used for the polygon. -It is by default `std::vector`. +\tparam Container must be a container that can be used for the polygon. +It is by default `std::vector`. \cgalModels `PolygonConvexDecomposition_2` -\sa `CGAL::greene_approx_convex_partition_2()` +\sa `CGAL::greene_approx_convex_partition_2()` */ template< typename Kernel, typename Container > @@ -37,25 +35,23 @@ namespace CGAL { /*! \ingroup PkgMinkowskiSum2Classes -\anchor mink_refHM_decomp - -The `Hertel_Mehlhorn_convex_decomposition_2` class implements the approximation algorithm of Hertel -and Mehlhorn for decomposing a polygon into convex -sub-polygons \cgalCite{hm-ftsp-83}. This algorithm constructs a -triangulation of the input polygon and proceeds by removing -unnecessary triangulation edges. Given the triangulation, the -algorithm requires \f$ O(n)\f$ time and space to construct a convex -decomposition (where \f$ n\f$ is the size of the input polygon), whose -size is guaranteed to be no more than four times the size of the -optimal decomposition. +The `Hertel_Mehlhorn_convex_decomposition_2` class implements the approximation algorithm of Hertel +and Mehlhorn for decomposing a polygon into convex +sub-polygons \cgalCite{hm-ftsp-83}. This algorithm constructs a +triangulation of the input polygon and proceeds by removing +unnecessary triangulation edges. Given the triangulation, the +algorithm requires \f$ O(n)\f$ time and space to construct a convex +decomposition (where \f$ n\f$ is the size of the input polygon), whose +size is guaranteed to be no more than four times the size of the +optimal decomposition. \tparam Kernel must be a geometric kernel that can be used for the polygon. -\tparam Container must be a container that can be used for the polygon. -It is by default `std::vector`. +\tparam Container must be a container that can be used for the polygon. +It is by default `std::vector`. \cgalModels `PolygonConvexDecomposition_2` -\sa `CGAL::approx_convex_partition_2()` +\sa `CGAL::approx_convex_partition_2()` */ template< typename Kernel, typename Container > @@ -74,22 +70,20 @@ namespace CGAL { /*! \ingroup PkgMinkowskiSum2 -\anchor mink_refopt_decomp - -The `Optimal_convex_decomposition_2` class provides an implementation of Greene's -dynamic programming algorithm for optimal decomposition of a -polygon into convex sub-polygons \cgalCite{g-dpcp-83}. Note that -this algorithm requires \f$ O(n^4)\f$ time and \f$ O(n^3)\f$ space in -the worst case, where \f$ n\f$ is the size of the input polygon. +The `Optimal_convex_decomposition_2` class provides an implementation of Greene's +dynamic programming algorithm for optimal decomposition of a +polygon into convex sub-polygons \cgalCite{g-dpcp-83}. Note that +this algorithm requires \f$ O(n^4)\f$ time and \f$ O(n^3)\f$ space in +the worst case, where \f$ n\f$ is the size of the input polygon. \tparam Kernel must be a geometric kernel that can be used for the polygon. -\tparam Container must be a container that can be used for the polygon. -It is by default `std::vector`. +\tparam Container must be a container that can be used for the polygon. +It is by default `std::vector`. \cgalModels `PolygonConvexDecomposition_2` -\sa `CGAL::optimal_convex_partition_2()` +\sa `CGAL::optimal_convex_partition_2()` */ template< typename Kernel, typename Container > diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_nop_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_nop_decomposition_2.h index aa75637e60f..bae6afdfa5c 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_nop_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_nop_decomposition_2.h @@ -3,8 +3,6 @@ namespace CGAL { /*! \ingroup PkgMinkowskiSum2 -\anchor mink_refnop_decomp - The `Polygon_nop_decomposition_2` class implements a convex decompistion of a polygon, which merely passes the input polygon to the list of output convex polygons. It should be used when it is known diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_triangulation_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_triangulation_decomposition_2.h index 8bd705b5fed..36b8931f541 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_triangulation_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_triangulation_decomposition_2.h @@ -3,8 +3,6 @@ namespace CGAL { /*! \ingroup PkgMinkowskiSum2 -\anchor mink_reftri_decomp - The `Polygon_triangulation_decomposition_2` class implements a convex decompistion of a polygon or a polygon with holes into triangles using the Delaunay contrained triangulation functionality of the diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_vertical_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_vertical_decomposition_2.h index 617ed2ee126..d2a0a457a5a 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_vertical_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Polygon_vertical_decomposition_2.h @@ -3,8 +3,6 @@ namespace CGAL { /*! \ingroup PkgMinkowskiSum2 -\anchor mink_refvert_decomp - The `Polygon_vertical_decomposition_2` class implements a convex decompistion of a polygon or a polygon with holes into pseudo trapezoids utilizing the CGAL::decompose() free function of the diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h index 092db51d1fe..ae6d95055d0 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/Small_side_angle_bisector_decomposition_2.h @@ -3,8 +3,6 @@ namespace CGAL { /*! \ingroup PkgMinkowskiSum2 -\anchor mink_refssab_decomp - The `Small_side_angle_bisector_decomposition_2` class implements a simple yet efficient heuristic for decomposing an input polygon into convex sub-polygons. It is based on the algorithm suggested by Flato and Halperin \cgalCite{fh-recpm-00},