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

Move doc

This commit is contained in:
Mael Rouxel-Labbé 2023-03-30 15:47:54 +02:00
parent eacbb7c94c
commit 2fd2fc4792
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/arrange_offset_polygons_2.h
View File

@ -13,17 +13,17 @@ A `CLOCKWISE` oriented polygon `H` is a hole of a `COUNTERCLOCKWISE` polygon `P`
This function should not be used to arrange arbitrary polygons into polygons with holes unless they meet the requirements specified below.
\pre The input polygons must be simple.
\pre The set of input polygons are unique and interior disjoint. That is, given distinct polygons
`P` and `Q`, there are vertices of `P` which are not on the boundary of `Q` and are all on the
bounded or unbounded side of `Q` (but not both).
\tparam K must be a model of `Kernel`.
\tparam InputPolygonPtrIterator must be a model of `InputIterator` whose `value_type` is a smart pointer
(such as `boost::shared_ptr`) whose `element_type` is a model of `SequenceContainer` with value type `K::Point_2`.
\tparam OutputPolygonWithHolesPtrIterator must be a model of `OutputIterator` whose `value_type` is a smart pointer
(such as `boost::shared_ptr`) whose `element_type` is a model of `GeneralPolygonWithHoles_2`.
\pre The input polygons must be simple.
\pre The set of input polygons are unique and interior disjoint. That is, given distinct polygons
`P` and `Q`, there are vertices of `P` which are not on the boundary of `Q` and are all on the
bounded or unbounded side of `Q` (but not both).
\return `true` if no error was encountered, and `false` otherwise.
\sa `CGAL::create_exterior_straight_skeleton_2()`