docs/Writerside/topics/hash_map.h.md

Fri, 14 Feb 2025 16:00:05 +0100

author
Mike Becker <universe@uap-core.de>
date
Fri, 14 Feb 2025 16:00:05 +0100
changeset 1208
6e78f45b17c3
parent 1190
a7b913d5d589
permissions
-rw-r--r--

add link summary text to strings and buffers topic

there should be more text to explain the what and why

relates to #451

# Hash Map

<warning>
Outdated Section - will be updated soon!
</warning>

UCX provides a basic hash map implementation with a configurable amount of buckets.
If you do not specify the number of buckets, a default of 16 buckets will be used.
You can always rehash the map with `cxMapRehash()` to change the number of buckets to something more efficient,
but you need to be careful, because when you use this function you are effectively locking into using this
specific hash map implementation, and you would need to remove all calls to this function when you want to
exchange the concrete map implementation with something different.

<!--
## Undocumented Symbols (TODO)
### cxHashMapCreate
### cxMapRehash
-->

<seealso>
<category ref="apidoc">
<a href="https://ucx.sourceforge.io/api/hash__map_8h.html">hash_map.h</a>
</category>
</seealso>

mercurial