package owl-base

  1. Overview
  2. Docs
package owl-base
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file owl_heavyhitters_sketch_sig.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# 1 "src/base/misc/owl_heavyhitters_sketch_sig.ml"
(* A sketch to get the approximate heavy hitters from a dataset.
 * A heavy-hitters sketch with threshold `k` will output all elements
 * that have been added to it at least `n/k` times (where `n` is the
 * total number of elements that have been added).
 * Approximation behavior: with probability at least 1 - delta, the data
 * structure outputs every element that appears at least `n/k` times, and
 * every element output appears at least `n/k - (epsilon * n)` times.
 * This implementation uses the Count-Min sketch implemented in
 * `owl-countmin-sketch.ml`.
 * Refer to http://dimacs.rutgers.edu/~graham/pubs/papers/cm-full.pdf
 * section 5.2 (page 12) for more details. *)


module type Sig = sig


  (** {6 Type definition} *)

  type 'a t
  (** The type of heavy-hitters sketches *)


  (** {6 Core functions} *)

  val init : k:float -> epsilon:float -> delta:float -> 'a t
  (**
`init k epsilon delta` initializes a sketch with threshold k, approximation
factor epsilon, and failure probability delta.
  *)

  val add : 'a t -> 'a -> unit
  (** `add h x` adds value `x` to sketch `h` in-place. *)

  val get : 'a t -> ('a * int) list
  (**
`get h` returns a list of all heavy-hitters in sketch `h`, as a
(value, frequency) pair, sorted in decreasing order of frequency.
  *)


end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct