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

add segment cell iterator description in the doc

This commit is contained in:
Jane Tournois 2020-04-03 15:06:18 +02:00
parent 5377911c81
commit 082cf96409
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h
View File

@ -1303,6 +1303,11 @@ Points points() const;
/*!\name Segment Cell Iterator
\cgalModifBegin
The triangulation defines an iterator that visits cells intersected by a line segment.
Segment Cell Iterator iterates over a sequence of cells which union contains the segment `[s,t]`.
The sequence of cells is "minimal" (removing any cell would make the union of the
renaming cells not entirely containing `[s,t]`) and sorted along `[s,t]`.
The "minimality" of the sequence implies that in degenerate cases,
only one cell incident to the traversed simplex will be reported.
The cells visited form a facet-connected region containing both source and target points of the line segment `[s,t]`.
Each cell falls within one or more of the following categories: