Mercurial > hg > ucx / changeset

     1.1 --- a/src/cx/hash_map.h	Fri May 27 13:25:42 2022 +0200
     1.2 +++ b/src/cx/hash_map.h	Fri May 27 14:02:14 2022 +0200
     1.3 @@ -91,9 +91,9 @@
     1.4   *
     1.5   * If \p buckets is zero, an implementation defined default will be used.
     1.6   *
     1.7 - * @note Iterators provided by this hash map implementation do provide the remove operation, because
     1.8 - * a remove never causes an immediate rehashing. The iterators are also position-aware in the sense
     1.9 - * that the index is initialized with zero and incremented when the iterator advances.
    1.10 + * @note Iterators provided by this hash map implementation provide the remove operation.
    1.11 + * The index value of an iterator is the incremented when the iterator advanced without removal.
    1.12 + * In other words, when the iterator is finished, \c index==size .
    1.13   *
    1.14   * @param allocator the allocator to use
    1.15   * @param buckets the initial number of buckets in this hash map