docs/Writerside/topics/hash_map.h.md

Thu, 23 Jan 2025 20:19:03 +0100

author
Mike Becker <universe@uap-core.de>
date
Thu, 23 Jan 2025 20:19:03 +0100
branch
docs/3.1
changeset 1142
9437530176bc
parent 1141
a06a2d27c043
child 1143
0559812df10c
permissions
-rw-r--r--

add symbols that need documentation as TODOs

relates to #451

1141
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1 # hash_map.h
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents:
diff changeset
3 UCX provides a basic hash map implementation with a configurable amount of buckets.
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents:
diff changeset
4 If you do not specify the number of buckets, a default of 16 buckets will be used.
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents:
diff changeset
5 You can always rehash the map with `cxMapRehash()` to change the number of buckets to something more efficient,
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents:
diff changeset
6 but you need to be careful, because when you use this function you are effectively locking into using this
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents:
diff changeset
7 specific hash map implementation, and you would need to remove all calls to this function when you want to
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents:
diff changeset
8 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
9
9437530176bc add symbols that need documentation as TODOs
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
10 ## Undocumented Symbols (TODO)
9437530176bc add symbols that need documentation as TODOs
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
11 ### cxHashMapCreate
9437530176bc add symbols that need documentation as TODOs
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
12 ### cxMapRehash

mercurial