base
  1. Overview
  2. Docs
package base
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a t
type 'a tree
type key
type comparator_witness
val empty : _ t
val singleton : key -> 'a -> 'a t
val map_keys : 'v t -> f:(key -> key) -> [ `Ok of 'v t | `Duplicate_key of key ]
val map_keys_exn : 'v t -> f:(key -> key) -> 'v t
val of_alist : (key * 'a) list -> [ `Ok of 'a t | `Duplicate_key of key ]
val of_alist_or_error : (key * 'a) list -> 'a t Or_error.t
val of_alist_exn : (key * 'a) list -> 'a t
val of_alist_multi : (key * 'a) list -> 'a list t
val of_alist_fold : (key * 'a) list -> init:'b -> f:('b -> 'a -> 'b) -> 'b t
val of_alist_reduce : (key * 'a) list -> f:('a -> 'a -> 'a) -> 'a t
val of_sorted_array : (key * 'a) array -> 'a t Or_error.t
val of_sorted_array_unchecked : (key * 'a) array -> 'a t
val of_increasing_iterator_unchecked : len:int -> f:(int -> key * 'a) -> 'a t
val of_increasing_sequence : (key * 'a) Sequence.t -> 'a t Or_error.t
val of_sequence : (key * 'a) Sequence.t -> [ `Ok of 'a t | `Duplicate_key of key ]
val of_sequence_or_error : (key * 'a) Sequence.t -> 'a t Or_error.t
val of_sequence_exn : (key * 'a) Sequence.t -> 'a t
val of_sequence_multi : (key * 'a) Sequence.t -> 'a list t
val of_sequence_fold : (key * 'a) Sequence.t -> init:'b -> f:('b -> 'a -> 'b) -> 'b t
val of_sequence_reduce : (key * 'a) Sequence.t -> f:('a -> 'a -> 'a) -> 'a t
val of_iteri : iteri:(f:(key:key -> data:'v -> unit) -> unit) -> [ `Ok of 'v t | `Duplicate_key of key ]
val of_iteri_exn : iteri:(f:(key:key -> data:'v -> unit) -> unit) -> 'v t
val of_tree : 'a tree -> 'a t
val invariants : _ t -> bool
val is_empty : _ t -> bool
val length : _ t -> int
val add : 'a t -> key:key -> data:'a -> [ `Ok of 'a t | `Duplicate ]
val add_exn : 'a t -> key:key -> data:'a -> 'a t
val set : 'a t -> key:key -> data:'a -> 'a t
val add_multi : 'a list t -> key:key -> data:'a -> 'a list t
val remove_multi : 'a list t -> key -> 'a list t
val find_multi : 'a list t -> key -> 'a list
val change : 'a t -> key -> f:('a option -> 'a option) -> 'a t
val update : 'a t -> key -> f:('a option -> 'a) -> 'a t
val find : 'a t -> key -> 'a option
val find_exn : 'a t -> key -> 'a
val remove : 'a t -> key -> 'a t
val mem : _ t -> key -> bool
val iter_keys : _ t -> f:(key -> unit) -> unit
val iter : 'a t -> f:('a -> unit) -> unit
val iteri : 'a t -> f:(key:key -> data:'a -> unit) -> unit
val iteri_until : 'a t -> f:(key:key -> data:'a -> Continue_or_stop.t) -> Finished_or_unfinished.t
val iter2 : 'a t -> 'b t -> f:(key:key -> 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:key -> data:'a -> 'b) -> 'b t
val fold : 'a t -> init:'b -> f:(key:key -> data:'a -> 'b -> 'b) -> 'b
val fold_until : 'a t -> init:'acc -> f:(key:key -> data:'a -> 'acc -> ('acc, 'final) Container.Continue_or_stop.t) -> finish:('acc -> 'final) -> 'final
val fold_right : 'a t -> init:'b -> f:(key:key -> data:'a -> 'b -> 'b) -> 'b
val fold2 : 'a t -> 'b t -> init:'c -> f: (key:key -> data:[ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] -> 'c -> 'c) -> 'c
val filter_keys : 'a t -> f:(key -> bool) -> 'a t
val filter : 'a t -> f:('a -> bool) -> 'a t
val filteri : 'a t -> f:(key:key -> data:'a -> bool) -> 'a t
val filter_map : 'a t -> f:('a -> 'b option) -> 'b t
val filter_mapi : 'a t -> f:(key:key -> data:'a -> 'b option) -> 'b t
val partition_mapi : 'a t -> f:(key:key -> data:'a -> ('b, 'c) Either.t) -> 'b t * 'c t
val partition_map : 'a t -> f:('a -> ('b, 'c) Either.t) -> 'b t * 'c t
val partitioni_tf : 'a t -> f:(key:key -> data:'a -> bool) -> 'a t * 'a t
val partition_tf : 'a t -> f:('a -> bool) -> 'a t * 'a t
val combine_errors : 'a Or_error.t t -> 'a t 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 -> key list
val data : 'a t -> 'a list
val to_alist : ?key_order:[ `Increasing | `Decreasing ] -> 'a t -> (key * 'a) list
val merge : 'a t -> 'b t -> f:(key:key -> [ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] -> 'c option) -> 'c t
val merge_skewed : 'v t -> 'v t -> combine:(key:key -> 'v -> 'v -> 'v) -> 'v t
val symmetric_diff : 'a t -> 'a t -> data_equal:('a -> 'a -> bool) -> (key * [ `Left of 'a | `Right of 'a | `Unequal of 'a * 'a ]) Sequence.t
val fold_symmetric_diff : 'a t -> 'a t -> data_equal:('a -> 'a -> bool) -> init:'c -> f:('c -> (key * [ `Left of 'a | `Right of 'a | `Unequal of 'a * 'a ]) -> 'c) -> 'c
val min_elt : 'a t -> (key * 'a) option
val min_elt_exn : 'a t -> key * 'a
val max_elt : 'a t -> (key * 'a) option
val max_elt_exn : 'a t -> key * 'a
val for_all : 'a t -> f:('a -> bool) -> bool
val for_alli : 'a t -> f:(key:key -> data:'a -> bool) -> bool
val exists : 'a t -> f:('a -> bool) -> bool
val existsi : 'a t -> f:(key:key -> data:'a -> bool) -> bool
val count : 'a t -> f:('a -> bool) -> int
val counti : 'a t -> f:(key:key -> data:'a -> bool) -> int
val split : 'a t -> key -> 'a t * (key * '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:key Maybe_bound.t -> upper_bound:key Maybe_bound.t -> 'a t
val fold_range_inclusive : 'a t -> min:key -> max:key -> init:'b -> f:(key:key -> data:'a -> 'b -> 'b) -> 'b
val range_to_alist : 'a t -> min:key -> max:key -> (key * 'a) list
val closest_key : 'a t -> [ `Greater_or_equal_to | `Greater_than | `Less_or_equal_to | `Less_than ] -> key -> (key * 'a) option
val nth : 'a t -> int -> (key * 'a) option
val nth_exn : 'a t -> int -> key * 'a
val rank : _ t -> key -> int option
val to_tree : 'a t -> 'a tree
val to_sequence : ?order:[ `Increasing_key | `Decreasing_key ] -> ?keys_greater_or_equal_to:key -> ?keys_less_or_equal_to:key -> 'a t -> (key * 'a) Sequence.t
val binary_search_segmented : 'a t -> segment_of:(key:key -> data:'a -> [ `Left | `Right ]) -> Binary_searchable.Which_target_by_segment.t -> (key * 'a) option
val binary_search_subrange : 'a t -> compare:(key:key -> data:'a -> 'bound -> int) -> lower_bound:'bound Maybe_bound.t -> upper_bound:'bound Maybe_bound.t -> 'a t