BuildBox.Benchmark

Contents

Description

Running benchmarks and collecting timings.

These functions expect the given Build commands to succeed, throwing an error if they don't. If you're not sure whether your command will succeed then test it first.

Synopsis

Documentation

module BuildBox.Benchmark.TimeAspect

module BuildBox.Benchmark.Pretty

module BuildBox.Benchmark.Compare

Types

data Benchmark Source

Describes a benchmark that we can run.

Constructors

Benchmark
Fields benchmarkName :: String A unique name for the benchmark. benchmarkSetup :: Build () Setup command to run before the main benchmark. benchmarkCommand :: Build (Maybe Timing) The benchmark command to run. Only the time taken to run this part is measured. benchmarkCheck :: Build () Check / cleanup command to run after the main benchmark.

data Timing Source

Holds elapsed, cpu, and system timings (in seconds).

Constructors

Timing
Fields timingElapsed :: Maybe Float timingCpu :: Maybe Float timingSys :: Maybe Float

Instances

Eq Timing
Read Timing
Show Timing

data BenchRunResult Source

The result of running a benchmark once.

Constructors

BenchRunResult
Fields benchRunResultElapsed :: Float The wall-clock time taken to run the benchmark (in seconds) benchRunResultKernel :: Maybe Timing Time that the benchmark itself reported was taken to run its kernel.

Instances

Read BenchRunResult
Show BenchRunResult
Pretty BenchRunResult

data BenchResult Source

The result of running a benchmark several times. We include the name of the original benchmark to it's easy to lookup the results.

Constructors

BenchResult
Fields benchResultName :: String benchResultRuns :: [BenchRunResult]

Instances

Read BenchResult
Show BenchResult
Pretty BenchResult

Benchmarking

runTimedCommand :: Build a -> Build (NominalDiffTime, a)Source

Run a command, returning its elapsed time.

runBenchmarkOnce :: Benchmark -> Build BenchRunResult Source

Run a benchmark once.

outRunBenchmarkOnce :: Benchmark -> Build BenchRunResult Source

Run a benchmark once, logging activity and timings to the console.

outRunBenchmarkAgainst Source

Arguments

:: Int	Number of iterations.
-> Maybe BenchResult	Optional previous result for comparison.
-> Benchmark	Benchmark to run.
-> Build BenchResult

Run a benchmark several times, logging activity to the console. Optionally print a comparison with a prior results.

outRunBenchmarkWith Source

Arguments

:: Int	Number of times to run each benchmark to get averages.
-> [BenchResult]	List of prior results.
-> Benchmark	The benchmark to run.
-> Build BenchResult

Run a benchmark serveral times, logging activity to the console. Also lookup prior results for comparison from the given list. If there is no matching entry then run the benchmark anyway, but don't print the comparison.