Packages

ddskerl

0.3.0
0.4.3 0.4.2 0.4.1 0.4.0 0.3.0 0.2.1 0.2.0 0.1.1 0.1.0

DDSketch in Erlang

HexDocs

Current section

Files

Jump to
Readme
9 Versions
0 Dependencies
Dependants
Files
Activity
ddskerl src ddskerl.erl
Raw

src/ddskerl.erl 

-module(ddskerl).

-if(?OTP_RELEASE >= 27).

-define(MODULEDOC(Str), -moduledoc(Str)).

-define(DOC(Str), -doc(Str)).

-else.

-define(MODULEDOC(Str), -compile([])).

-define(DOC(Str), -compile([])).

-endif.

?MODULEDOC("""

DDSketch behaviour.

""").



-if(?OTP_RELEASE >= 26).

?DOC("Options for the DDSketch.").

-type opts() :: #{atom() := dynamic()}.

-else.

?DOC("Options for the DDSketch.").

-type opts() :: #{atom() := _}.

-endif.



?DOC("DDSketch instance.").

-type ddsketch() ::

    ddskerl_std:ddsketch()

    | ddskerl_bound:ddsketch()

    | ddskerl_ets:ddsketch()

    | ddskerl_counters:ddsketch().



-export_type([opts/0, ddsketch/0]).



?DOC("Create a new DDSketch instance.").

-callback new(opts()) -> ddsketch().



?DOC("Get the total number of elements in the DDSketch.").

-callback total(ddsketch()) -> non_neg_integer().



?DOC("Get the sum number of elements in the DDSketch.").

-callback sum(ddsketch()) -> number().



?DOC("Insert a value into the DDSketch.").

-callback insert(ddsketch(), number()) -> ddsketch().



?DOC("Calculate the quantile of a DDSketch.").

-callback quantile(ddsketch(), float()) -> float() | undefined.



?DOC("Merge two DDSketch instances.").

-callback merge(ddsketch(), ddsketch()) -> ddsketch().