Update README to explicitly state that functions must be invertible (fix #16)
authorJeff Preshing <filter-github@preshing.com>
Thu, 1 Dec 2016 16:34:18 +0000 (11:34 -0500)
committerGitHub <noreply@github.com>
Thu, 1 Dec 2016 16:34:18 +0000 (11:34 -0500)
README.md

index d603544..47295f3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -99,7 +99,7 @@ The `JUNCTION_USERCONFIG` variable works in a similar way. As an example, take a
 
 ## Rules and Behavior
 
-A Junction map is a lot like a big array of `std::atomic<>` variables, where the key is an index into the array. More precisely:
+Currently, Junction maps only work with integer or pointer-sized keys. The hash function must be invertible, so that every key has a unique hash. Otherwise, A Junction map is a lot like a big array of `std::atomic<>` variables, where the key is an index into the array. More precisely:
 
 * All of a Junction map's member functions, together with its `Mutator` member functions, are atomic with respect to each other, so you can safely call them from any thread without mutual exclusion.
 * If an `assign` [happens before](http://preshing.com/20130702/the-happens-before-relation/) a `get` with the same key, the `get` will return the value it inserted, except if another operation changes the value in between. Any [synchronizing operation](http://preshing.com/20130823/the-synchronizes-with-relation/) will establish this relationship.