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

finished first pass of doxygenization of Bsop

This commit is contained in:
Andreas Fabri 2012-08-22 12:41:26 +00:00
parent 939a01a80a
commit c05340f699
5 changed files with 67 additions and 547 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

601
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2.h
View File

@ -100,8 +100,10 @@ The types of the paramters of the `difference` function are any of the following
/// @{ /// @{
/*!
writes the difference of the polygons `p1` and `p2` into the output iterator `oi`.
The value type of `oi` is `Polygon_with_holes_2`.
*/
template <class Kernel, class Container, class OutputIterator> template <class Kernel, class Container, class OutputIterator>
OutputIterator difference(const Polygon_2<Kernel, Container> & p1, OutputIterator difference(const Polygon_2<Kernel, Container> & p1,
const Polygon_2<Kernel, Container> & p2, const Polygon_2<Kernel, Container> & p2,
@ -703,7 +705,9 @@ Oriented_side oriented_side(const General_polygon_with_holes_2<Polygon> & p1,
namespace CGAL { namespace CGAL {
/*! /*!
\addtogroup boolean_symmetric_difference Symmetric Difference Functions
\ingroup PkgBooleanSetOperations2 \ingroup PkgBooleanSetOperations2
\anchor ref_bso_symmetric_difference
Each one of these functions computes the symmetric difference between Each one of these functions computes the symmetric difference between
two given polygons `p1` and `p2`, and inserts the resulting two given polygons `p1` and `p2`, and inserts the resulting
@ -712,8 +716,16 @@ iterator `oi`. The value type of the `OutputIterator` is either
`Polygon_with_holes_2` or `Polygon_with_holes_2` or
`General_polygon_with_holes_2`. `General_polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment The signature of the function is
<div align="center"> \code
OutputIterator symmetric_difference(const Type1 & p1, const Type2 & p2, OutputIterator oi);
\endcode
###Parameters###
The types of the paramters of the `symmetric_difference` function are any of the following combinations.
<div align="left">
<table cellpadding=3 border="1"> <table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr> <tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr> <tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
@ -726,25 +738,7 @@ CONVERROR HtmlOnly needs treatment
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr> <tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table> </table>
</div> </div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect` \sa `CGAL::do_intersect`
\sa `CGAL::intersection` \sa `CGAL::intersection`
@ -753,566 +747,95 @@ the `OutputIterator` is `Traits::Polygon_with_holes_2`.
*/ */
OutputIterator intersection(const Type1 & p1, const Type2 & p2, /// @{
OutputIterator oi);
/*! OutputIterator symmetric_difference(const Type1 & p1, const Type2 & p2,
\ingroup PkgBooleanSetOperations2 OutputIterator oi);
Each one of these functions computes the symmetric difference between
two given polygons `p1` and `p2`, and inserts the resulting
polygons with holes into an output container through the output
iterator `oi`. The value type of the `OutputIterator` is either
`Polygon_with_holes_2` or
`General_polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class Kernel, class Container, class OutputIterator> template <class Kernel, class Container, class OutputIterator>
OutputIterator symmetric_difference(const Polygon_2<Kernel, Container> & p1, OutputIterator symmetric_difference(const Polygon_2<Kernel, Container> & p1,
const Polygon_2<Kernel, Container> & p2, const Polygon_2<Kernel, Container> & p2,
OutputIterator oi); OutputIterator oi);
/*!
\ingroup PkgBooleanSetOperations2
Each one of these functions computes the symmetric difference between
two given polygons `p1` and `p2`, and inserts the resulting
polygons with holes into an output container through the output
iterator `oi`. The value type of the `OutputIterator` is either
`Polygon_with_holes_2` or
`General_polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class Kernel, class Container, class OutputIterator> template <class Kernel, class Container, class OutputIterator>
OutputIterator OutputIterator
symmetric_difference(const Polygon_2<Kernel, Container> & p1, symmetric_difference(const Polygon_2<Kernel, Container> & p1,
const Polygon_with_holes_2<Kernel, Container> & p2, const Polygon_with_holes_2<Kernel, Container> & p2,
OutputIterator oi); OutputIterator oi);
/*!
\ingroup PkgBooleanSetOperations2
Each one of these functions computes the symmetric difference between
two given polygons `p1` and `p2`, and inserts the resulting
polygons with holes into an output container through the output
iterator `oi`. The value type of the `OutputIterator` is either
`Polygon_with_holes_2` or
`General_polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class Kernel, class Container, class OutputIterator> template <class Kernel, class Container, class OutputIterator>
OutputIterator OutputIterator
symmetric_difference(const Polygon_with_holes_2<Kernel, Container> & p1, symmetric_difference(const Polygon_with_holes_2<Kernel, Container> & p1,
const Polygon_2<Kernel, Container> & p2, const Polygon_2<Kernel, Container> & p2,
OutputIterator oi); OutputIterator oi);
/*!
\ingroup PkgBooleanSetOperations2
Each one of these functions computes the symmetric difference between
two given polygons `p1` and `p2`, and inserts the resulting
polygons with holes into an output container through the output
iterator `oi`. The value type of the `OutputIterator` is either
`Polygon_with_holes_2` or
`General_polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class Kernel, class Container, class OutputIterator> template <class Kernel, class Container, class OutputIterator>
OutputIterator OutputIterator
symmetric_difference(const Polygon_with_holes_2<Kernel, Container> & p1, symmetric_difference(const Polygon_with_holes_2<Kernel, Container> & p1,
const Polygon_with_holes_2<Kernel, Container> & p2, const Polygon_with_holes_2<Kernel, Container> & p2,
OutputIterator oi); OutputIterator oi);
/*!
\ingroup PkgBooleanSetOperations2
Each one of these functions computes the symmetric difference between
two given polygons `p1` and `p2`, and inserts the resulting
polygons with holes into an output container through the output
iterator `oi`. The value type of the `OutputIterator` is either
`Polygon_with_holes_2` or
`General_polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class Traits, class OutputIterator> template <class Traits, class OutputIterator>
OutputIterator symmetric_difference(const General_polygon_2<Traits> & p1, OutputIterator symmetric_difference(const General_polygon_2<Traits> & p1,
const General_polygon_2<Traits> & p2, const General_polygon_2<Traits> & p2,
OutputIterator oi); OutputIterator oi);
/*!
\ingroup PkgBooleanSetOperations2
Each one of these functions computes the symmetric difference between
two given polygons `p1` and `p2`, and inserts the resulting
polygons with holes into an output container through the output
iterator `oi`. The value type of the `OutputIterator` is either
`Polygon_with_holes_2` or
`General_polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class Traits, class OutputIterator> template <class Traits, class OutputIterator>
OutputIterator OutputIterator
symmetric_difference(const General_polygon_with_holes_2<General_polygon_2<Traits> > & p1, symmetric_difference(const General_polygon_with_holes_2<General_polygon_2<Traits> > & p1,
const General_polygon_2<Traits> & p2, const General_polygon_2<Traits> & p2,
OutputIterator oi); OutputIterator oi);
/*!
\ingroup PkgBooleanSetOperations2
Each one of these functions computes the symmetric difference between
two given polygons `p1` and `p2`, and inserts the resulting
polygons with holes into an output container through the output
iterator `oi`. The value type of the `OutputIterator` is either
`Polygon_with_holes_2` or
`General_polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class Traits, class OutputIterator> template <class Traits, class OutputIterator>
OutputIterator OutputIterator
symmetric_difference(const General_polygon_2<Traits> & p1, symmetric_difference(const General_polygon_2<Traits> & p1,
const General_polygon_with_holes_2<General_polygon_2<Traits> > & p2, const General_polygon_with_holes_2<General_polygon_2<Traits> > & p2,
OutputIterator oi); OutputIterator oi);
/*!
\ingroup PkgBooleanSetOperations2
Each one of these functions computes the symmetric difference between
two given polygons `p1` and `p2`, and inserts the resulting
polygons with holes into an output container through the output
iterator `oi`. The value type of the `OutputIterator` is either
`Polygon_with_holes_2` or
`General_polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class Polygon, class OutputIterator> template <class Polygon, class OutputIterator>
OutputIterator OutputIterator
symmetric_difference(const General_polygon_with_holes_2<Polygon> & p1, symmetric_difference(const General_polygon_with_holes_2<Polygon> & p1,
const General_polygon_with_holes_2<Polygon> & p2, const General_polygon_with_holes_2<Polygon> & p2,
OutputIterator oi); OutputIterator oi);
/*! /*!
\ingroup PkgBooleanSetOperations2 computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
Each one of these functions computes the symmetric difference between symmetric difference, if and only if it is contained in odd number of
two given polygons `p1` and `p2`, and inserts the resulting input polygons. (The value type of the input iterator is used to
polygons with holes into an output container through the output distinguish between the two.) The result, represented by a set
iterator `oi`. The value type of the `OutputIterator` is either of general polygon with holes, is inserted into an output container
`Polygon_with_holes_2` or through a given output iterator `oi`. The output iterator is
`General_polygon_with_holes_2`. returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
CONVERROR HtmlOnly needs treatment */
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class InputIterator, class OutputIterator> template <class InputIterator, class OutputIterator>
OutputIterator symmetric_difference(InputIterator begin, InputIterator end, OutputIterator symmetric_difference(InputIterator begin, InputIterator end,
OutputIterator oi); OutputIterator oi);
/*! /*!
\ingroup PkgBooleanSetOperations2 computes the symmetric difference of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
Each one of these functions computes the symmetric difference between symmetric difference, if and only if it is contained in odd number of
two given polygons `p1` and `p2`, and inserts the resulting input polygons. The result, represented by a set of general polygon with
polygons with holes into an output container through the output holes, is inserted into an output container through a given output
iterator `oi`. The value type of the `OutputIterator` is either iterator `oi`. The output iterator is returned. The value type of
`Polygon_with_holes_2` or the `OutputIterator` is `Traits::Polygon_with_holes_2`.
`General_polygon_with_holes_2`. */
template <class InputIterator1, class InputIterator2, class OutputIterator>
CONVERROR HtmlOnly needs treatment
<div align="center">
<table cellpadding=3 border="1">
<tr><th> Arg 1 type</th><th>Arg 2 type</th></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_2</td></tr>
<tr><td valign="center">Polygon_with_holes_2</td><td valign="center">Polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_2</td></tr>
<tr><td valign="center">General_polygon_with_holes_2</td><td valign="center">General_polygon_with_holes_2</td></tr>
</table>
</div>
CONVERROR EndHtmlOnly
Computes the symmetric difference of the general polygons (or general
polygons with holes) in the given range. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. (The value type of the input iterator is used to
distinguish between the two.) The result, represented by a set
of general polygon with holes, is inserted into an output container
through a given output iterator `oi`. The output iterator is
returned. The value type of the `OutputIterator` is
`Traits::Polygon_with_holes_2`.
Computes the union of the general polygons and general polygons
with holes in the given two ranges. A point is contained in the
symmetric difference, if and only if it is contained in odd number of
input polygons. The result, represented by a set of general polygon with
holes, is inserted into an output container through a given output
iterator `oi`. The output iterator is returned. The value type of
the `OutputIterator` is `Traits::Polygon_with_holes_2`.
\sa `CGAL::do_intersect`
\sa `CGAL::intersection`
\sa `CGAL::join`
\sa `CGAL::difference`
*/
template <class InputIterator1, class InputIterator2,
class OutputIterator>
OutputIterator symmetric_difference(InputIterator1 pgn_begin1, OutputIterator symmetric_difference(InputIterator1 pgn_begin1,
InputIterator1 pgn_end1, InputIterator1 pgn_end1,
InputIterator2 pgn_begin2, InputIterator2 pgn_begin2,
InputIterator2 pgn_end2, InputIterator2 pgn_end2,
OutputIterator oi); OutputIterator oi);
/// @}
} /* namespace CGAL */ } /* namespace CGAL */

2
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h
View File

@ -99,8 +99,6 @@ std::istream& operator>>(std::istream& in, CGAL::General_polygon_2<ArrTraits>& P
/*! /*!
\ingroup PkgBooleanSetOperations2
This operator exports a General_polygon to the output stream `out`. This operator exports a General_polygon to the output stream `out`.
An ASCII and a binary format exist. The format can be selected with An ASCII and a binary format exist. The format can be selected with

2
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_with_holes_2.h
View File

@ -48,8 +48,6 @@ std::istream& operator>>(std::istream& in, CGAL::General_polygon_with_holes_2<Po
/*! /*!
\ingroup PkgBooleanSetOperations2
This operator exports a General_polygon_with_holes_2 to the output stream `out`. This operator exports a General_polygon_with_holes_2 to the output stream `out`.
An ASCII and a binary format exist. The format can be selected with An ASCII and a binary format exist. The format can be selected with

2
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_with_holes_2.h
View File

@ -39,8 +39,6 @@ std::istream& operator>>(std::istream& in, CGAL::Polygon_with_holes_2<Kernel, Co
/*! /*!
\ingroup PkgBooleanSetOperations2
This operator exports a polygon with holes to the output stream `out`. This operator exports a polygon with holes to the output stream `out`.
An ASCII and a binary format exist. The format can be selected with An ASCII and a binary format exist. The format can be selected with

7
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/connect_holes.h
View File

@ -1,6 +1,7 @@
namespace CGAL { namespace CGAL {
/*! /*!
\addtogroup boolean_connect_holes Functions on Polygon with Holes
\ingroup PkgBooleanSetOperations2 \ingroup PkgBooleanSetOperations2
\anchor ref_bso_connect_holes \anchor ref_bso_connect_holes
@ -17,11 +18,13 @@ of `oi` is `Kernel::Point_2`.
\pre The input polygon with holes `pwh` is bounded (namely it has a valid outer boundary). \pre The input polygon with holes `pwh` is bounded (namely it has a valid outer boundary).
*/ */
/// @{
template <class Kernel, class Container, template <class Kernel, class Container,
class OutputIterator> class OutputIterator>
OutputIterator OutputIterator
connect_holes(const Polygon_with_holes_2<Kernel,Container>& pwh, connect_holes(const Polygon_with_holes_2<Kernel,Container>& pwh,
OutputIterator oi); OutputIterator oi);
/// @}
} /* namespace CGAL */ } /* namespace CGAL */