docs/Writerside/topics/hash_map.h.md@1f69336faa63 (annotated)
docs/Writerside/topics/hash_map.h.md
Tue, 11 Feb 2025 21:05:24 +0100
- author
- Olaf Wintermann <olaf.wintermann@gmail.com>
- date
- Tue, 11 Feb 2025 21:05:24 +0100
- changeset 1192
- 1f69336faa63
- parent 1190
- a7b913d5d589
- permissions
- -rw-r--r--
fix some typos - issue #548
|
1143
0559812df10c
assign proper names to the documentation topics
Mike Becker <universe@uap-core.de>
parents:
1142
diff
changeset
|
1 | # Hash Map |
| 1141 | 2 | |
|
1146
151c057faf7c
add marker to every incomplete page
Mike Becker <universe@uap-core.de>
parents:
1143
diff
changeset
|
3 | <warning> |
|
1190
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
4 | Outdated Section - will be updated soon! |
|
1146
151c057faf7c
add marker to every incomplete page
Mike Becker <universe@uap-core.de>
parents:
1143
diff
changeset
|
5 | </warning> |
|
151c057faf7c
add marker to every incomplete page
Mike Becker <universe@uap-core.de>
parents:
1143
diff
changeset
|
6 | |
| 1141 | 7 | UCX provides a basic hash map implementation with a configurable amount of buckets. |
| 8 | If you do not specify the number of buckets, a default of 16 buckets will be used. | |
| 9 | You can always rehash the map with `cxMapRehash()` to change the number of buckets to something more efficient, | |
| 10 | but you need to be careful, because when you use this function you are effectively locking into using this | |
| 11 | specific hash map implementation, and you would need to remove all calls to this function when you want to | |
| 12 | exchange the concrete map implementation with something different. | |
|
1142
9437530176bc
add symbols that need documentation as TODOs
Mike Becker <universe@uap-core.de>
parents:
1141
diff
changeset
|
13 | |
|
1190
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
14 | <!-- |
|
1142
9437530176bc
add symbols that need documentation as TODOs
Mike Becker <universe@uap-core.de>
parents:
1141
diff
changeset
|
15 | ## Undocumented Symbols (TODO) |
|
9437530176bc
add symbols that need documentation as TODOs
Mike Becker <universe@uap-core.de>
parents:
1141
diff
changeset
|
16 | ### cxHashMapCreate |
|
9437530176bc
add symbols that need documentation as TODOs
Mike Becker <universe@uap-core.de>
parents:
1141
diff
changeset
|
17 | ### cxMapRehash |
|
1190
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
18 | --> |
|
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
19 | |
|
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
20 | <seealso> |
|
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
21 | <category ref="apidoc"> |
|
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
22 | <a href="https://ucx.sourceforge.io/api/hash__map_8h.html">hash_map.h</a> |
|
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
23 | </category> |
|
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
24 | </seealso> |
|
a7b913d5d589
bring incomplete docs into a shape that can be released
Mike Becker <universe@uap-core.de>
parents:
1146
diff
changeset
|
25 |
