Document Default in the 3D triangulations

This commit is contained in:
Andreas Fabri 2016-03-25 09:46:16 +01:00
parent 31dae1898f
commit bd923feda7
3 changed files with 7 additions and 4 deletions

View File

@ -11,7 +11,8 @@ Delaunay triangulation.
\tparam TriangulationDataStructure_3 is the triangulation data structure. \tparam TriangulationDataStructure_3 is the triangulation data structure.
It has the default value `Triangulation_data_structure_3<Triangulation_vertex_base_3<DelaunayTriangulationTraits_3>, It has the default value `Triangulation_data_structure_3<Triangulation_vertex_base_3<DelaunayTriangulationTraits_3>,
Delaunay_triangulation_cell_base_3<DelaunayTriangulationTraits_3> >`. Delaunay_triangulation_cell_base_3<DelaunayTriangulationTraits_3> >`.
`Default` may be used.
\tparam LocationPolicy is a tag which must be a `Location_policy<Tag>`: \tparam LocationPolicy is a tag which must be a `Location_policy<Tag>`:
either `Fast_location` or `Compact_location`. either `Fast_location` or `Compact_location`.
@ -35,7 +36,7 @@ manual \ref Triangulation3exfastlocation.
\tparam SurjectiveLockDataStructure is an optional parameter to specify the type of the spatial lock data structure. \tparam SurjectiveLockDataStructure is an optional parameter to specify the type of the spatial lock data structure.
It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when
TriangulationDataStructure_3::Concurrency_tag is Parallel_tag). `TriangulationDataStructure_3::Concurrency_tag` is `Parallel_tag`).
It must be a model of the `SurjectiveLockDataStructure` concept, It must be a model of the `SurjectiveLockDataStructure` concept,
with `Object` being a `Point`. with `Object` being a `Point`.
The default value is `Spatial_lock_grid_3<Tag_priority_blocking>` if The default value is `Spatial_lock_grid_3<Tag_priority_blocking>` if

View File

@ -31,10 +31,11 @@ of all simplices are regular.
\tparam TriangulationDataStructure_3 is the triangulation data structure. \tparam TriangulationDataStructure_3 is the triangulation data structure.
It has the default value `Triangulation_data_structure_3<Triangulation_vertex_base_3<RegularTriangulationTraits_3>, Regular_triangulation_cell_base_3<RegularTriangulationTraits_3> >`. It has the default value `Triangulation_data_structure_3<Triangulation_vertex_base_3<RegularTriangulationTraits_3>, Regular_triangulation_cell_base_3<RegularTriangulationTraits_3> >`.
`Default` may be used.
\tparam SurjectiveLockDataStructure is an optional parameter to specify the type of the spatial lock data structure. \tparam SurjectiveLockDataStructure is an optional parameter to specify the type of the spatial lock data structure.
It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when
TriangulationDataStructure_3::Concurrency_tag is Parallel_tag). `TriangulationDataStructure_3::Concurrency_tag` is `Parallel_tag`).
It must be a model of the `SurjectiveLockDataStructure` concept, It must be a model of the `SurjectiveLockDataStructure` concept,
with `Object` being a `Point`. with `Object` being a `Point`.
The default value is `Spatial_lock_grid_3<Tag_priority_blocking>` if The default value is `Spatial_lock_grid_3<Tag_priority_blocking>` if

View File

@ -11,10 +11,11 @@ of points.
\tparam TriangulationDataStructure_3 is the triangulation data structure. \tparam TriangulationDataStructure_3 is the triangulation data structure.
It has the default value `Triangulation_data_structure_3< Triangulation_vertex_base_3<TriangulationTraits_3>,Triangulation_cell_base_3<TriangulationTraits_3> >`. It has the default value `Triangulation_data_structure_3< Triangulation_vertex_base_3<TriangulationTraits_3>,Triangulation_cell_base_3<TriangulationTraits_3> >`.
`Default` may be used.
\tparam SurjectiveLockDataStructure is an optional parameter to specify the type of the spatial lock data structure. \tparam SurjectiveLockDataStructure is an optional parameter to specify the type of the spatial lock data structure.
It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when
TriangulationDataStructure_3::Concurrency_tag is Parallel_tag). `TriangulationDataStructure_3::Concurrency_tag` is `Parallel_tag`).
It must be a model of the `SurjectiveLockDataStructure` concept, It must be a model of the `SurjectiveLockDataStructure` concept,
with `Object` being a `Point`. with `Object` being a `Point`.
The default value is `Spatial_lock_grid_3<Tag_priority_blocking>` if The default value is `Spatial_lock_grid_3<Tag_priority_blocking>` if