View Source Benchee.Suite (Benchee v1.3.1)

Main Benchee data structure that aggregates the results from every step.

Different layers of the benchmarking rely on different data being present here. For instance for Benchee.Statistics.statistics/1 to work the run_time_data key of each scenario needs to be filled with the samples collected by Benchee.Benchmark.collect/1.

Formatters can then use the data to display all of the results and the configuration.

Summary

Types

key()

Valid key for either input or benchmarking job names.

t()

The main suite consisting of the configuration data, information about the system and most importantly a list of Benchee.Scenario.t/0.

Types

Link to this type

key()

View Source 
@type key() :: String.t() | atom()

Valid key for either input or benchmarking job names.

Link to this type

t()

View Source 
@type t() :: %Benchee.Suite{
  configuration: Benchee.Configuration.t() | nil,
  scenarios: [] | [Benchee.Scenario.t()],
  system: Benchee.System.t() | nil
}

The main suite consisting of the configuration data, information about the system and most importantly a list of Benchee.Scenario.t/0.