package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
include Creators_and_accessors_generic with type ('a, 'b, 'c) t := 'b t with type ('a, 'b, 'c) tree := 'b t with type 'a key := Key.t with type 'a cmp := Key.comparator_witness with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Without_comparator.t with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) Without_comparator.t
include Creators_generic with type ('a, 'b, 'c) t := 'b t with type ('a, 'b, 'c) tree := 'b t with type 'a key := Key.t with type 'a cmp := Key.comparator_witness with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Without_comparator.t with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) Without_comparator.t
include Map.Creators_generic with type ('a, 'b, 'c) t := 'b t with type ('a, 'b, 'c) tree := 'b t with type 'a key := Key.t with type 'a cmp := Key.comparator_witness with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Without_comparator.t with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) Without_comparator.t
val empty : ('k, 'cmp, _ t) Without_comparator.t
val singleton : ('k, 'cmp, Key.t -> 'v -> 'v t) Without_comparator.t
val map_keys : ('k2, 'cmp2, 'v t -> f:(Key.t -> Key.t) -> [ `Ok of 'v t | `Duplicate_key of Key.t ]) Without_comparator.t
val map_keys_exn : ('k2, 'cmp2, 'v t -> f:(Key.t -> Key.t) -> 'v t) Without_comparator.t
val transpose_keys : ('k1, 'cmp1, ('k2, 'cmp2, 'a t t -> 'a t t) Without_comparator.t) Without_comparator.t
val of_sorted_array : ('k, 'cmp, (Key.t * 'v) array -> 'v t Base.Or_error.t) Without_comparator.t
val of_sorted_array_unchecked : ('k, 'cmp, (Key.t * 'v) array -> 'v t) Without_comparator.t
val of_increasing_iterator_unchecked : ('k, 'cmp, len:int -> f:(int -> Key.t * 'v) -> 'v t) Without_comparator.t
val of_alist : ('k, 'cmp, (Key.t * 'v) list -> [ `Ok of 'v t | `Duplicate_key of Key.t ]) Without_comparator.t
val of_alist_or_error : ('k, 'cmp, (Key.t * 'v) list -> 'v t Base.Or_error.t) Without_comparator.t
val of_alist_exn : ('k, 'cmp, (Key.t * 'v) list -> 'v t) Without_comparator.t
val of_alist_multi : ('k, 'cmp, (Key.t * 'v) list -> 'v list t) Without_comparator.t
val of_alist_fold : ('k, 'cmp, (Key.t * 'v1) list -> init:'v2 -> f:('v2 -> 'v1 -> 'v2) -> 'v2 t) Without_comparator.t
val of_alist_reduce : ('k, 'cmp, (Key.t * 'v) list -> f:('v -> 'v -> 'v) -> 'v t) Without_comparator.t
val of_increasing_sequence : ('k, 'cmp, (Key.t * 'v) Base.Sequence.t -> 'v t Base.Or_error.t) Without_comparator.t
val of_sequence : ('k, 'cmp, (Key.t * 'v) Base.Sequence.t -> [ `Ok of 'v t | `Duplicate_key of Key.t ]) Without_comparator.t
val of_sequence_or_error : ('k, 'cmp, (Key.t * 'v) Base.Sequence.t -> 'v t Base.Or_error.t) Without_comparator.t
val of_sequence_exn : ('k, 'cmp, (Key.t * 'v) Base.Sequence.t -> 'v t) Without_comparator.t
val of_sequence_multi : ('k, 'cmp, (Key.t * 'v) Base.Sequence.t -> 'v list t) Without_comparator.t
val of_sequence_fold : ('k, 'cmp, (Key.t * 'v1) Base.Sequence.t -> init:'v2 -> f:('v2 -> 'v1 -> 'v2) -> 'v2 t) Without_comparator.t
val of_sequence_reduce : ('k, 'cmp, (Key.t * 'v) Base.Sequence.t -> f:('v -> 'v -> 'v) -> 'v t) Without_comparator.t
val of_list_with_key : ('k, 'cmp, 'v list -> get_key:('v -> Key.t) -> [ `Ok of 'v t | `Duplicate_key of Key.t ]) Without_comparator.t
val of_list_with_key_or_error : ('k, 'cmp, 'v list -> get_key:('v -> Key.t) -> 'v t Base.Or_error.t) Without_comparator.t
val of_list_with_key_exn : ('k, 'cmp, 'v list -> get_key:('v -> Key.t) -> 'v t) Without_comparator.t
val of_list_with_key_multi : ('k, 'cmp, 'v list -> get_key:('v -> Key.t) -> 'v list t) Without_comparator.t
val of_iteri : ('k, 'cmp, iteri:(f:(key:Key.t -> data:'v -> unit) -> unit) -> [ `Ok of 'v t | `Duplicate_key of Key.t ]) Without_comparator.t
val of_iteri_exn : ('k, 'cmp, iteri:(f:(key:Key.t -> data:'v -> unit) -> unit) -> 'v t) Without_comparator.t
val of_tree : ('k, 'cmp, 'v t -> 'v t) Without_comparator.t
val of_hashtbl_exn : ('k, 'cmp, (Key.t, 'v) Hashtbl.t -> 'v t) Without_comparator.t
val of_key_set : (Key.t, Key.comparator_witness) Base.Set.t -> f:(Key.t -> 'v) -> 'v t

Never requires a comparator because it can get one from the input Set.t.

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