Benchee v0.99.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
Run benchmark jobs defined by a map and optionally provide configuration options
Link to this section Functions
Link to this function
benchmark(suite, name, function) View Source
Link to this function
collect(suite) View Source
Link to this function
init() View Source
Link to this function
init(config) View Source
Link to this function
load(suite) View Source
Link to this function
relative_statistics(suite) 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
Link to this function
statistics(suite) View Source
Link to this function