Benchee v0.8.0 API Reference
Modules
Top level module providing convenience access to needed functions as well
as the very high level Benchee.run API
Functionality related to the actual benchmarking. Meaning running the
given functions and recording their individual run times in a list.
Exposes benchmark function
Functions to handle the configuration of Benchee, exposes init function
Unit scaling for counts, such that 1000000 can be converted to 1 Million
Helps with formattiong for the standard deviation ratio converting it into the more common percent form
Unit scaling for duration converting from microseconds to minutes and others
Functions for formatting values and their unit labels. Different domains handle this task differently, for example durations and counts
Functions for scaling values to other units. Different domains handle this task differently, for example durations and counts
A representation of the different units used in Benchee.Conversion.Duration
and Benchee.Conversion.Count. A unit is characterized by
Formatter to transform the statistics output into a structure suitable for
output through IO.puts on the console
Statistics related functionality that is meant to take the raw benchmark run times and then compute statistics like the average and the standard devaition
Main benchee data structure that aggregates the results from every step
Provides information about the system the benchmarks are run on
Methods to create files used in plugins