libcuckoo Documentation

libcuckoo is a header-only library. To use it, add the libcuckoo subdirectory to your project's include path.

Important: You must enable C++11 features in your compiler.

• For g++: use -std=c++11
• For clang++: use -std=c++11 -stdlib=libc++

Once the include path is configured, you can include the main header:

#include <libcuckoo/cuckoohash_map.hh>

To enable pretty-printing for cuckoohash maps within GDB, you must register the libcuckoo Python module in your GDB initialization file (~/.gdbinit).

1. Locate the absolute path to the libcuckoo-gdb-printers directory in your local repository.
2. Add a Python block to your ~/.gdbinit that inserts this path into sys.path and calls register_libcuckoo_printers(None).

import sys
sys.path.insert(0, '/path/to/libcuckoo/libcuckoo-gdb-printers')
from libcuckoo.printers import register_libcuckoo_printers
register_libcuckoo_printers (None)

To install the libcuckoo header files to a specific directory on your system, follow these steps using CMake:

1. Create and enter a build directory.
2. Run cmake with the -DCMAKE_INSTALL_PREFIX flag set to your desired path.
3. Build and install using make.

Example for installing to a local ../install directory:

mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=../install -DBUILD_EXAMPLES=1 -DBUILD_TESTS=1 ..
make all
make install

$ mkdir build
$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX=../install -DBUILD_EXAMPLES=1 -DBUILD_TESTS=1 ..
$ make all
$ make install

When building libcuckoo from the build directory, you can use the following CMake flags to control the build output:

Note: The universal benchmark allows testing various operations at arbitrary percentages with specific keys and values.