Mercurial > hg > ucx / file diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/Writerside/topics/hash_map.h.md	Tue Feb 11 19:55:32 2025 +0100
@@ -0,0 +1,16 @@
+# 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