JPSoft.Benchmarker 1.0.0

JPSoft.Benchmarker

A small benchmarking API for .NET Standard

Introduction

JPSoft.Benchmark is based on a previous project called JPSoft.Profiling.

The goal, has it is for JPSoft.Profiling, is to provide a safe environment to perform benchmarking against a block of code, or several.

Getting Started

Simply do:

    var recipe = Benchmarker.Build(
        (builder) => builder.For("Recipe", // <= recipe name 
            () =>
            {
                var a = 1;
                var b = 2 + a; // <= code to benchmark
            })
        .With((a) => a
            .IterateFor(10000000) // <= settings;
            .TimeoutOn(1000)));

        var benchmark = Benchmarker.Run(recipe); // <=  Execute

Or simpler:

    var benchmark = Benchmarker.BuildAndRun(
        (builder) => builder.For("Recipe", () =>
            {
                var a = 1;
                var b = 2 + a;
            })
        .With((a) => a
            .IterateFor(10000000)
            .TimeoutOn(1000)));

Reuse settings:

    Action<IRecipeSettingsBuilder> globalSettings = b => b.IterateFor(1000);

    var benchmark1 = Benchmarker.BuildAndRun(
    (builder) => builder.For("Recipe1", () => 
        {/*Fancy recipe code*/}).With(globalSettings));

    var benchmark2 = Benchmarker.BuildAndRun(
    (builder) => builder.For("Recipe2", () => 
        {/*Fancy recipe code*/}).With(globalSettings));

Or use defaults:

    With())); 

Set the defaults:

    BenchmarkerDefaults.OverrideDefaultIterations(1000000);
    BenchmarkerDefaults.OverrideDefaultTimeout(1000);
    BenchmarkerDefaults.OverrideDefaultReport((b) => $"Recipe Name: {b.Recipe.Name}\nIsSuccess: {b.IsSuccess}\n");

And then consult the generated benchmark;

    benchmark.IsSuccess;
    benchmark.Milliseconds;
    benchmark.IterationsPerMillisecond;
    benchmark.MillisecondsPerIteration;
    benchmark.TaskRunStatus;
    benchmark.Exception;

Or use the reporting tool:

    System.Console.WriteLine(benchmark.GetReport());

Prerequisites

Must be compatible with netstandard2.0

NuGet Packages

Install-Package JPSoft.Benchmarker

dotnet add package JPSoft.Benchmarker --version 1.0.0

Motivation

Premature optimization maybe the root of all evil but sometimes you just want to test the hell out of a code snippet or maybe an entire method.

I got tired of writing for loops & stopWatch.Start() to test my micro optimizations and this was a fun project to do.

Hope you guys enjoy it.

Author

• João Palma Sequeira - JMPSequeira

License

This project is licensed under the MIT License - see the LICENSE.txt file for details