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

Doc fixes

This commit is contained in:
Mael Rouxel-Labbé 2017-08-24 10:56:44 +02:00
parent 1473db57dc
commit 1fce05f81f
3 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Alpha_shapes_2/doc/Alpha_shapes_2/Alpha_shapes_2.txt
View File

@ -120,7 +120,7 @@ points cannot be inserted or removed.
We currently do not specify concepts for the underlying triangulation We currently do not specify concepts for the underlying triangulation
type. Models that work for a basic alpha shape are the classes type. Models that work for a basic alpha shape are the classes
`Delaunay_triangulation_2`, `Periodic_2_Delaunay_triangulation_2` and `Delaunay_triangulation_2`, `Periodic_2_Delaunay_triangulation_2`, and
`Triangulation_hierarchy_2` templated with a Delaunay `Triangulation_hierarchy_2` templated with a Delaunay
triangulation. A model that works for a weighted alpha shape is triangulation. A model that works for a weighted alpha shape is
the class `Regular_triangulation_2`. the class `Regular_triangulation_2`.
@ -144,18 +144,18 @@ as we shall see in the following section.
\subsection AlphaShape2D_ConceptAndModelsTDS Triangulation data structure \subsection AlphaShape2D_ConceptAndModelsTDS Triangulation data structure
Additionally requirements are put when using weighted or Additional requirements are put when using weighted or
periodic triangulations as underlying triangulation: periodic triangulations as underlying triangulation:
<ul> <ul>
<li> When using a weighted triangulation (`Regular_triangulation_2`), the vertex <li> When using a weighted triangulation (`Regular_triangulation_2`), the vertex
and face classes must be models to both `AlphaShapeVertex_2` and and face classes must respectively be models to both `AlphaShapeVertex_2` and
`RegularTriangulationVertexBase_2`, as well as `RegularTriangulationVertexBase_2`, and to both
`AlphaShapeCell_2` and `RegularTriangulationFaceBase_2` respectively `AlphaShapeFace_2` and `RegularTriangulationFaceBase_2`
(see example: \ref I1_SectWeightedAS2D). (see example: \ref I1_SectWeightedAS2D).
<li> When using a periodic triangulation (`Periodic_2_Delaunay_triangulation_2`), <li> When using a periodic triangulation (`Periodic_2_Delaunay_triangulation_2`),
the vertex and face classes must be models to both `AlphaShapeVertex_2` the vertex and face classes must respectively be models to both `AlphaShapeVertex_2`
and `Periodic_2TriangulationVertexBase_2`, and `Periodic_2TriangulationVertexBase_2`,
as well as `AlphaShapeFace_2` and `Periodic_2TriangulationFaceBase_2` and to both `AlphaShapeFace_2` and `Periodic_2TriangulationFaceBase_2`
(see example: \ref AlphaShape_2DExampleForPeriodicAlphaShapes). (see example: \ref AlphaShape_2DExampleForPeriodicAlphaShapes).
</ul> </ul>

12
Alpha_shapes_3/doc/Alpha_shapes_3/Alpha_shapes_3.txt
View File

@ -238,19 +238,19 @@ and `Fixed_alpha_shape_cell_base_3<Gt>`, respectively.
\subsection AlphaShape3D_ConceptAndModelsTDS Triangulation data structure \subsection AlphaShape3D_ConceptAndModelsTDS Triangulation data structure
Additionally requirements are put when using weighted or Additional requirements are put when using weighted or
periodic triangulations as underlying triangulation: periodic triangulations as underlying triangulation:
<ul> <ul>
<li> When using a weighted triangulation (`Regular_triangulation_3` or <li> When using a weighted triangulation (`Regular_triangulation_3` or
`Periodic_3_regular_triangulation_3`), the vertex `Periodic_3_regular_triangulation_3`), the vertex
and cell classes must be models to both `AlphaShapeVertex_3` and and cell classes must respectively be models to both `AlphaShapeVertex_3` and
`RegularTriangulationVertexBase_3`, as well as `RegularTriangulationVertexBase_3`, and to both
`AlphaShapeCell_3` and `RegularTriangulationCellBase_3` respectively `AlphaShapeCell_3` and `RegularTriangulationCellBase_3`
(see example: \ref AlphaShape_3DExampleforWeightedAlphaShapes). (see example: \ref AlphaShape_3DExampleforWeightedAlphaShapes).
<li> When using a periodic triangulation (`Periodic_3_Delaunay_triangulation_3` <li> When using a periodic triangulation (`Periodic_3_Delaunay_triangulation_3`
or `Periodic_3_regular_triangulation_3`), the vertex and cell classes must or `Periodic_3_regular_triangulation_3`), the vertex and cell classes must
be models to both `AlphaShapeVertex_3` and `Periodic_3TriangulationDSVertexBase_3`, respectively be models to both `AlphaShapeVertex_3` and `Periodic_3TriangulationDSVertexBase_3`,
as well as `AlphaShapeCell_3` and `Periodic_3TriangulationDSCellBase_3` and to both `AlphaShapeCell_3` and `Periodic_3TriangulationDSCellBase_3`
(see example: \ref AlphaShape_3DExampleForPeriodicAlphaShapes). (see example: \ref AlphaShape_3DExampleForPeriodicAlphaShapes).
</ul> </ul>

3
Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt
View File

@ -75,8 +75,8 @@ of the concept `Periodic_2Offset_2`.
## Concepts ## ## Concepts ##
- `Periodic_2TriangulationTraits_2`
- `Periodic_2DelaunayTriangulationTraits_2` - `Periodic_2DelaunayTriangulationTraits_2`
- `TriangulationDataStructure_2`
- `Periodic_2TriangulationFaceBase_2` - `Periodic_2TriangulationFaceBase_2`
- `Periodic_2TriangulationVertexBase_2` - `Periodic_2TriangulationVertexBase_2`
- `Periodic_2Offset_2` - `Periodic_2Offset_2`
@ -95,6 +95,7 @@ of the concept `Periodic_2Offset_2`.
### Traits Classes ### ### Traits Classes ###
- `CGAL::Periodic_2_triangulation_traits_2<Traits,Periodic_2Offset_2>` - `CGAL::Periodic_2_triangulation_traits_2<Traits,Periodic_2Offset_2>`
- `CGAL::Periodic_2_Delaunay_triangulation_traits_2<Traits,Periodic_2Offset_2>`
## Enums ## ## Enums ##