From f3138045810b2c2e9b59dbede296b4a5194af4f9 Mon Sep 17 00:00:00 2001 From: Manu Goyal Date: Sun, 23 Dec 2018 21:52:32 -0800 Subject: [PATCH] Small documentation improvements. - Highlighted that libcuckoo is a header-only library. - Suggest passing in an aligned allocator, since our spinlock is 64-byte aligned. --- README.md | 5 +++++ libcuckoo/cuckoohash_map.hh | 4 +++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9d1fdfc3..a646d25d 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,11 @@ support for atomic operations. Building the library requires CMake version >= Building ========== +libcuckoo is a header-only library, so in order to get going, just add the +`libcuckoo` subdirectory to your include path. These directions cover +installing the library to a particular location on your system, and also +building any the examples and tests included in the repository. + We suggest you build out of source, in a separate `build` directory: $ mkdir build diff --git a/libcuckoo/cuckoohash_map.hh b/libcuckoo/cuckoohash_map.hh index aeb341e5..80796863 100644 --- a/libcuckoo/cuckoohash_map.hh +++ b/libcuckoo/cuckoohash_map.hh @@ -34,7 +34,9 @@ * @tparam T type of values in the table * @tparam Hash type of hash functor * @tparam KeyEqual type of equality comparison functor - * @tparam Allocator type of allocator + * @tparam Allocator type of allocator. We suggest using an aligned allocator, + * because the table relies on types that are over-aligned to optimize + * concurrent cache usage. * @tparam SLOT_PER_BUCKET number of slots for each bucket in the table */ template ,