Document Regular_triangulation_euclidean_traits

This commit is contained in:
Clement Jamin 2015-10-27 15:19:37 +01:00
parent a186ec9f33
commit c7e1c825cd
3 changed files with 28 additions and 1 deletions

View File

@ -45,7 +45,8 @@ Parameters
\tparam RegularTriangulationTraits is the geometric traits class that provides the \tparam RegularTriangulationTraits is the geometric traits class that provides the
geometric types and predicates needed by regular triangulations. geometric types and predicates needed by regular triangulations.
`RegularTriangulationTraits` must be a model of the concept `RegularTriangulationTraits` must be a model of the concept
`RegularTriangulationTraits`. `RegularTriangulationTraits`. CGAL provides the class
`Regular_triangulation_euclidean_traits` for this purpose.
\tparam TriangulationDataStructure must be a model of the concept \tparam TriangulationDataStructure must be a model of the concept
`TriangulationDataStructure`. This model is used to store `TriangulationDataStructure`. This model is used to store

View File

@ -0,0 +1,25 @@
namespace CGAL {
/*!
\ingroup PkgTriangulationsTriangulationClasses
The class `Regular_triangulation_euclidean_traits` is designed as a traits
class for the class
`Regular_triangulation<RegularTriangulationTraits, TriangulationDataStructure>`.
\tparam K must be a model of the `Kernel_d` concept. We recommend to use
`Epick_d`.
\tparam Weight is optional. If is it not provided, `K::RT` will be used.
\cgalModels `RegularTriangulationTraits`
*/
template < class K, class Weight = typename K::RT >
class Regular_triangulation_euclidean_traits
: public K
{
};
} //namespace CGAL

View File

@ -106,6 +106,7 @@ The latter two concepts are also abbreviated respectively as `TrVertex` and `TrF
- `CGAL::Regular_triangulation<RegularTriangulationTraits, TriangulationDataStructure>` - `CGAL::Regular_triangulation<RegularTriangulationTraits, TriangulationDataStructure>`
- `CGAL::Triangulation_vertex<TriangulationTraits, Data, TriangulationDSVertex>` - `CGAL::Triangulation_vertex<TriangulationTraits, Data, TriangulationDSVertex>`
- `CGAL::Triangulation_full_cell<TriangulationTraits, Data, TriangulationDSFullCell>` - `CGAL::Triangulation_full_cell<TriangulationTraits, Data, TriangulationDSFullCell>`
- `CGAL::Regular_triangulation_euclidean_traits<K, Weight>`
## Enums ## ## Enums ##