Takes scenarios and a given scaling_strategy, returns the best units for the given scaling strategy. The return value changes based on whether you want units for run time or memory usage.

The units can then be passed on to the appropriate format calls to format the output of arbitrary values with the right unit.

Examples

iex> statistics = %Benchee.Statistics{average: 1_000_000.0, ips: 1000.0}
...> 
...> scenario = %Benchee.Scenario{
...>   run_time_data: %Benchee.CollectionData{statistics: statistics},
...>   memory_usage_data: %Benchee.CollectionData{statistics: statistics},
...>   reductions_data: %Benchee.CollectionData{statistics: statistics}
...> }
...> 
...> Benchee.Conversion.units([scenario], :best)
%{
  ips: %Benchee.Conversion.Unit{
    label: "K",
    long: "Thousand",
    magnitude: 1000,
    name: :thousand
  },
  run_time: %Benchee.Conversion.Unit{
    label: "ms",
    long: "Milliseconds",
    magnitude: 1_000_000,
    name: :millisecond
  },
  memory: %Benchee.Conversion.Unit{
    label: "KB",
    long: "Kilobytes",
    magnitude: 1024,
    name: :kilobyte
  },
  reduction_count: %Benchee.Conversion.Unit{
    label: "M",
    long: "Million",
    magnitude: 1_000_000,
    name: :million
  }
}copy