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

Triangulation_2: Add some () to function names in the User Manual

This commit is contained in:
Andreas Fabri 2023-10-16 13:18:57 +01:00
parent a0ca27e40a
commit e5c84bf099
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Triangulation_2/doc/Triangulation_2/Triangulation_2.txt
View File

@ -742,8 +742,8 @@ The class `Regular_triangulation_2<Traits, Tds>`
is designed to maintain the is designed to maintain the
regular triangulation of a set of \f$ 2d\f$ weighted points. regular triangulation of a set of \f$ 2d\f$ weighted points.
It derives from the class `Triangulation_2<Traits, Tds>`. It derives from the class `Triangulation_2<Traits, Tds>`.
The functions `insert` and The functions `insert()` and
`remove` are overwritten to handle weighted points `remove()` are overwritten to handle weighted points
and maintain the regular and maintain the regular
property. property.
The function `move()` is not The function `move()` is not
@ -1184,7 +1184,7 @@ classes.
The class `Triangulation_hierarchy_2<Tr>` inherits from the The class `Triangulation_hierarchy_2<Tr>` inherits from the
triangulation type passed as template parameter `Tr`. triangulation type passed as template parameter `Tr`.
The `insert`, `move`, and `remove` member functions The `insert()`, `move()`, and `remove()` member functions
are overwritten to update the data structure at each operation. are overwritten to update the data structure at each operation.
The locate queries are also overwritten to take advantage of the data The locate queries are also overwritten to take advantage of the data
structure for a fast processing. structure for a fast processing.
@ -1327,7 +1327,7 @@ data structure.
The most efficient method to insert (weighted) points in a The most efficient method to insert (weighted) points in a
Delaunay (or regular) triangulation is to provide an iterator Delaunay (or regular) triangulation is to provide an iterator
range over (weighted) points to the insert function. However, an iterator range of range over (weighted) points to the `insert()` function. However, an iterator range of
(weighted) points does not allow the user to set different information to each vertex. (weighted) points does not allow the user to set different information to each vertex.
To solve this problem, in the case the vertex type of the triangulation To solve this problem, in the case the vertex type of the triangulation
is a model of the concept `TriangulationVertexBaseWithInfo_2` is a model of the concept `TriangulationVertexBaseWithInfo_2`
@ -1339,7 +1339,7 @@ of the corresponding point given in the range.
\subsection Triangulation_2UsinganIteratorOverPairs Using an Iterator Over Pairs \subsection Triangulation_2UsinganIteratorOverPairs Using an Iterator Over Pairs
Each point and its information are gathered into a pair. We provide Each point and its information are gathered into a pair. We provide
the `insert` function of the triangulation with a range of such pairs. the `insert()` function of the triangulation with a range of such pairs.
\cgalExample{Triangulation_2/info_insert_with_pair_iterator_2.cpp} \cgalExample{Triangulation_2/info_insert_with_pair_iterator_2.cpp}
\subsection Triangulation_2UsingtheBoostZipIterator Using the Boost Zip Iterator \subsection Triangulation_2UsingtheBoostZipIterator Using the Boost Zip Iterator