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

Document the new m-sum methods

This commit is contained in:
Sebastian Morr 2014-08-13 14:00:16 +02:00
parent 187856517f
commit f4bbfab665
1 changed files with 41 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Minkowski_sum_2/doc/Minkowski_sum_2/CGAL/minkowski_sum_2.h
View File

@ -3,6 +3,45 @@ namespace CGAL {
/*! /*!
\ingroup PkgMinkowskiSum2 \ingroup PkgMinkowskiSum2
Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons
using the reduced convolution method.
Note that as the input polygons may not be convex, their Minkowski
sum may not be a simple polygon. The result is therefore represented
as a polygon with holes.
\pre Both `P` and `Q` are simple, counterclockwise-oriented polygons.
\sa `CGAL::minkowski_sum_reduced_convolution_2()`
\sa `CGAL::minkowski_sum_full_convolution_2()`
*/
template<class Kernel, class Container>
Polygon_with_holes_2<Kernel,Container>
minkowski_sum_2 (const Polygon_2<Kernel,Container>& P,
const Polygon_2<Kernel,Container>& Q);
/*!
\ingroup PkgMinkowskiSum2
Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons.
The function computes the reduced convolution of the two polygons and
extracts those loops of the convolution which are part of the Minkowsi
sum. This method works very efficiently, regardless of whether `P` and
`Q` are convex or non-convex.
Note that as the input polygons may not be convex, their Minkowski
sum may not be a simple polygon. The result is therefore represented
as a polygon with holes.
\pre Both `P` and `Q` are simple, counterclockwise-oriented polygons.
*/
template<class Kernel, class Container>
Polygon_with_holes_2<Kernel,Container>
minkowski_sum_reduced_convolution_2 (const Polygon_2<Kernel,Container>& P,
const Polygon_2<Kernel,Container>& Q);
/*!
\ingroup PkgMinkowskiSum2
Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons. Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons.
The function computes the convolution cycles of the two polygons and The function computes the convolution cycles of the two polygons and
extract the regions having positive winding number with respect to these extract the regions having positive winding number with respect to these
@ -11,11 +50,12 @@ and `Q` are convex or non-convex.
Note that as the input polygons may not be convex, their Minkowski Note that as the input polygons may not be convex, their Minkowski
sum may not be a simple polygon. The result is therefore represented sum may not be a simple polygon. The result is therefore represented
as a polygon with holes. as a polygon with holes.
\pre Both `P` and `Q` are simple polygons. \pre Both `P` and `Q` are simple polygons.
*/ */
template<class Kernel, class Container> template<class Kernel, class Container>
Polygon_with_holes_2<Kernel,Container> Polygon_with_holes_2<Kernel,Container>
minkowski_sum_2 (const Polygon_2<Kernel,Container>& P, minkowski_sum_full_convolution_2 (const Polygon_2<Kernel,Container>& P,
const Polygon_2<Kernel,Container>& Q); const Polygon_2<Kernel,Container>& Q);
/*! /*!