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

doc bug fix

This commit is contained in:
Andreas Fabri 2012-09-25 08:29:12 +00:00
parent ba4d718189
commit d35d16eb01
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSCellBase_3.h
View File

@ -3,18 +3,21 @@
\ingroup PkgPeriodic3Triangulation3Concepts \ingroup PkgPeriodic3Triangulation3Concepts
\cgalconcept \cgalconcept
A refinement of the concept `TriangulationDSCellBase_3`
which adds an API for offsets.
At the base level (see Sections \ref P3Triangulation3secdesign At the base level (see Sections \ref P3Triangulation3secdesign
and \ref TDS3secdesign), a cell stores handles to its four vertices and \ref TDS3secdesign), a cell stores handles to its four vertices
and to its four neighbor cells. The vertices and neighbors are and to its four neighbor cells. The vertices and neighbors are
indexed 0, 1, 2 and 3. Neighbor \f$ i\f$ lies opposite to vertex \f$ i\f$. indexed 0, 1, 2 and 3. Neighbor `i` lies opposite to vertex `i`.
\refines ::TriangulationDSCellBase_3
For periodic triangulation the cell base class needs to For periodic triangulation the cell base class needs to
additionally store an offset for each vertex. Only the last three additionally store an offset for each vertex. Only the last three
bits of each integer are required to be stored. The remaining part bits of each integer are required to be stored. The remaining part
does not contain any information. does not contain any information.
\refines ::TriangulationDSCellBase_3
\hasModel CGAL::Periodic_3_triangulation_ds_cell_base_3 \hasModel CGAL::Periodic_3_triangulation_ds_cell_base_3
\sa `TriangulationDataStructure_3` \sa `TriangulationDataStructure_3`

9
Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSVertexBase_3.h
View File

@ -3,17 +3,18 @@
\ingroup PkgPeriodic3Triangulation3Concepts \ingroup PkgPeriodic3Triangulation3Concepts
\cgalconcept \cgalconcept
A refinement of the concept `TriangulationDSVertexBase_3`
which adds an API for offset.
At the base level of 3D-triangulations At the base level of 3D-triangulations
(see Sections \ref P3Triangulation3secdesign and \ref TDS3secdesign), (see Sections \ref P3Triangulation3secdesign and \ref TDS3secdesign),
a vertex provides access to one of its incident cells through a handle. a vertex provides access to one of its incident cells through a handle.
For optimization purposes we need to extend the concept
`TriangulationDSVertexBase_3` as follows.
\refines ::TriangulationDSVertexBase_3 \refines ::TriangulationDSVertexBase_3
Periodic_3TriangulationDSVertexBase_3 needs to store an offset
and some index inside the vertex.
\hasModel CGAL::Periodic_3_triangulation_ds_vertex_base_3 \hasModel CGAL::Periodic_3_triangulation_ds_vertex_base_3