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

add user minformation about mirror indices and the storage policy in the user manual

This commit is contained in:
Samuel Hornus 2012-07-18 10:12:43 +00:00
parent 034b8a4f1f
commit c12988a9cc
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Triangulation/doc_tex/Triangulation/triangulation.tex
View File

@ -241,7 +241,19 @@ alt="Index the vertices and neighbors of a full cell">
\end{figure}
\begin{ccAdvanced}
TODO: say something about TDSFullCellStoragePolicy
The index of a full cell $c$ in the $i$-th neighbor of $c$ is called the
\emph{$i$-th mirror-index} of $c$ (Figure~\ref{triangulation:fig:full-cell}).
Mirror indices are often needed for maintaining the triangulation data
structure. Thus, it might be desirable, for performance reasons, to store the
mirror indices alongside the references to the vertices and neighbors in a full
cell. This improves speed a little, but requires more memory.
\cgal\ provides the class template
\ccc{Triangulation_ds_full_cell<TriangulationDataStructure,
TDSFullCellStoragePolicy>} for representing full cells in a triangulation. Its
second template parameter is used to specify wether or not the mirror indices
should be kept in memory or computed on-the-fly, which is the default case.
Please refer to the documentation of that class template for specific details.
\end{ccAdvanced}
\subsubsection{Instantiating the class template}