package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type
type ('a, 'b, 'c) map = ('a, 'b, 'c) t
module Tree : sig ... end
type comparator_witness = Base.Comparator.Poly.comparator_witness
type ('a, +'b) t = ('a, 'b, comparator_witness) map
include Bin_prot.Binable.S2 with type ('a, +'b) t := ('a, 'b) t
val bin_size_t : ('a, 'b, ('a, 'b) t) Bin_prot.Size.sizer2
val bin_write_t : ('a, 'b, ('a, 'b) t) Bin_prot.Write.writer2
val bin_read_t : ('a, 'b, ('a, 'b) t) Bin_prot.Read.reader2
val __bin_read_t__ : ('a, 'b, int -> ('a, 'b) t) Bin_prot.Read.reader2
val bin_writer_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.writer
val bin_reader_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.reader
val bin_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.t
include Sexplib0.Sexpable.S2 with type ('a, +'b) t := ('a, 'b) t
val t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> (Sexplib0.Sexp.t -> 'b) -> Sexplib0.Sexp.t -> ('a, 'b) t
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> ('b -> Sexplib0.Sexp.t) -> ('a, 'b) t -> Sexplib0.Sexp.t
include Ppx_compare_lib.Comparable.S2 with type ('a, +'b) t := ('a, 'b) t
val compare : ('a -> 'a -> int) -> ('b -> 'b -> int) -> ('a, 'b) t -> ('a, 'b) t -> int
include Map_intf.Creators_and_accessors_generic with type ('a, 'b, 'c) t := ('a, 'b) t with type ('a, 'b, 'c) tree := ('a, 'b) Tree.t with type 'k key := 'k with type 'c cmp := comparator_witness with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Base.Map.Without_comparator.t with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) Base.Map.Without_comparator.t
include Map_intf.Creators_generic with type ('a, 'b, 'c) t := ('a, 'b) t with type ('a, 'b, 'c) tree := ('a, 'b) Tree.t with type 'a key := 'a with type 'a cmp := comparator_witness with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Base.Map.Without_comparator.t with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) Base.Map.Without_comparator.t
include Base.Map.Creators_generic with type ('a, 'b, 'c) t := ('a, 'b) t with type ('a, 'b, 'c) tree := ('a, 'b) Tree.t with type 'a key := 'a with type 'a cmp := comparator_witness with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Base.Map.Without_comparator.t with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) Base.Map.Without_comparator.t
val empty : ('k, 'cmp, ('k, _) t) Base.Map.Without_comparator.t
val singleton : ('k, 'cmp, 'k -> 'v -> ('k, 'v) t) Base.Map.Without_comparator.t
val map_keys : ('k2, 'cmp2, ('k1, 'v) t -> f:('k1 -> 'k2) -> [ `Ok of ('k2, 'v) t | `Duplicate_key of 'k2 ]) Base.Map.Without_comparator.t
val map_keys_exn : ('k2, 'cmp2, ('k1, 'v) t -> f:('k1 -> 'k2) -> ('k2, 'v) t) Base.Map.Without_comparator.t
val transpose_keys : ('k1, 'cmp1, ('k2, 'cmp2, ('k1, ('k2, 'a) t) t -> ('k2, ('k1, 'a) t) t) Base.Map.Without_comparator.t) Base.Map.Without_comparator.t
val of_sorted_array : ('k, 'cmp, ('k * 'v) array -> ('k, 'v) t Base.Or_error.t) Base.Map.Without_comparator.t
val of_sorted_array_unchecked : ('k, 'cmp, ('k * 'v) array -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_increasing_iterator_unchecked : ('k, 'cmp, len:int -> f:(int -> 'k * 'v) -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_alist : ('k, 'cmp, ('k * 'v) list -> [ `Ok of ('k, 'v) t | `Duplicate_key of 'k ]) Base.Map.Without_comparator.t
val of_alist_or_error : ('k, 'cmp, ('k * 'v) list -> ('k, 'v) t Base.Or_error.t) Base.Map.Without_comparator.t
val of_alist_exn : ('k, 'cmp, ('k * 'v) list -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_alist_multi : ('k, 'cmp, ('k * 'v) list -> ('k, 'v list) t) Base.Map.Without_comparator.t
val of_alist_fold : ('k, 'cmp, ('k * 'v1) list -> init:'v2 -> f:('v2 -> 'v1 -> 'v2) -> ('k, 'v2) t) Base.Map.Without_comparator.t
val of_alist_reduce : ('k, 'cmp, ('k * 'v) list -> f:('v -> 'v -> 'v) -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_increasing_sequence : ('k, 'cmp, ('k * 'v) Base.Sequence.t -> ('k, 'v) t Base.Or_error.t) Base.Map.Without_comparator.t
val of_sequence : ('k, 'cmp, ('k * 'v) Base.Sequence.t -> [ `Ok of ('k, 'v) t | `Duplicate_key of 'k ]) Base.Map.Without_comparator.t
val of_sequence_or_error : ('k, 'cmp, ('k * 'v) Base.Sequence.t -> ('k, 'v) t Base.Or_error.t) Base.Map.Without_comparator.t
val of_sequence_exn : ('k, 'cmp, ('k * 'v) Base.Sequence.t -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_sequence_multi : ('k, 'cmp, ('k * 'v) Base.Sequence.t -> ('k, 'v list) t) Base.Map.Without_comparator.t
val of_sequence_fold : ('k, 'cmp, ('k * 'v1) Base.Sequence.t -> init:'v2 -> f:('v2 -> 'v1 -> 'v2) -> ('k, 'v2) t) Base.Map.Without_comparator.t
val of_sequence_reduce : ('k, 'cmp, ('k * 'v) Base.Sequence.t -> f:('v -> 'v -> 'v) -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_list_with_key : ('k, 'cmp, 'v list -> get_key:('v -> 'k) -> [ `Ok of ('k, 'v) t | `Duplicate_key of 'k ]) Base.Map.Without_comparator.t
val of_list_with_key_or_error : ('k, 'cmp, 'v list -> get_key:('v -> 'k) -> ('k, 'v) t Base.Or_error.t) Base.Map.Without_comparator.t
val of_list_with_key_exn : ('k, 'cmp, 'v list -> get_key:('v -> 'k) -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_list_with_key_multi : ('k, 'cmp, 'v list -> get_key:('v -> 'k) -> ('k, 'v list) t) Base.Map.Without_comparator.t
val of_iteri : ('k, 'cmp, iteri:(f:(key:'k -> data:'v -> unit) -> unit) -> [ `Ok of ('k, 'v) t | `Duplicate_key of 'k ]) Base.Map.Without_comparator.t
val of_iteri_exn : ('k, 'cmp, iteri:(f:(key:'k -> data:'v -> unit) -> unit) -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_tree : ('k, 'cmp, ('k, 'v) Tree.t -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_hashtbl_exn : ('k, 'cmp, ('k, 'v) Hashtbl.t -> ('k, 'v) t) Base.Map.Without_comparator.t
val of_key_set : ('k, comparator_witness) Base.Set.t -> f:('k -> 'v) -> ('k, 'v) t

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

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