docs/Writerside/topics/hash_map.h.md

Sat, 08 Feb 2025 20:38:05 +0100

author
Mike Becker <universe@uap-core.de>
date
Sat, 08 Feb 2025 20:38:05 +0100
branch
docs/3.1
changeset 1171
155bc3b0dcb3
parent 1146
151c057faf7c
permissions
-rw-r--r--

adds documentation for destructor functions and collections

also invented some new macros for the collection.h

relates to #451

# Hash Map

<warning>
Outdated - Rewrite!
</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

mercurial