Building and Testing

Table of Contents

• Overview
• Dependencies
• Building
• Testing & Benchmarking
• Installation & Including in Other Projects

Overview

The BPHash project is configured and built using CMake (https://cmake.org).

Dependencies

The only dependencies are a C++ compiler (and standard libraries) capable of compiling C++11 (in particular, variadic templates) and CMake (v3.1.3 or above).

Building

The basic building steps are the traditional CMake steps:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/path/to/install ../ 
make
make test
make install

There are a few more helpful options:

BUILD_SHARED_LIBS can be set to True to build a shared library, rather than the default static library.

cmake -DCMAKE_BUILD_TYPE=Release \
      -DCMAKE_INSTALL_PREFIX=/path/to/install \
      -DBUILD_SHARED_LIBS=True \
      ../ 

CMAKE_CXX_FLAGS can be set to compiler-specific optimization flags. For example, to let g++ autodetect the best optimization for the current system, you can use

cmake -DCMAKE_BUILD_TYPE=Release \
      -DCMAKE_INSTALL_PREFIX=/path/to/install \
      -DCMAKE_CXX_FLAGS="-march=native" \
      ../ 

For the Intel compiler, the equivalent would be

cmake -DCMAKE_BUILD_TYPE=Release \
      -DCMAKE_INSTALL_PREFIX=/path/to/install \
      -DCMAKE_CXX_FLAGS="-xHOST" \
      ../ 

Testing & Benchmarking

Testing is done with make test. A quick benchmark can be run with the test_benchmark program. To do so, run the following command from the top-level build directory:

test/test_benchmark 1048576

The only argument is the size of the data set to benchmark with (in bytes).

Installation & Including in Other Projects

make install will install the headers and library. It will also install a CMake configuration file that can be used to include BPHash in other projects. This creates a CMake interface target that can be used with target_link_libraries. The top-level install path (what was passed to CMAKE_INSTALL_PREFIX) must be in your CMAKE_PREFIX_PATH (or be one of the system defaults).

# Make sure that the top-level install path is in the CMAKE_PREFIX_PATH
find_package(bphash)  

# Later, link to it. This will also pull in header paths
target_link_libraries(myproject bphash).

Note that your project must be built with (at least) C++11 support.