Skip to content

Commit

Permalink
Small documentation improvements.
Browse files Browse the repository at this point in the history
- Highlighted that libcuckoo is a header-only library.

- Suggest passing in an aligned allocator, since our spinlock is 64-byte
  aligned.
  • Loading branch information
manugoyal committed Dec 24, 2018
1 parent cd2aa7a commit f313804
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion libcuckoo/cuckoohash_map.hh
Original file line number Diff line number Diff line change
Expand Up @@ -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 <class Key, class T, class Hash = std::hash<Key>,
Expand Down

0 comments on commit f313804

Please sign in to comment.