View Source quantile_estimator (quantile_estimator v1.0.2)

Based on: Cormode et. al.: "Effective Computation of Biased Quantiles over Data Streams"

Summary

Types

data_sample/0
invariant/0

Functions

compress(Quantile_estimator)
f_biased(Epsilon)
f_targeted(Targets)
insert(V, Quantile_estimator)
inserts_since_compression(Quantile_estimator)
new(Invariant)
quantile(Phi, Quantile_estimator)

Types

data_sample/0

-type data_sample() :: number().

invariant/0

-type invariant() :: fun((number(), number()) -> number()).

Functions

compress(Quantile_estimator)

-spec compress(#quantile_estimator{samples_count :: non_neg_integer(),
                                   data_count :: non_neg_integer(),
                                   inserts_since_compression :: non_neg_integer(),
                                   data ::
                                       [#group{v :: number(),
                                               g :: number(),
                                               delta :: number(),
                                               rank :: number()}],
                                   invariant :: quantile_estimator:invariant()}) ->
                  #quantile_estimator{samples_count :: non_neg_integer(),
                                      data_count :: non_neg_integer(),
                                      inserts_since_compression :: non_neg_integer(),
                                      data ::
                                          [#group{v :: number(),
                                                  g :: number(),
                                                  delta :: number(),
                                                  rank :: number()}],
                                      invariant :: quantile_estimator:invariant()}.

f_biased(Epsilon)

-spec f_biased(number()) -> invariant().

f_targeted(Targets)

-spec f_targeted([{number(), number()}]) -> invariant().

insert(V, Quantile_estimator)

-spec insert(data_sample(),
             #quantile_estimator{samples_count :: non_neg_integer(),
                                 data_count :: non_neg_integer(),
                                 inserts_since_compression :: non_neg_integer(),
                                 data ::
                                     [#group{v :: number(),
                                             g :: number(),
                                             delta :: number(),
                                             rank :: number()}],
                                 invariant :: quantile_estimator:invariant()}) ->
                #quantile_estimator{samples_count :: non_neg_integer(),
                                    data_count :: non_neg_integer(),
                                    inserts_since_compression :: non_neg_integer(),
                                    data ::
                                        [#group{v :: number(),
                                                g :: number(),
                                                delta :: number(),
                                                rank :: number()}],
                                    invariant :: quantile_estimator:invariant()}.

inserts_since_compression(Quantile_estimator)

-spec inserts_since_compression(#quantile_estimator{samples_count :: non_neg_integer(),
                                                    data_count :: non_neg_integer(),
                                                    inserts_since_compression :: non_neg_integer(),
                                                    data ::
                                                        [#group{v :: number(),
                                                                g :: number(),
                                                                delta :: number(),
                                                                rank :: number()}],
                                                    invariant :: quantile_estimator:invariant()}) ->
                                   non_neg_integer().

new(Invariant)

-spec new(invariant()) ->
             #quantile_estimator{samples_count :: non_neg_integer(),
                                 data_count :: non_neg_integer(),
                                 inserts_since_compression :: non_neg_integer(),
                                 data ::
                                     [#group{v :: number(),
                                             g :: number(),
                                             delta :: number(),
                                             rank :: number()}],
                                 invariant :: quantile_estimator:invariant()}.

quantile(Phi, Quantile_estimator)

-spec quantile(number(),
               #quantile_estimator{samples_count :: non_neg_integer(),
                                   data_count :: non_neg_integer(),
                                   inserts_since_compression :: non_neg_integer(),
                                   data ::
                                       [#group{v :: number(),
                                               g :: number(),
                                               delta :: number(),
                                               rank :: number()}],
                                   invariant :: quantile_estimator:invariant()}) ->
                  number().