Benchee v0.8.0 Benchee.Suite

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_times key needs to be filled with the results from Benchee.Benchmark.measure/1.

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

Summary

Types

benchmark_function()

key()

optional_map()

t()

Types

benchmark_function()

benchmark_function() :: (() -> any) | (any -> any)

key()

key() :: atom | String.t

optional_map()

optional_map() :: map | nil

t()

t() :: %Benchee.Suite{configuration: Benchee.Configuration.t | nil, jobs: %{optional(key) => benchmark_function}, run_times: %{optional(key) => %{optional(key) => [integer]}} | nil, statistics: %{optional(key) => %{optional(key) => Benchee.Statistics.t}} | nil, system: optional_map}