C++ benchmarking framework
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
debian Debian packetization. Jul 26, 2015
sample
script
src
tests
vendor/gtest Add clock implementation details to usage of hayai main. Jul 3, 2015
.gitignore
.travis.yml
AUTHORS.md Update AUTHORS. Mar 1, 2018
CMakeLists.txt
LICENSE.md Add license. Feb 7, 2012
README.md Cleanup and README update. Apr 25, 2018
Vagrantfile Python implementation of original tarball packing, Vagrantfile for te… Jul 27, 2015
hayai-config.cmake.in

README.md

hayai - the C++ benchmarking framework.

Build Status

hayai is a C++ framework for writing benchmarks for pieces of code along the lines of the normal approach for unit testing using frameworks such as googletest. For information on the origin of and how to use hayai, please read the introductory blog post until I have the time to write a proper README.

Installing hayai

hayai releases are made available for Mac OS X in Homebrew and for Ubuntu LTS releases in an Ubuntu PPA.

To install from Homebrew on Mac OS X:

$ brew install hayai

To install from the Ubuntu PPA:

$ apt-add-repository ppa:bruun/hayai
$ apt-get update
$ apt-get install libhayai-dev

Building hayai

hayai is fully header based, but to use the simple main function as described in the introducty blog post, the source code must be compiled to provide libhayai_main. Compiling the source code requires CMake to be present on the system:

$ cd hayai
$ cmake .
$ make

This will also build the sample available in the sample/ directory of the repository.

Developing hayai

hayai includes a (currently not at all very comprehensive) test suite for development. To use the test suite, pass a boolean true value as the BUILD_HAYAI_TESTS CMake variable:

$ cd hayai
$ cmake -DBUILD_HAYAI_TESTS=true .
$ make
$ make test