diff --git a/Mesh_3/doc/Mesh_3/Mesh_3.txt b/Mesh_3/doc/Mesh_3/Mesh_3.txt index aa42ec20bd6..2307a5d6772 100644 --- a/Mesh_3/doc/Mesh_3/Mesh_3.txt +++ b/Mesh_3/doc/Mesh_3/Mesh_3.txt @@ -555,9 +555,11 @@ Note that when the user provides his/her own vertex and cell base classes, the `MeshVertexBase_3` and `MeshCellBase_3` concepts impose additionnal requirements. -Parallel algorithms require the executable to be linked against the Intel TBB library. +Parallel algorithms require the executable to be linked against the +Intel TBB library. To control the number of threads used, the user may use the tbb::task_scheduler_init class. -See the TBB documentation for more details. +See the TBB documentation +for more details. \section Mesh_3_section_examples Examples diff --git a/STL_Extension/doc/STL_Extension/CGAL/Spatial_lock_grid_3.h b/STL_Extension/doc/STL_Extension/CGAL/Spatial_lock_grid_3.h index 2543e6517ea..4a4bd17dfb8 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Spatial_lock_grid_3.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Spatial_lock_grid_3.h @@ -5,14 +5,17 @@ namespace CGAL { \ingroup PkgStlExtension The class `Spatial_lock_grid_3` allows to lock -points with coordinates (x, y, z) in a 3D grid. For example, -it can be used by concurrent algorithms to lock simplices. -It is a model of `SurjectiveLockDataStructure`, with `Object` being -`P3` and `S(point)` being the cell of the 3D grid containing `point`. -`P3` must provide x(), y() and z() functions, +points with coordinates (x, y, z) in a 3D grid. +The point type is called `P3` here. `P3` must provide x(), y() and z() functions, returning the respective point coordinates as numbers whose type is a model of the concept of `CGAL::RealEmbeddable`. +It is a model of `SurjectiveLockDataStructure`, with `Object` being +`P3` and `S` being the function that maps a point to +the cell of the 3D grid containing this point. + +For example, it can be used by concurrent algorithms to lock simplices. + \tparam Grid_lock_tag allows to choose the locking strategy used by the structure. The following tags are available: - `Tag_non_blocking` is non-blocking (i.e.\ try_lock will always diff --git a/STL_Extension/doc/STL_Extension/STL_Extension.txt b/STL_Extension/doc/STL_Extension/STL_Extension.txt index 8da924e30ec..bd3ee2b4b6f 100644 --- a/STL_Extension/doc/STL_Extension/STL_Extension.txt +++ b/STL_Extension/doc/STL_Extension/STL_Extension.txt @@ -97,6 +97,8 @@ probably be useful for other kinds of graphs as well. The class `Concurrent_compact_container` provides the same features, but enables concurrency-safe `insert` and `erase` operations. Other operations are not concurrency-safe. +It requires the program to be linked against +the Intel TBB library. \section stl_multi Multiset with Extended Functionality diff --git a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h index 654febd9f6e..5cf89db8033 100644 --- a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h +++ b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h @@ -111,14 +111,14 @@ typedef unspecified_type Vertex_handle; typedef unspecified_type Cell_handle; /*! -\cgalAdvancedBegin Can be `CGAL::Sequential_tag` or `CGAL::Parallel_tag`. If it is `CGAL::Parallel_tag`, the following functions can be called concurrently: `create_vertex`, `create_cell`, `delete_vertex`, `delete_cell`. */ typedef unspecified_type Concurrency_tag; -/*! +/*! +\cgalAdvancedBegin This template class allows to get the type of a triangulation data structure that only changes the vertex type. It has to define a type `Rebind_vertex::%Other` which is a rebound triangulation data structure, that is, the diff --git a/Triangulation_3/doc/Triangulation_3/Triangulation_3.txt b/Triangulation_3/doc/Triangulation_3/Triangulation_3.txt index 84902f2a863..900670c5178 100644 --- a/Triangulation_3/doc/Triangulation_3/Triangulation_3.txt +++ b/Triangulation_3/doc/Triangulation_3/Triangulation_3.txt @@ -429,9 +429,11 @@ one). If those conditions are fulfilled, the insertion/removal of a range of points will be performed in parallel, and the individual insert/remove operations will be optionally thread-safe. -Parallel algorithms require the program to be linked against the Intel TBB library. +Parallel algorithms require the program to be linked against +the Intel TBB library. To control the number of threads used, the user may use the tbb::task_scheduler_init class. -See the TBB documentation for more details. +See the TBB documentation +for more details. \section Triangulation3secexamples Examples