Skip to content
This repository has been archived by the owner on Oct 11, 2022. It is now read-only.

Latest commit

 

History

History
47 lines (30 loc) · 2.1 KB

README.md

File metadata and controls

47 lines (30 loc) · 2.1 KB

Bencho

Bencho is a C++ benchmarking framework that will help you create and run your own benchmarks.

Current Status

The Bencho Framework can be used already, but it is still in development. Features can change or will be added and even some basic functionality could change in the next versions.

The following features are currently implemented:

  • Create benchmarks by using the AbstractBenchmark as template
  • Add Parameters easily
  • Measure different performance counters at the same time
  • Register different test series
  • Supports warm-up runs, calibration runs, chache clearing, parameter versions
  • All common aggregating functions included in an Aggregator
  • Save results in CSV formated files
  • Plot results directly via Gnuplot, Python matplotlib or R ggplot2

Building

Supported operating systems are Linux and Mac OS X, however the PAPI library wont work on the Apple operating systems.

To build the Bencho framework you will only need to execute

make

If not specified already, it will automatically ask you for your prefered Configuration of the options production mode, papi use and verbose build. If you want to change these settings later just execute

make config

The Bencho framework is now ready to use. On how to include this framework in your project best, please take a look at the Bencho Sample or at the documentation.

Documentation

The Bencho project provides a doxygen documentation of all classes that you find in the doxygen folder.

License

Bencho is licensed as open source after the OpenSource "Licence of the Hasso-Plattner Institute" declared in the LICENSE file of this project.

Question: Why does Bencho not use MIT or BSD or XX license. The reason for our approach comes with the German copyright law. Common BSD and MIT licenses are not necessarily compatible and thus can potentially lead to problems. To overcome this problem this project uses an specifically designed open source license to be compatible with German law. The most prominent difference is the exclusion of all liabilities which is not possible in Germany.