package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Map.Accessors_generic with type ('a, 'b, 'c) options := ('a, 'b, 'c) Options.t with type ('a, 'b, 'c) t := ('a, 'b, 'c) T.t with type ('a, 'b, 'c) tree := ('a, 'b, 'c) Tree.t with type 'a key := 'a Key.t with type 'a cmp := 'a Cmp.t
val invariants : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> bool) Options.t
val is_empty : (_, _, _) T.t -> bool
val length : (_, _, _) T.t -> int
val add : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> key:'k Key.t -> data:'v -> [ `Ok of ('k, 'v, 'cmp) T.t | `Duplicate ]) Options.t
val add_exn : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> key:'k Key.t -> data:'v -> ('k, 'v, 'cmp) T.t) Options.t
val set : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> key:'k Key.t -> data:'v -> ('k, 'v, 'cmp) T.t) Options.t
val add_multi : ('k, 'cmp, ('k, 'v list, 'cmp) T.t -> key:'k Key.t -> data:'v -> ('k, 'v list, 'cmp) T.t) Options.t
val remove_multi : ('k, 'cmp, ('k, 'v list, 'cmp) T.t -> 'k Key.t -> ('k, 'v list, 'cmp) T.t) Options.t
val find_multi : ('k, 'cmp, ('k, 'v list, 'cmp) T.t -> 'k Key.t -> 'v list) Options.t
val change : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> 'k Key.t -> f:('v option -> 'v option) -> ('k, 'v, 'cmp) T.t) Options.t
val update : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> 'k Key.t -> f:('v option -> 'v) -> ('k, 'v, 'cmp) T.t) Options.t
val find : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> 'k Key.t -> 'v option) Options.t
val find_exn : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> 'k Key.t -> 'v) Options.t
val remove : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> 'k Key.t -> ('k, 'v, 'cmp) T.t) Options.t
val mem : ('k, 'cmp, ('k, _, 'cmp) T.t -> 'k Key.t -> bool) Options.t
val iter_keys : ('k, _, _) T.t -> f:('k Key.t -> unit) -> unit
val iter : (_, 'v, _) T.t -> f:('v -> unit) -> unit
val iteri : ('k, 'v, _) T.t -> f:(key:'k Key.t -> data:'v -> unit) -> unit
val iteri_until : ('k, 'v, _) T.t -> f:(key:'k Key.t -> data:'v -> Map.Continue_or_stop.t) -> Map.Finished_or_unfinished.t
val iter2 : ('k, 'cmp, ('k, 'v1, 'cmp) T.t -> ('k, 'v2, 'cmp) T.t -> f: (key:'k Key.t -> data:[ `Left of 'v1 | `Right of 'v2 | `Both of 'v1 * 'v2 ] -> unit) -> unit) Options.t
val map : ('k, 'v1, 'cmp) T.t -> f:('v1 -> 'v2) -> ('k, 'v2, 'cmp) T.t
val mapi : ('k, 'v1, 'cmp) T.t -> f:(key:'k Key.t -> data:'v1 -> 'v2) -> ('k, 'v2, 'cmp) T.t
val fold : ('k, 'v, _) T.t -> init:'a -> f:(key:'k Key.t -> data:'v -> 'a -> 'a) -> 'a
val fold_until : ('k, 'v, _) T.t -> init:'a -> f: (key:'k Key.t -> data:'v -> 'a -> ('a, 'final) Base.Container.Continue_or_stop.t) -> finish:('a -> 'final) -> 'final
val fold_right : ('k, 'v, _) T.t -> init:'a -> f:(key:'k Key.t -> data:'v -> 'a -> 'a) -> 'a
val fold2 : ('k, 'cmp, ('k, 'v1, 'cmp) T.t -> ('k, 'v2, 'cmp) T.t -> init:'a -> f: (key:'k Key.t -> data:[ `Left of 'v1 | `Right of 'v2 | `Both of 'v1 * 'v2 ] -> 'a -> 'a) -> 'a) Options.t
val filter_keys : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> f:('k Key.t -> bool) -> ('k, 'v, 'cmp) T.t) Options.t
val filter : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> f:('v -> bool) -> ('k, 'v, 'cmp) T.t) Options.t
val filteri : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> f:(key:'k Key.t -> data:'v -> bool) -> ('k, 'v, 'cmp) T.t) Options.t
val filter_map : ('k, 'cmp, ('k, 'v1, 'cmp) T.t -> f:('v1 -> 'v2 option) -> ('k, 'v2, 'cmp) T.t) Options.t
val filter_mapi : ('k, 'cmp, ('k, 'v1, 'cmp) T.t -> f:(key:'k Key.t -> data:'v1 -> 'v2 option) -> ('k, 'v2, 'cmp) T.t) Options.t
val partition_mapi : ('k, 'cmp, ('k, 'v1, 'cmp) T.t -> f:(key:'k Key.t -> data:'v1 -> ('v2, 'v3) Base.Either.t) -> ('k, 'v2, 'cmp) T.t * ('k, 'v3, 'cmp) T.t) Options.t
val partition_map : ('k, 'cmp, ('k, 'v1, 'cmp) T.t -> f:('v1 -> ('v2, 'v3) Base.Either.t) -> ('k, 'v2, 'cmp) T.t * ('k, 'v3, 'cmp) T.t) Options.t
val partitioni_tf : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> f:(key:'k Key.t -> data:'v -> bool) -> ('k, 'v, 'cmp) T.t * ('k, 'v, 'cmp) T.t) Options.t
val partition_tf : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> f:('v -> bool) -> ('k, 'v, 'cmp) T.t * ('k, 'v, 'cmp) T.t) Options.t
val combine_errors : ('k, 'cmp, ('k, 'v Base.Or_error.t, 'cmp) T.t -> ('k, 'v, 'cmp) T.t Base.Or_error.t) Options.t
val compare_direct : ('k, 'cmp, ('v -> 'v -> int) -> ('k, 'v, 'cmp) T.t -> ('k, 'v, 'cmp) T.t -> int) Options.t
val equal : ('k, 'cmp, ('v -> 'v -> bool) -> ('k, 'v, 'cmp) T.t -> ('k, 'v, 'cmp) T.t -> bool) Options.t
val keys : ('k, _, _) T.t -> 'k Key.t list
val data : (_, 'v, _) T.t -> 'v list
val to_alist : ?key_order:[ `Increasing | `Decreasing ] -> ('k, 'v, _) T.t -> ('k Key.t * 'v) list
val merge : ('k, 'cmp, ('k, 'v1, 'cmp) T.t -> ('k, 'v2, 'cmp) T.t -> f: (key:'k Key.t -> [ `Left of 'v1 | `Right of 'v2 | `Both of 'v1 * 'v2 ] -> 'v3 option) -> ('k, 'v3, 'cmp) T.t) Options.t
val merge_skewed : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> ('k, 'v, 'cmp) T.t -> combine:(key:'k Key.t -> 'v -> 'v -> 'v) -> ('k, 'v, 'cmp) T.t) Options.t
val symmetric_diff : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> ('k, 'v, 'cmp) T.t -> data_equal:('v -> 'v -> bool) -> ('k Key.t * [ `Left of 'v | `Right of 'v | `Unequal of 'v * 'v ]) Base.Sequence.t) Options.t
val fold_symmetric_diff : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> ('k, 'v, 'cmp) T.t -> data_equal:('v -> 'v -> bool) -> init:'a -> f: ('a -> ('k Key.t * [ `Left of 'v | `Right of 'v | `Unequal of 'v * 'v ]) -> 'a) -> 'a) Options.t
val min_elt : ('k, 'v, _) T.t -> ('k Key.t * 'v) option
val min_elt_exn : ('k, 'v, _) T.t -> 'k Key.t * 'v
val max_elt : ('k, 'v, _) T.t -> ('k Key.t * 'v) option
val max_elt_exn : ('k, 'v, _) T.t -> 'k Key.t * 'v
val for_all : ('k, 'v, _) T.t -> f:('v -> bool) -> bool
val for_alli : ('k, 'v, _) T.t -> f:(key:'k Key.t -> data:'v -> bool) -> bool
val exists : ('k, 'v, _) T.t -> f:('v -> bool) -> bool
val existsi : ('k, 'v, _) T.t -> f:(key:'k Key.t -> data:'v -> bool) -> bool
val count : ('k, 'v, _) T.t -> f:('v -> bool) -> int
val counti : ('k, 'v, _) T.t -> f:(key:'k Key.t -> data:'v -> bool) -> int
val split : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> 'k Key.t -> ('k, 'v, 'cmp) T.t * ('k Key.t * 'v) option * ('k, 'v, 'cmp) T.t) Options.t
val append : ('k, 'cmp, lower_part:('k, 'v, 'cmp) T.t -> upper_part:('k, 'v, 'cmp) T.t -> [ `Ok of ('k, 'v, 'cmp) T.t | `Overlapping_key_ranges ]) Options.t
val subrange : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> lower_bound:'k Key.t Base.Maybe_bound.t -> upper_bound:'k Key.t Base.Maybe_bound.t -> ('k, 'v, 'cmp) T.t) Options.t
val fold_range_inclusive : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> min:'k Key.t -> max:'k Key.t -> init:'a -> f:(key:'k Key.t -> data:'v -> 'a -> 'a) -> 'a) Options.t
val range_to_alist : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> min:'k Key.t -> max:'k Key.t -> ('k Key.t * 'v) list) Options.t
val closest_key : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> [ `Greater_or_equal_to | `Greater_than | `Less_or_equal_to | `Less_than ] -> 'k Key.t -> ('k Key.t * 'v) option) Options.t
val nth : ('k, 'v, 'cmp) T.t -> int -> ('k Key.t * 'v) option
val nth_exn : ('k, 'v, 'cmp) T.t -> int -> 'k Key.t * 'v
val rank : ('k, 'cmp, ('k, _, 'cmp) T.t -> 'k Key.t -> int option) Options.t
val to_tree : ('k, 'v, 'cmp) T.t -> ('k Key.t, 'v, 'cmp) Tree.t
val to_sequence : ('k, 'cmp, ?order:[ `Increasing_key | `Decreasing_key ] -> ?keys_greater_or_equal_to:'k Key.t -> ?keys_less_or_equal_to:'k Key.t -> ('k, 'v, 'cmp) T.t -> ('k Key.t * 'v) Base.Sequence.t) Options.t
val binary_search_segmented : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> segment_of:(key:'k Key.t -> data:'v -> [ `Left | `Right ]) -> Base.Binary_searchable.Which_target_by_segment.t -> ('k Key.t * 'v) option) Options.t
val binary_search_subrange : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> compare:(key:'k Key.t -> data:'v -> 'bound -> int) -> lower_bound:'bound Base.Maybe_bound.t -> upper_bound:'bound Base.Maybe_bound.t -> ('k, 'v, 'cmp) T.t) Options.t
val key_set : ('k, 'cmp, ('k, _, 'cmp) T.t -> ('k Key.t, 'cmp Cmp.t) Base.Set.t) Options.t
val validate : name:('k Key.t -> Base.String.t) -> 'v Validate.check -> ('k, 'v, _) T.t Validate.check
val validatei : name:('k Key.t -> Base.String.t) -> ('k Key.t * 'v) Validate.check -> ('k, 'v, _) T.t Validate.check
val quickcheck_observer : 'k Key.t Quickcheck.Observer.t -> 'v Quickcheck.Observer.t -> ('k, 'v, 'cmp) T.t Quickcheck.Observer.t
val quickcheck_shrinker : ('k, 'cmp, 'k Key.t Quickcheck.Shrinker.t -> 'v Quickcheck.Shrinker.t -> ('k, 'v, 'cmp) T.t Quickcheck.Shrinker.t) Options.t