package biocaml

  1. Overview
  2. Docs
package biocaml
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Biocaml_unix.AccuSource

A datastructure (based on Hashtbl) to accumulate values.

An Accu.t can be seen as a generalized histogram: samples are mapped to bins, and each bin has a corresponding value which may be its size or its contents depending on the need.

Generic API
Sourcetype ('sample, 'bin, 'increment, 'accu) t

General type for accumulators: 'samples are mapped to 'bins, and the 'accumulated value for a 'bin is updated with an 'increment

Sourceval create : ?n:int -> bin:('a -> 'b) -> zero:'d -> add:('c -> 'd -> 'd) -> unit -> ('a, 'b, 'c, 'd) t

create ~n ~zero ~bin ~add creates an accumulator, which maps instances to bins with bin, uses zero as a neutral element (that is the value associated to a bin before any value has been added to it) and updates the value of a bin with add. n is an estimation of the maximum number of bins.

Sourceval add : ('a, 'b, 'c, 'd) t -> 'a -> 'c -> unit

add accu x y updates the value in accu for the bin of x by an increment y

Sourceval stream : ('a, 'b, 'c, 'd) t -> ('b * 'd) Stream.t
Sourceval to_alist : ('a, 'b, 'c, 'd) t -> ('b * 'd) list
Sourceval get : ('a, 'b, 'c, 'd) t -> 'b -> 'd option

get accu x returns the value associated to b in accu.

Counters and histograms
Sourcemodule Counter : sig ... end
Sourceval counts : 'a Stream.t -> ('a * int) Stream.t
Sourceval product : ?filter:('a -> 'b -> bool) -> ('a -> 'b -> 'c) -> 'a list -> 'b list -> ('c * int) Stream.t

product filter f l1 l2 computes an histogram of values returned by f when it is applied for all combinations of elements in l1 and l2 such that the predicate filter is true

Relation
Sourcemodule Relation : sig ... end
Sourceval relation : ('a * 'b) Stream.t -> ('a * 'b list) Stream.t
Sourcemodule Bins : sig ... 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