From 43f08a7be316f00c9df9aaa6a05fd54ce92f3b3f Mon Sep 17 00:00:00 2001 From: Laurent Rineau Date: Mon, 13 Oct 2008 10:00:20 +0000 Subject: [PATCH] Document a precondition, dimension()==2, in get_conflict_* functions. --- .../Constrained_Delaunay_triangulation_2.tex | 5 +++-- .../Triangulation_2_ref/Delaunay_triangulation_2.tex | 6 ++++-- .../Triangulation_2_ref/Regular_triangulation_2.tex | 12 ++++++++---- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_Delaunay_triangulation_2.tex b/Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_Delaunay_triangulation_2.tex index 6e44d10114d..d65d75ede0b 100644 --- a/Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_Delaunay_triangulation_2.tex +++ b/Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_Delaunay_triangulation_2.tex @@ -223,7 +223,7 @@ of the conflict zone are output in counterclockwise order and each edge is described through its incident face which is not in conflict with \ccc{p}. The function returns in a std::pair the resulting output iterators. -} +\ccPrecond dimension()==2} \ccMethod{template OutputItFaces @@ -231,7 +231,8 @@ The function returns in a std::pair the resulting output iterators. OutputItFaces fit, Face_handle start) const;} {Same as above except that only the faces in conflict with \ccc{p} -are output. The function returns the resulting output iterator.} +are output. The function returns the resulting output iterator. +\ccPrecond dimension()==2} \ccMethod{template OutputItBoundaryEdges diff --git a/Triangulation_2/doc_tex/Triangulation_2_ref/Delaunay_triangulation_2.tex b/Triangulation_2/doc_tex/Triangulation_2_ref/Delaunay_triangulation_2.tex index 34f9393d4f6..160d5eb61fe 100644 --- a/Triangulation_2/doc_tex/Triangulation_2_ref/Delaunay_triangulation_2.tex +++ b/Triangulation_2/doc_tex/Triangulation_2_ref/Delaunay_triangulation_2.tex @@ -165,7 +165,8 @@ The boundary edges of the conflict zone are output in counter-clockwise order and each edge is described through its incident face which is not in conflict with \ccc{p}. -The function returns in a std::pair the resulting output iterators.} +The function returns in a std::pair the resulting output iterators. +\ccPrecond dimension()==2} \ccMethod{template OutputItFaces @@ -173,7 +174,8 @@ The function returns in a std::pair the resulting output iterators.} OutputItFaces fit, Face_handle start) const;} {same as above except that only the faces in conflict with \ccc{p} -are output. The function returns the resulting output iterator.} +are output. The function returns the resulting output iterator. +\ccPrecond dimension()==2} \ccMethod{template OutputItBoundaryEdges diff --git a/Triangulation_2/doc_tex/Triangulation_2_ref/Regular_triangulation_2.tex b/Triangulation_2/doc_tex/Triangulation_2_ref/Regular_triangulation_2.tex index aa97e30689c..4816186111d 100644 --- a/Triangulation_2/doc_tex/Triangulation_2_ref/Regular_triangulation_2.tex +++ b/Triangulation_2/doc_tex/Triangulation_2_ref/Regular_triangulation_2.tex @@ -239,7 +239,8 @@ located in \ccc{lt,loc,li}.} the conflict zone are output in counter-clockwise order and each edge is described through its incident face which is not in conflict with \ccc{p}. The function returns in a CGAL::Triple the resulting output - iterators.} + iterators. + \ccPrecond dimension()==2} \ccMethod{template std::pair @@ -249,7 +250,8 @@ located in \ccc{lt,loc,li}.} same as above except that only the faces in conflict with \ccc{p} and the boundary edges of the conflict zone are output via the corresponding output iterators. The function returns - in a std::pair the resulting output iterators.} + in a std::pair the resulting output iterators. + \ccPrecond dimension()==2} \ccMethod{template @@ -260,7 +262,8 @@ located in \ccc{lt,loc,li}.} same as above except that only the faces in conflict with \ccc{p} and the vertices that would be hidden by \ccc{p} are output via the corresponding output iterators. The function returns - in a std::pair the resulting output iterators.} + in a std::pair the resulting output iterators. + \ccPrecond dimension()==2} \ccMethod{template std::pair @@ -281,7 +284,8 @@ located in \ccc{lt,loc,li}.} OutputItFaces fit, Face_handle start) const;} {same as above except that only the faces in conflict with \ccc{p} -are output. The function returns the resulting output iterator.} +are output. The function returns the resulting output iterator. +\ccPrecond dimension()==2} \ccMethod{template OutputItBoundaryEdges