mirror of https://github.com/CGAL/cgal
Fixes the doc according to Monique's review
This commit is contained in:
parent
77b9ad86a7
commit
b00eb1ffa2
|
|
@ -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
|
||||
<a href="http://www.threadingbuildingblocks.org">Intel TBB library</a>.
|
||||
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 <a href="http://www.threadingbuildingblocks.org/documentation">TBB documentation</a>
|
||||
for more details.
|
||||
|
||||
\section Mesh_3_section_examples Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -97,6 +97,8 @@ probably be useful for other kinds of graphs as well.
|
|||
The class `Concurrent_compact_container<T, Allocator>`
|
||||
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 <a href="http://www.threadingbuildingblocks.org">Intel TBB library</a>.
|
||||
|
||||
\section stl_multi Multiset with Extended Functionality
|
||||
|
||||
|
|
|
|||
|
|
@ -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<Vb2>::%Other` which is a <I>rebound</I> triangulation data structure, that is, the
|
||||
|
|
|
|||
|
|
@ -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 <a href="http://www.threadingbuildingblocks.org">Intel TBB library</a>.
|
||||
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 <a href="http://www.threadingbuildingblocks.org/documentation">TBB documentation</a>
|
||||
for more details.
|
||||
|
||||
\section Triangulation3secexamples Examples
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue