Benchee v1.0.1 Benchee.RelativeStatistics View Source

Statistics that are relative from one scenario to another.

Such as how much slower/faster something is or what the absolute difference is in the measured values. Is its own step because it has to be executed after scenarios have been loaded via Benchee.ScenarioLoader to include them in the calculation, while Benchee.Statistics has to happen before they are loaded to avoid recalculating their statistics.

Link to this section Summary

Functions

Calculate the statistics of scenarios relative to each other and sorts scenarios

Link to this section Functions

Link to this function

relative_statistics(suite) View Source
relative_statistics(Benchee.Suite.t()) :: Benchee.Suite.t()

Calculate the statistics of scenarios relative to each other and sorts scenarios.

Such as relative_more, relative_less and absolute_difference, see Benchee.Statistics.t/0 for more.

The sorting of scenarios is important so that they always have the same order in all formatters. Scenarios are sorted first by run time average, then by memory average.