package biocaml

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

A set of locations with an attached value on each of them

type 'a t
val to_stream : 'a t -> (location * 'a) Stdlib.Stream.t
val of_stream : (location * 'a) Stdlib.Stream.t -> 'a t
val intersects : 'a t -> location -> bool

intersects lmap loc returns true if loc has a non-empty intersection with one of the locations in lmap, and returns false otherwise

val closest : 'a t -> location -> (location * 'a * int) option

closest lmap loc returns the location in lmap that is the closest to loc, along with its annotation and the actual (minimal) distance. Returns None if there is no location in lmap that comes from the same chromosome than loc.

val intersecting_elems : 'a t -> location -> (location * 'a) Stdlib.Stream.t

intersecting_elems lmap loc returns a stream of elements in lmap whose location intersects with loc.

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