Code Monkey home page Code Monkey logo

zenbench's Introduction

zenbench - a minimal micro benchmark library

  • Header-only
  • Solely depends on a C++ 11 capable compiler

Build Status Build status License

Basic Usage

All benchmarks must be created and registered with the BENCHMARK(name) or the BENCHMARK_F(fixture,name) macro:

BENCHMARK(isPrimeSimple_101)
{
    while (ctxt.Running())
    {
        // put the code to benchmark here
        isPrimeSimple(101);
    }
}

These macros register a benchmark in a global list and obtain a zenbench::Context& ctxt parameter which iterates over the code to benchmark for a given amount of time.

To execute all benchmarks and print the results to stdout call zenbench::Benchmark::RunAllBenchmarks() (in main, e.g.).

int main(int argc, const char* argv[])
{
    zenbench::Benchmark::RunAllBenchmarks(argc, argv);   
}

or add ZENBENCH_MAIN to the global scope.

Fixture Classes

Fixture classes must derive from zenbench::Benchmark and may overwrite SetUpand TearDown

class Fixture : public zenbench::Benchmark
{
protected:
    virtual void SetUp() override
    {
        zenbench::Benchmark::SetUp();
    
        // put your initialization code here
    }

    virtual void TearDown() override
    {
        // put your tear down code here
    
        zenbench::Benchmark::TearDown();
    }
};

Benchmark Areas

For some Benchmarks it is necessary to setup new input data in every iteration. To exclude this setup from the benchmark, wrap the included parts in an additional scope and declare a BenchmarkArea object at the top of this scope.

while (ctxt.Running())
{
    // the copy of vec to workVector is not included in the Benchmark
    std::vector<float> workVector(size);
    std::copy(vec.begin(),vec.end(),workVector.begin());
    
    {
        zenbench::BenchmarkArea benchArea(ctxt);

        qsort(workVector.data(),size,sizeof(float),cmp_float);
    }
}

Benchmark Filter

Pass --zenbench_filter=*foo* to restrict the execution to benchmarks which names or fixtures contain foo.

Example Output

Output of the example

zenbench's People

Contributors

nafest avatar newproggie avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.