Clarify default algorithm of minkowski_sum_2

This commit is contained in:
Sebastian Morr 2014-08-14 09:28:49 +02:00
parent 2de241dfc3
commit 947cde415d
2 changed files with 8 additions and 3 deletions

View File

@ -3,8 +3,8 @@ namespace CGAL {
/*!
\ingroup PkgMinkowskiSum2
Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons
using the reduced convolution method.
Computes the Minkowski sum \f$ P \oplus Q\f$ of the two given polygons.
This method defaults to the reduced convolution method, see below.
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.

View File

@ -119,7 +119,12 @@ avoid the costly intersection tests.
The function \link minkowski_sum_2() `minkowski_sum_2(P, Q)`\endlink accepts two simple polygons \f$ P\f$
and \f$ Q\f$, represented using the `Polygon_2<Kernel,Container>`
class-template and uses the reduced convolution method in order to compute and
return their Minkowski sum \f$ S = P \oplus Q\f$.
return their Minkowski sum \f$ S = P \oplus Q\f$. By default, \link minkowski_sum_2()
`minkowski_sum_2(P, Q)`\endlink uses the reduced convolution approach, to explicitly
use the full convolution, use \link minkowski_sum_full_convolution_2()
`minkowski_sum_full_convolution_2(P, Q)`\endlink. To explicitly use the reduced
convolution convolution, use \link minkowski_sum_reduced_convolution_2()
`minkowski_sum_reduced_convolution_2(P, Q)`\endlink.
As the input polygons may not be convex, their Minkowski sum may not be
simply connected and contain polygonal holes; see for example