1. Overview
  2. Docs
package biotk
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Key : sig ... end
module Tree : sig ... end
include Core_kernel.Map_intf.S_plain with module Key := Key and module Tree := Tree
type +'a t = (t, 'a, Key.comparator_witness) Base.Map.t
val compare : ('a -> 'a -> Base.Int.t) -> 'a t -> 'a t -> Base.Int.t
include Core_kernel.Map_intf.Creators_and_accessors1 with type 'a t := 'a t with type 'a tree := 'a Tree.t with type key := t with type comparator_witness := Key.comparator_witness
include Core_kernel.Map_intf.Creators1 with type 'a t := 'a t with type 'a tree := 'a Tree.t with type key := t with type comparator_witness := Key.comparator_witness
include Base.Map.Creators1 with type 'a t := 'a t with type 'a tree := 'a Tree.t with type key := t with type comparator_witness := Key.comparator_witness
val empty : _ t
val singleton : t -> 'a -> 'a t
val of_alist : (t * 'a) list -> [ `Ok of 'a t | `Duplicate_key of t ]
val of_alist_or_error : (t * 'a) list -> 'a t Base.Or_error.t
val of_alist_exn : (t * 'a) list -> 'a t
val of_alist_multi : (t * 'a) list -> 'a list t
val of_alist_fold : (t * 'a) list -> init:'b -> f:('b -> 'a -> 'b) -> 'b t
val of_alist_reduce : (t * 'a) list -> f:('a -> 'a -> 'a) -> 'a t
val of_sorted_array : (t * 'a) array -> 'a t Base.Or_error.t
val of_sorted_array_unchecked : (t * 'a) array -> 'a t
val of_increasing_iterator_unchecked : len:int -> f:(int -> t * 'a) -> 'a t
val of_increasing_sequence : (t * 'a) Base.Sequence.t -> 'a t Base.Or_error.t
val of_sequence : (t * 'a) Base.Sequence.t -> [ `Ok of 'a t | `Duplicate_key of t ]
val of_sequence_or_error : (t * 'a) Base.Sequence.t -> 'a t Base.Or_error.t
val of_sequence_exn : (t * 'a) Base.Sequence.t -> 'a t
val of_sequence_multi : (t * 'a) Base.Sequence.t -> 'a list t
val of_sequence_fold : (t * 'a) Base.Sequence.t -> init:'b -> f:('b -> 'a -> 'b) -> 'b t
val of_sequence_reduce : (t * 'a) Base.Sequence.t -> f:('a -> 'a -> 'a) -> 'a t
val of_iteri : iteri:(f:(key:t -> data:'v -> unit) -> unit) -> [ `Ok of 'v t | `Duplicate_key of t ]
val of_tree : 'a Tree.t -> 'a t
val of_hashtbl_exn : (t, 'a) Core_kernel.Hashtbl.t -> 'a t
val of_key_set : (t, Key.comparator_witness) Base.Set.t -> f:(t -> 'v) -> 'v t
include Core_kernel.Map_intf.Accessors1 with type 'a t := 'a t with type 'a tree := 'a Tree.t with type key := t with type comparator_witness := Key.comparator_witness
include Base.Map.Accessors1 with type 'a t := 'a t with type 'a tree := 'a Tree.t with type key := t with type comparator_witness := Key.comparator_witness
val invariants : _ t -> bool
val is_empty : _ t -> bool
val length : _ t -> int
val add : 'a t -> key:t -> data:'a -> [ `Ok of 'a t | `Duplicate ]
val add_exn : 'a t -> key:t -> data:'a -> 'a t
val set : 'a t -> key:t -> data:'a -> 'a t
val add_multi : 'a list t -> key:t -> data:'a -> 'a list t
val remove_multi : 'a list t -> t -> 'a list t
val find_multi : 'a list t -> t -> 'a list
val change : 'a t -> t -> f:('a option -> 'a option) -> 'a t
val update : 'a t -> t -> f:('a option -> 'a) -> 'a t
val find : 'a t -> t -> 'a option
val find_exn : 'a t -> t -> 'a
val remove : 'a t -> t -> 'a t
val mem : _ t -> t -> bool
val iter_keys : _ t -> f:(t -> unit) -> unit
val iter : 'a t -> f:('a -> unit) -> unit
val iteri : 'a t -> f:(key:t -> data:'a -> unit) -> unit
val iteri_until : 'a t -> f:(key:t -> data:'a -> Base__.Map_intf.Continue_or_stop.t) -> Base__.Map_intf.Finished_or_unfinished.t
val iter2 : 'a t -> 'b t -> f:(key:t -> data:[ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] -> unit) -> unit
val map : 'a t -> f:('a -> 'b) -> 'b t
val mapi : 'a t -> f:(key:t -> data:'a -> 'b) -> 'b t
val fold : 'a t -> init:'b -> f:(key:t -> data:'a -> 'b -> 'b) -> 'b
val fold_right : 'a t -> init:'b -> f:(key:t -> data:'a -> 'b -> 'b) -> 'b
val fold2 : 'a t -> 'b t -> init:'c -> f: (key:t -> data:[ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] -> 'c -> 'c) -> 'c
val filter_keys : 'a t -> f:(t -> bool) -> 'a t
val filter : 'a t -> f:('a -> bool) -> 'a t
val filteri : 'a t -> f:(key:t -> data:'a -> bool) -> 'a t
val filter_map : 'a t -> f:('a -> 'b option) -> 'b t
val filter_mapi : 'a t -> f:(key:t -> data:'a -> 'b option) -> 'b t
val partition_mapi : 'a t -> f:(key:t -> data:'a -> ('b, 'c) Base.Either.t) -> 'b t * 'c t
val partition_map : 'a t -> f:('a -> ('b, 'c) Base.Either.t) -> 'b t * 'c t
val partitioni_tf : 'a t -> f:(key:t -> data:'a -> bool) -> 'a t * 'a t
val partition_tf : 'a t -> f:('a -> bool) -> 'a t * 'a t
val combine_errors : 'a Base.Or_error.t t -> 'a t Base.Or_error.t
val compare_direct : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val keys : _ t -> t list
val data : 'a t -> 'a list
val to_alist : ?key_order:[ `Increasing | `Decreasing ] -> 'a t -> (t * 'a) list
val validate : name:(t -> string) -> 'a Base.Validate.check -> 'a t Base.Validate.check
val validatei : name:(t -> string) -> (t * 'a) Base.Validate.check -> 'a t Base.Validate.check
val merge : 'a t -> 'b t -> f:(key:t -> [ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] -> 'c option) -> 'c t
val symmetric_diff : 'a t -> 'a t -> data_equal:('a -> 'a -> bool) -> (t * [ `Left of 'a | `Right of 'a | `Unequal of 'a * 'a ]) Base.Sequence.t
val fold_symmetric_diff : 'a t -> 'a t -> data_equal:('a -> 'a -> bool) -> init:'c -> f:('c -> (t * [ `Left of 'a | `Right of 'a | `Unequal of 'a * 'a ]) -> 'c) -> 'c
val min_elt : 'a t -> (t * 'a) option
val min_elt_exn : 'a t -> t * 'a
val max_elt : 'a t -> (t * 'a) option
val max_elt_exn : 'a t -> t * 'a
val for_all : 'a t -> f:('a -> bool) -> bool
val for_alli : 'a t -> f:(key:t -> data:'a -> bool) -> bool
val exists : 'a t -> f:('a -> bool) -> bool
val existsi : 'a t -> f:(key:t -> data:'a -> bool) -> bool
val count : 'a t -> f:('a -> bool) -> int
val counti : 'a t -> f:(key:t -> data:'a -> bool) -> int
val split : 'a t -> t -> 'a t * (t * 'a) option * 'a t
val append : lower_part:'a t -> upper_part:'a t -> [ `Ok of 'a t | `Overlapping_key_ranges ]
val subrange : 'a t -> lower_bound:t Base.Maybe_bound.t -> upper_bound:t Base.Maybe_bound.t -> 'a t
val fold_range_inclusive : 'a t -> min:t -> max:t -> init:'b -> f:(key:t -> data:'a -> 'b -> 'b) -> 'b
val range_to_alist : 'a t -> min:t -> max:t -> (t * 'a) list
val closest_key : 'a t -> [ `Greater_or_equal_to | `Greater_than | `Less_or_equal_to | `Less_than ] -> t -> (t * 'a) option
val nth : 'a t -> int -> (t * 'a) option
val nth_exn : 'a t -> int -> t * 'a
val rank : _ t -> t -> int option
val to_tree : 'a t -> 'a Tree.t
val to_sequence : ?order:[ `Increasing_key | `Decreasing_key ] -> ?keys_greater_or_equal_to:t -> ?keys_less_or_equal_to:t -> 'a t -> (t * 'a) Base.Sequence.t
val binary_search_segmented : 'a t -> segment_of:(key:t -> data:'a -> [ `Left | `Right ]) -> [ `Last_on_left | `First_on_right ] -> (t * 'a) option
val key_set : _ t -> (t, Key.comparator_witness) Base.Set.t
module Provide_of_sexp (Key : sig ... end) : sig ... end
module Provide_bin_io (Key : sig ... end) : Core_kernel.Map_intf.Binable.S1 with type 'a t := 'a t
module Provide_hash (Key : Base.Hasher.S with type t := t) : sig ... end
include Core_kernel.Sexpable.S1 with type 'a t := 'a t
val t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t