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

Fixed documentation of intersection return types

This commit is contained in:
Efi Fogel 2020-04-06 16:37:46 +03:00
parent 50fd3f8fd7
commit 61d51502c0
2 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h
View File

@ -18,7 +18,7 @@ public:
/*! computes the intersections of `xc1` and `xc2` and inserts them <I>in an
* ascending lexicographic \f$ xy\f$-order</I> into a range begining at
* `oi`. The value-type of `OutputIterator` is `boost::variant` of either the
* `oi`. The type `OutputIterator` dereferences a `boost::variant` of either the
* type `pair<ArrTraits::Point_2,ArrTraits::Multiplicity>` or the type
* `ArrTraits::X_monotone_curve_2`. An object of the former type represents an
* intersection point with its multiplicity (in case the multiplicity is

35
Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h
View File

@ -16,24 +16,23 @@ public:
/// A model of this concept must provide:
/// @{
/*!
computes the intersections of `xc1` and `xc2` and
inserts them <I>in an ascending lexicographic \f$ xy\f$-order</I> into the
output iterator `oi`. The value-type of `Output_iterator` is
`CGAL::Object`, where each `Object` wraps either a
`pair<ArrDirectionalTraits::Point_2, ArrDirectionalTraits::Multiplicity>` object, which
represents an intersection point with its multiplicity (in case the
multiplicity is undefined or unknown, it is set to \f$ 0\f$) or an
`ArrDirectionalTraits::X_monotone_curve_2` object, representing an
overlapping subcurve of `xc1` and `xc2`. In the latter case,
the overlapping subcurves are given the direction of `xc1` and
`xc2` if their directions are identical. Otherwise, the overlapping
subcurves are given an arbitrary direction. The operator returns a
past-the-end iterator for the output sequence.
*/
Output_iterator operator()(ArrDirectionalTraits::X_monotone_curve_2 xc1,
ArrDirectionalTraits::X_monotone_curve_2 xc2,
Output_iterator& oi);
/*! computes the intersections of `xc1` and `xc2` and inserts them <I>in an
* ascending lexicographic \f$ xy\f$-order</I> into a range begining at
* `oi`. The type `OutputIterator` dereferences a `boost::variant` of either the
* type `pair<ArrDirectionalTraits::Point_2,
* ArrDirectionalTraits::Multiplicity>` or the type
* `ArrDirectionalTraits::X_monotone_curve_2`. An object of the former type
* represents an intersection point with its multiplicity (in case the
* multiplicity is undefined or unknown, it is set to \f$ 0\f$). An object of
* the latter type representing an overlapping subcurve of `xc1` and `xc2`. The
* overlapping subcurves are given the direction of `xc1` and `xc2` if their
* directions are identical. Otherwise, the overlapping subcurves are given an
* arbitrary direction. The operator returns a past-the-end iterator of the
* destination range.
*/
OutputIterator operator()(ArrDirectionalTraits::X_monotone_curve_2 xc1,
ArrDirectionalTraits::X_monotone_curve_2 xc2,
Output_iterator& oi);
/// @}