Benchee v1.0.1 Benchee.Conversion.Duration View Source

Unit scaling for duration converting from microseconds to minutes and others.

Only benchee plugins should use this code.

Link to this section Summary

Functions

The most basic unit in which measurements occur

Finds the best unit for a list of durations. By default, chooses the most common unit. In case of tie, chooses the largest of the most common units

convert(number_and_unit, desired_unit)

Converts a value for a specified %Unit or unit atom and converts it to the equivalent of another unit of measure

convert_value(arg, desired_unit)

Converts a value of the given unit into the desired unit, returning only the value not the unit

format(duration)

Formats a number as a string, with a unit label. To specify the unit, pass a tuple of {value, unit_atom} like {1_234, :second}

scale(duration)

Scales a duration value in nanoseconds into a larger unit if appropriate

scale(count, unit)

Scales a duration value in nanoseconds into a value in the specified unit

unit_for(unit)

Get a unit by its atom representation. If handed already a %Unit{} struct it just returns it

Link to this section Functions

base_unit() View Source

The most basic unit in which measurements occur.

Examples

iex> Benchee.Conversion.Duration.base_unit.name
:nanosecond

best(list, opts \\ [strategy: :best]) View Source

Finds the best unit for a list of durations. By default, chooses the most common unit. In case of tie, chooses the largest of the most common units.

Pass [strategy: :smallest] to always return the smallest unit in the list. Pass [strategy: :largest] to always return the largest unit in the list.

Examples

iex> Benchee.Conversion.Duration.best([23, 23_000, 34_000, 2_340_000]).name
:microsecond

iex> Benchee.Conversion.Duration.best([23, 23_000, 34_000_000, 2_340_000_000, 3_450_000_000]).name
:second

iex> Benchee.Conversion.Duration.best([23, 23_000, 34_000, 2_340_000], strategy: :smallest).name
:nanosecond

iex> Benchee.Conversion.Duration.best([23, 23_000, 34_000, 2_340_000_000], strategy: :largest).name
:second

convert(number_and_unit, desired_unit) View Source

Converts a value for a specified %Unit or unit atom and converts it to the equivalent of another unit of measure.

Examples

iex> {value, unit} = Benchee.Conversion.Duration.convert({90, :minute}, :hour) iex> value 1.5 iex> unit.name :hour

convert_value(arg, desired_unit) View Source

Converts a value of the given unit into the desired unit, returning only the value not the unit.

Examples

iex> Benchee.Conversion.Duration.convert_value({1.234, :second}, :microsecond)
1_234_000.0

iex> Benchee.Conversion.Duration.convert_value({1.234, :minute}, :microsecond)
7.404e7

iex> microseconds = Benchee.Conversion.Duration.convert_value({1.234, :minute}, :microsecond)
iex> {value, _} = Benchee.Conversion.Duration.convert({microseconds, :microsecond}, :minute)
iex> value
1.234

format(duration) View Source

Formats a number as a string, with a unit label. To specify the unit, pass a tuple of {value, unit_atom} like {1_234, :second}

Examples

iex> Benchee.Conversion.Duration.format(45_678.9)
"45.68 μs"

iex> Benchee.Conversion.Duration.format(45.6789)
"45.68 ns"

iex> Benchee.Conversion.Duration.format({45.6789, :millisecond})
"45.68 ms"

iex> Benchee.Conversion.Duration.format {45.6789,
...>   %Benchee.Conversion.Unit{
...>     long: "Milliseconds", magnitude: 1000, label: "ms"}
...>   }
"45.68 ms"

scale(duration) View Source

Scales a duration value in nanoseconds into a larger unit if appropriate

Examples

iex> {value, unit} = Benchee.Conversion.Duration.scale(1)
iex> value
1.0
iex> unit.name
:nanosecond

iex> {value, unit} = Benchee.Conversion.Duration.scale(1_234)
iex> value
1.234
iex> unit.name
:microsecond

iex> {value, unit} = Benchee.Conversion.Duration.scale(11_234_567_890_123)
iex> value
3.1207133028119443
iex> unit.name
:hour

scale(count, unit) View Source

Scales a duration value in nanoseconds into a value in the specified unit

Examples

iex> Benchee.Conversion.Duration.scale(12345, :nanosecond)
12345.0

iex> Benchee.Conversion.Duration.scale(12345, :microsecond)
12.345

iex> Benchee.Conversion.Duration.scale(12345, :minute)
2.0575e-7

unit_for(unit) View Source

Get a unit by its atom representation. If handed already a %Unit{} struct it just returns it.

Examples

iex> Benchee.Conversion.Duration.unit_for :hour
%Benchee.Conversion.Unit{
  name:      :hour,
  magnitude: 3_600_000_000_000,
  label:     "h",
  long:      "Hours"
}

iex> Benchee.Conversion.Duration.unit_for(%Benchee.Conversion.Unit{
...>   name:      :hour,
...>   magnitude: 3_600_000_000_000,
...>   label:     "h",
...>   long:      "Hours"
...>})
%Benchee.Conversion.Unit{
  name:      :hour,
  magnitude: 3_600_000_000_000,
  label:     "h",
  long:      "Hours"
}