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

Document a precondition, dimension()==2, in get_conflict_* functions.

This commit is contained in:
Laurent Rineau 2008-10-13 10:00:20 +00:00
parent 067ce547d1
commit 43f08a7be3
3 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_Delaunay_triangulation_2.tex
View File

@ -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 <class OutputItFaces>
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 <class OutputItBoundaryEdges>
OutputItBoundaryEdges

6
Triangulation_2/doc_tex/Triangulation_2_ref/Delaunay_triangulation_2.tex
View File

@ -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 <class OutputItFaces>
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 <class OutputItBoundaryEdges>
OutputItBoundaryEdges

12
Triangulation_2/doc_tex/Triangulation_2_ref/Regular_triangulation_2.tex
View File

@ -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 <class OutputItFaces, class OutputItBoundaryEdges>
std::pair<OutputItFaces,OutputItBoundaryEdges>
@ -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 <class OutputItFaces,
class OutputItHiddenVertices>
@ -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 <class OutputItBoundaryEdges, class OutputItHiddenVertices>
std::pair<OutputItBoundaryEdges,OutputItHiddenVertices>
@ -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 <class OutputItBoundaryEdges>
OutputItBoundaryEdges