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

Completed function description

This commit is contained in:
Efi Fogel 2012-09-12 14:39:39 +00:00
parent d30771c4c2
commit 3f4623cea0
3 changed files with 50 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Arrangement_on_surface_2/doc_tex/Sweep_line_2_ref/compute_intersection_points.tex
View File

@ -4,12 +4,26 @@
\ccInclude{CGAL/Sweep_line_2_algorithms.h}
\ccFunction{template <class InputIterator, class OutputIterator, class Traits>
\ccGlobalFunction{template <class InputIterator, class OutputIterator>
OutputIterator compute_intersection_points (InputIterator curves_begin,
InputIterator curves_end,
OutputIterator points,
bool report_endpoints = false,
Traits traits = Default_traits());}
InputIterator curves_end,
OutputIterator points,
bool report_endpoints = false);}
{Given a range of curves, compute all intersection points between two (or more)
input curves. When the flag \ccc{report_endpoints} is \ccc{true},
this function reports all the curve endpoints as well. If a curve
endpoint is also an intersection point, it is reported once (regardless
of the value of the \ccc{report_endpoints} flag). The value-type of
\ccc{InputIterator} is a curve type and the value-type of \ccc{OutputIterator}
is a point type. The output points are reported in an increasing
$xy$-lexicographical order.}
\ccGlue
\ccGlobalFunction{template <class InputIterator, class OutputIterator, class Traits>
OutputIterator compute_intersection_points (InputIterator curves_begin,
InputIterator curves_end,
OutputIterator points,
bool report_endpoints = false,
Traits traits);}
{given a range of curves, compute all intersection points between two (or more)
input curves. When the flag \ccc{report_endpoints} is \ccc{true},
this function reports all the curve endpoints as well. If a curve
@ -19,7 +33,6 @@ OutputIterator compute_intersection_points (InputIterator curves_begin,
value-type of \ccc{InputIterator} is \ccc{Traits::Curve_2}, and the
value-type of \ccc{OutputIterator} is \ccc{Traits::Point_2}.
The output points are reported in an increasing $xy$-lexicographical order.}
\end{ccRefFunction}
\ccRefPageEnd

27
Arrangement_on_surface_2/doc_tex/Sweep_line_2_ref/compute_subcurves.tex
View File

@ -4,13 +4,26 @@
\ccInclude{CGAL/Sweep_line_2_algorithms.h}
\ccFunction{template <class InputIterator, class OutputIterator, class Traits>
\ccGlobalFunction{template <class InputIterator, class OutputIterator>
OutputIterator compute_subcurves (InputIterator curves_begin,
InputIterator curves_end,
OutputIterator subcurves,
bool multiple_overlaps = false,
Traits traits = Default_traits());}
{given a range of curves, compute all $x$-monotone subcurves that are pairwise
InputIterator curves_end,
OutputIterator subcurves,
bool multiple_overlaps = false);}
{Given a range of curves, compute all $x$-monotone subcurves that are pairwise
disjoint in their interior, as induced by the input curves.
If the flag \ccc{multiple_overlaps} is \ccc{true}, then a subcurve that
represents an overlap of $k$ input curves is reported $k$ times; otherwise,
each subcurve is reported only once. The value-type of
\ccc{InputIterator} is a curve type, and the value-type of
\ccc{OutputIterator} is an $x$-monotone curve type.}
\ccGlue
\ccGlobalFunction{template <class InputIterator, class OutputIterator, class Traits>
OutputIterator compute_subcurves (InputIterator curves_begin,
InputIterator curves_end,
OutputIterator subcurves,
bool multiple_overlaps = false,
Traits traits = Default_traits());}
{Given a range of curves, compute all $x$-monotone subcurves that are pairwise
disjoint in their interior, as induced by the input curves.
If the flag \ccc{multiple_overlaps} is \ccc{true}, then a subcurve that
represents an overlap of $k$ input curves is reported $k$ times; otherwise,
@ -18,7 +31,7 @@ OutputIterator compute_subcurves (InputIterator curves_begin,
of the \ccc{ArrangementTraits_2} concept, such that the value-type of
\ccc{InputIterator} is \ccc{Traits::Curve_2}, and the value-type of
\ccc{OutputIterator} is \ccc{Traits::X_monotone_curve_2}.}
\end{ccRefFunction}
\ccRefPageEnd

14
Arrangement_on_surface_2/doc_tex/Sweep_line_2_ref/do_curves_intersect.tex
View File

@ -4,17 +4,25 @@
\ccInclude{CGAL/Sweep_line_2_algorithms.h}
\ccFunction{template <class InputIterator, class Traits>
\ccGlobalFunction{template <class InputIterator>
bool do_curves_intersect (InputIterator curves_begin,
InputIterator curves_end);}
{given a range of curves, check whether there is at least one pair of curves
that intersect in their interior. The function returns \ccc{true} if such
a pair is found, and \ccc{false} if all curves are pairwise disjoint in
their interior. The value-type of \ccc{InputIterator} is a curve type.}
\ccGlue
\ccGlobalFunction{template <class InputIterator, class Traits>
bool do_curves_intersect (InputIterator curves_begin,
InputIterator curves_end,
Traits traits = Default_traits());}
{given a range of curves, check whether there is at least one pair of curves
that intersect in their interior. The function returns \ccc{true} if such
a pair is found, and \ccc{false} if all curves are pairwise disjoint in
their interior.The \ccc{Traits} type must be a model
their interior. The \ccc{Traits} type must be a model
of the \ccc{ArrangementTraits_2} concept, such that the value-type of
\ccc{InputIterator} is \ccc{Traits::Curve_2}.}
\end{ccRefFunction}
\ccRefPageEnd