Mach5

Mach5 is a minimalist C++11 benchmarking framework.

Usage

In fact, Mach5 is just a collection of .hpp and all you need to do to use it is include the Mach5.hpp file.

#include "Mach5.hpp"

#include <vector>
#include <algorithm>

BENCHMARK(DefaultCppSort, 100, 100, SINGLE) {
  std::vector<int> num = {0, 9, 8, 7, 6, 5, 4, 3, 2, 1};
  std::sort(num.begin(), num.end());
}

Pay attention to the parameter list of BENCHMARK macro. The first is the name of the benchmark, the second is the number of runs, the third is the number of iterations and the last one is the type.

But, the previous benchmark also measures how much time the creation of the vector num takes. So, the solution to this problem is create a fixture:

#include "Mach5.hpp"

#include <vector>
#include <algorithm>

class SortingNumbersWith : public ::mach5::BenchmarkFixture {
public:
  std::vector<int> num = {0, 9, 8, 7, 6, 5, 4, 3, 2, 1};
};

BENCHMARK_F(SortingNumbersWith, DefaultCppSort, 100, 100, SINGLE) {
  std::sort(num.begin(), num.end());
}

Now, it is used the BENCHMARK_F macro, that receives a Fixture class.

But... what is the type parameter?

Currently we have 2 different types:

SINGLE: It is a single benchmark
FOR(var_name, start, and): It enables you to test the same piece of code with different inputs, for example:

#include "Mach5.hpp"

#include <vector>
#include <algorithm>

class SortingNumbersWith : public ::mach5::BenchmarkFixture {
public:
  std::vector<std::vector<int>> nums = {
    {0, 9, 8, 7, 6, 5},
    {0, 9, 8, 7, 6, 5, 4},
    {0, 9, 8, 7, 6, 5, 4, 3},
    {0, 9, 8, 7, 6, 5, 4, 3, 2},
    {0, 9, 8, 7, 6, 5, 4, 3, 2, 1}
  };
};

BENCHMARK_F(SortingNumbersWith, DefaultCppSort, 100, 100, FOR(i, 0, 4)) {
  std::sort(nums[i].begin(), nums[i].end());
}

It will measure the time that std::sort takes to sort each vector of nums.

For a full example, check the sample folder.

Running

You need a main program to run your benchmarks:

#include "Mach5.hpp"

int main(int argc, char** argv) {
  RUN_ALL_BENCHMARKS(argc, argv);
  return 0;
}

After that, you can compile your program and run it:

$ ./benchmark

It will generate a json that represents the results.

You can pass some parameter to your benchmark program. For example:

$ ./benchmark list                                    # lists all enabled benchmarks
$ ./benchmark run SortingNumbersWith.DefaultCppSort   # runs a specific benchmark
$ ./benchmark help                                    # shows the help

igorbonadio/mach5

Mach5

Usage

Running

Copyright