Benchee

v0.12.0

Benchee v0.12.0 Benchee View Source

Top level module providing convenience access to needed functions as well as the very high level Benchee.run API.

Intended Elixir interface.

Link to this section Summary

Functions

benchmark(suite, name, function)
benchmark(suite, name, function, printer)
init()
init(config)
load(suite)
measure(suite)
measure(suite, printer)
run(jobs, config \\ [])

Run benchmark jobs defined by a map and optionally provide configuration options

statistics(suite)
system(suite)

Link to this section Functions

Link to this function benchmark(suite, name, function) View Source
Link to this function benchmark(suite, name, function, printer) View Source
Link to this function run(jobs, config \\ []) View Source

Run benchmark jobs defined by a map and optionally provide configuration options.

Runs the given benchmarks and prints the results on the console.

  • jobs - a map from descriptive benchmark job name to a function to be executed and benchmarked
  • configuration - configuration options to alter what Benchee does, see Benchee.Configuration.init/1 for documentation of the available options.

Examples 

Benchee.run(%{"My Benchmark" => fn -> 1 + 1 end,
              "My other benchmrk" => fn -> "1" ++ "1" end}, time: 3)
# Prints a summary of the benchmark to the console