28 /** |
28 /** |
29 * \file hash_map.h |
29 * \file hash_map.h |
30 * \brief Hash map implementation. |
30 * \brief Hash map implementation. |
31 * \author Mike Becker |
31 * \author Mike Becker |
32 * \author Olaf Wintermann |
32 * \author Olaf Wintermann |
33 * \version 3.0 |
|
34 * \copyright 2-Clause BSD License |
33 * \copyright 2-Clause BSD License |
35 */ |
34 */ |
36 |
35 |
37 #ifndef UCX_HASH_MAP_H |
36 #ifndef UCX_HASH_MAP_H |
38 #define UCX_HASH_MAP_H |
37 #define UCX_HASH_MAP_H |
68 /** |
67 /** |
69 * Creates a new hash map with the specified number of buckets. |
68 * Creates a new hash map with the specified number of buckets. |
70 * |
69 * |
71 * If \p buckets is zero, an implementation defined default will be used. |
70 * If \p buckets is zero, an implementation defined default will be used. |
72 * |
71 * |
73 * If \p item_size is CX_STORE_POINTERS, the created map will be created as if |
72 * If \p elem_size is CX_STORE_POINTERS, the created map will be created as if |
74 * cxMapStorePointers() was called immediately after creation. |
73 * cxMapStorePointers() was called immediately after creation. |
75 * |
74 * |
76 * @note Iterators provided by this hash map implementation provide the remove operation. |
75 * @note Iterators provided by this hash map implementation provide the remove operation. |
77 * The index value of an iterator is incremented when the iterator advanced without removal. |
76 * The index value of an iterator is incremented when the iterator advanced without removal. |
78 * In other words, when the iterator is finished, \c index==size . |
77 * In other words, when the iterator is finished, \c index==size . |
90 ); |
89 ); |
91 |
90 |
92 /** |
91 /** |
93 * Creates a new hash map with a default number of buckets. |
92 * Creates a new hash map with a default number of buckets. |
94 * |
93 * |
95 * If \p item_size is CX_STORE_POINTERS, the created map will be created as if |
94 * If \p elem_size is CX_STORE_POINTERS, the created map will be created as if |
96 * cxMapStorePointers() was called immediately after creation. |
95 * cxMapStorePointers() was called immediately after creation. |
97 * |
96 * |
98 * @note Iterators provided by this hash map implementation provide the remove operation. |
97 * @note Iterators provided by this hash map implementation provide the remove operation. |
99 * The index value of an iterator is incremented when the iterator advanced without removal. |
98 * The index value of an iterator is incremented when the iterator advanced without removal. |
100 * In other words, when the iterator is finished, \c index==size . |
99 * In other words, when the iterator is finished, \c index==size . |