package biocaml

You can search for identifiers within the package.

in-package search v0.2.0

The OCaml Bioinformatics Library

Install

Dune Dependency

biocaml.org Readme Edit opam file Versions (5)

Authors

Maintainers

B

biocaml@googlegroups.com

Sources

v0.11.0.tar.gz

md5=486aeb3e552dabae85839e2af30d6c52

sha512=4ed2df0b7cbd80bd6e29bd8fee9d2dacd9379ad0f4ff142bd8e16ade3f1507f6cc7cbe4c614943b8feb8fa4705935695cb458606b0da813dbf255b1e566a43cf

doc/biocaml.unix/Biocaml_unix/Interval_tree/index.html

Module `Biocaml_unix.Interval_tree`Source

Interval tree (data structure)

An interval tree is a collection of integer-bounded intervals labeled by a value.

For a brief description of the implementation, see the matching Wikipedia article

Sourcetype 'a t

Sourceexception Empty_tree

Accessors

Sourceval is_empty : 'a t -> bool

Sourceval cardinal : 'a t -> int

Sourceval intersects : 'a t -> low:int -> high:int -> bool

intersects a b t returns true if one interval in t intersects with the interval [a;b].

Constructors

Sourceval empty : 'a t

the empty tree

Sourceval add : 'a t -> low:int -> high:int -> data:'a -> 'a t

add lo hi v t adds the interval (lo, hi) labeled with value v to the contents of t. Note that in contrast to sets, identical intervals (even with identical labels) may be *repeated* in an interval tree. E.g., add 1 2 () (add 1 2 ()) contains 2 intervals.

Conversion

Sourceval elements : 'a t -> (int * int * 'a) list

Sourceval to_stream : 'a t -> (int * int * 'a) Stream.t

Sourceval to_backwards_stream : 'a t -> (int * int * 'a) Stream.t

Searching and filtering

Sourceval find_closest : int -> int -> 'a t -> int * int * 'a * int

find_closest lo hi t returns the interval in t which is at minimal distance of the interval [lo;hi]. The resulting tuple contains from left to right, left-end of the interval, right-end of the interval, value associated to the interval and distance to the interval given in argument. Overlapping intervals are at distance 0 of each other.

Raises Empty_tree if t is empty

Sourceval find_intersecting_elem : int -> int -> 'a t -> (int * int * 'a) Stream.t

find_intersecting_elem a b t is equivalent to Stream.filter ~f:(fun (x,y,_) -> intersects x y t) (stream t) but is more efficient.

Sourceval filter_overlapping : 'a t -> low:int -> high:int -> 'a t

Create an interval tree with the elements which overlap with [low, high].

Misc

Sourceval print : 'a t -> unit

Used for debugging purpose, should be removed in the long run

Sourceval check_integrity : 'a t -> unit