jose_jwa_bench (JOSE v1.11.12)

View Source

Summary

Types

arguments/0
arguments/1
arguments_function/1
arguments_list/1
metric/0
stats/0

Functions

bench(Function, Arguments)
bench(Function, Arguments, N)
compare(Groups, Arguments, N)

Types

arguments/0

-type arguments() :: arguments(term()).

arguments/1

-type arguments(Type) :: arguments_function(Type) | arguments_list(Type).

arguments_function/1

-type arguments_function(Type) :: fun(() -> arguments_list(Type)).

arguments_list/1

-type arguments_list(Type) :: [Type].

metric/0

-type metric() ::
          #{acc := non_neg_integer(),
            avg := float(),
            min := non_neg_integer(),
            max := non_neg_integer()}.

stats/0

-type stats() :: #{reds := metric(), time := metric()}.

Functions

bench(Function, Arguments)

-spec bench(function(), arguments()) -> stats().

bench(Function, Arguments, N)

-spec bench(function(), arguments(), non_neg_integer()) -> stats().

compare(Groups, Arguments, N)

-spec compare([{atom(), function()}], arguments(), non_neg_integer()) -> [{atom(), stats()}].