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

typos

This commit is contained in:
Andreas Fabri 2025-05-22 18:10:43 +01:00
parent f8b2d74329
commit 2da6189392
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
STL_Extension/doc/STL_Extension/CGAL/Compact_container.h
View File

@ -71,7 +71,7 @@ the halfedge data structures.
It supports bidirectional iterators and allows a constant time amortized It supports bidirectional iterators and allows a constant time amortized
`insert()` operation. You cannot specify where to insert new objects `insert()` operation. You cannot specify where to insert new objects
(i.e.\ you don't know where they will end up in the iterator sequence, (i.e., you don't know where they will end up in the iterator sequence,
although `insert()` returns an iterator pointing to the newly inserted although `insert()` returns an iterator pointing to the newly inserted
object). You can erase any element with a constant time complexity. object). You can erase any element with a constant time complexity.
@ -80,7 +80,7 @@ memory since it doesn't store two additional pointers for the iterator needs.
It doesn't deallocate elements until the destruction or `clear()` of the It doesn't deallocate elements until the destruction or `clear()` of the
container. The iterator does not have constant amortized time complexity for container. The iterator does not have constant amortized time complexity for
the increment and decrement operations in all cases, only when not too many the increment and decrement operations in all cases, only when not too many
elements have not been freed (i.e.\ when the `size()` is close to the elements have not been freed (i.e., when the `size()` is close to the
`capacity()`). Iterating from `begin()` to `end()` takes `capacity()`). Iterating from `begin()` to `end()` takes
\cgalBigO{capacity()} time, not `size()`. In the case where the container \cgalBigO{capacity()} time, not `size()`. In the case where the container
has a small `size()` compared to its `capacity()`, we advise to has a small `size()` compared to its `capacity()`, we advise to
@ -96,10 +96,10 @@ geometric graphs like handles to vertices in triangulations.
In addition, in a way inspired from the Boost.Intrusive containers, it is In addition, in a way inspired from the Boost.Intrusive containers, it is
possible to construct iterators from references to values in containers possible to construct iterators from references to values in containers
using the `iterator_to` and `s_iterator_to` functions. using the `iterator_to()` and `s_iterator_to()` functions.
The objects stored in the `Compact_container` can optionally store an The objects stored in the `Compact_container` can optionally store an
"erase counter". If it exists, i.e.\ if the object is a model of the "erase counter". If it exists, i.e, if the object is a model of the
`ObjectWithEraseCounter` concept, each time an object is erased from the `ObjectWithEraseCounter` concept, each time an object is erased from the
container, the erase counter of the object will be incremented. container, the erase counter of the object will be incremented.
For example, this erase counter can be exploited using the `CC_safe_handle` For example, this erase counter can be exploited using the `CC_safe_handle`
@ -512,13 +512,13 @@ size_type capacity() const;
/// @{ /// @{
/*! /*!
returns true if the element `pos` is used (i.e.\ valid). returns true if the element `pos` is used (i.e., valid).
*/ */
bool is_used(const_iterator pos) const; bool is_used(const_iterator pos) const;
/*! /*!
returns true if the element at position `i` in the container is used returns true if the element at position `i` in the container is used
(i.e.\ valid). (i.e., valid).
\pre \f$ 0 \leq \f$ `i` \f$ < \f$ `capacity()` \pre \f$ 0 \leq \f$ `i` \f$ < \f$ `capacity()`
*/ */