Benchee v0.11.0 Benchee.Benchmark.Scenario View Source

A Scenario in Benchee is a particular case of a whole benchmarking suite. That is the combination of a particular function to benchmark (job_name and function) in combination with a specific input (input_name and input).

It then gathers all data measured for this particular combination during Benchee.Benchmark.measure/3 (run_times and memory_usages), which are then used later in the process by Benchee.Statistics to compute the relevant statistics (run_time_statistics and memory_usage_statistics).

Link to this section Summary

Link to this section Types

Link to this type t() View Source
t() :: %Benchee.Benchmark.Scenario{after_each: (... -> any()) | nil, after_scenario: (... -> any()) | nil, before_each: (... -> any()) | nil, before_scenario: (... -> any()) | nil, function: (... -> any()), input: any() | nil, input_name: binary() | nil, job_name: binary(), memory_usage_statistics: Benchee.Statistics.t() | nil, memory_usages: [non_neg_integer()], run_time_statistics: Benchee.Statistics.t() | nil, run_times: [float()]}