package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Key : Key_plain

Signature

module Key : sig ... end
type +'a t = (Key.t, 'a, Key.comparator_witness) Core__.Map_intf.Map.t
include Ppx_compare_lib.Comparable.S1 with type +'a t := 'a t
val compare : 'a Base__Ppx_compare_lib.compare -> 'a t Base__Ppx_compare_lib.compare
include Ppx_compare_lib.Equal.S1 with type +'a t := 'a t
val equal : 'a Base__Ppx_compare_lib.equal -> 'a t Base__Ppx_compare_lib.equal
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
include Map_intf.Creators_generic with type ('a, 'b, 'c) t := 'b t with type ('a, 'b, 'c) tree := (Key.t, 'b, Key.comparator_witness) Core__.Map_intf.Tree.t with type 'k key := Key.t with type 'c cmp := Key.comparator_witness with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Core__.Map_intf.Without_comparator.t with type ('a, 'b, 'c) access_options := ('a, 'b, 'c) Core__.Map_intf.Without_comparator.t
val empty : ('k, 'cmp, 'a t) Core__.Map_intf.Without_comparator.t
val singleton : ('k, 'cmp, Key.t -> 'v -> 'v t) Core__.Map_intf.Without_comparator.t
val map_keys : ('k2, 'cmp2, 'v t -> f:(Key.t -> Key.t) -> [ `Duplicate_key of Key.t | `Ok of 'v t ]) Core__.Map_intf.Without_comparator.t
val map_keys_exn : ('k2, 'cmp2, 'v t -> f:(Key.t -> Key.t) -> 'v t) Core__.Map_intf.Without_comparator.t
val transpose_keys : ('k1, 'cmp1, ('k2, 'cmp2, 'a t t -> 'a t t) Core__.Map_intf.Without_comparator.t) Core__.Map_intf.Without_comparator.t
val of_sorted_array : ('k, 'cmp, (Key.t * 'v) array -> 'v t Base__.Or_error.t) Core__.Map_intf.Without_comparator.t
val of_sorted_array_unchecked : ('k, 'cmp, (Key.t * 'v) array -> 'v t) Core__.Map_intf.Without_comparator.t
val of_increasing_iterator_unchecked : ('k, 'cmp, len:int -> f:(int -> Key.t * 'v) -> 'v t) Core__.Map_intf.Without_comparator.t
val of_alist : ('k, 'cmp, (Key.t * 'v) list -> [ `Duplicate_key of Key.t | `Ok of 'v t ]) Core__.Map_intf.Without_comparator.t
val of_alist_or_error : ('k, 'cmp, (Key.t * 'v) list -> 'v t Base__.Or_error.t) Core__.Map_intf.Without_comparator.t
val of_alist_exn : ('k, 'cmp, (Key.t * 'v) list -> 'v t) Core__.Map_intf.Without_comparator.t
val of_alist_multi : ('k, 'cmp, (Key.t * 'v) list -> 'v list t) Core__.Map_intf.Without_comparator.t
val of_alist_fold : ('k, 'cmp, (Key.t * 'v1) list -> init:'v2 -> f:('v2 -> 'v1 -> 'v2) -> 'v2 t) Core__.Map_intf.Without_comparator.t
val of_alist_reduce : ('k, 'cmp, (Key.t * 'v) list -> f:('v -> 'v -> 'v) -> 'v t) Core__.Map_intf.Without_comparator.t
val of_increasing_sequence : ('k, 'cmp, (Key.t * 'v) Base__.Sequence.t -> 'v t Base__.Or_error.t) Core__.Map_intf.Without_comparator.t
val of_sequence : ('k, 'cmp, (Key.t * 'v) Base__.Sequence.t -> [ `Duplicate_key of Key.t | `Ok of 'v t ]) Core__.Map_intf.Without_comparator.t
val of_sequence_or_error : ('k, 'cmp, (Key.t * 'v) Base__.Sequence.t -> 'v t Base__.Or_error.t) Core__.Map_intf.Without_comparator.t
val of_sequence_exn : ('k, 'cmp, (Key.t * 'v) Base__.Sequence.t -> 'v t) Core__.Map_intf.Without_comparator.t
val of_sequence_multi : ('k, 'cmp, (Key.t * 'v) Base__.Sequence.t -> 'v list t) Core__.Map_intf.Without_comparator.t
val of_sequence_fold : ('k, 'cmp, (Key.t * 'v1) Base__.Sequence.t -> init:'v2 -> f:('v2 -> 'v1 -> 'v2) -> 'v2 t) Core__.Map_intf.Without_comparator.t
val of_sequence_reduce : ('k, 'cmp, (Key.t * 'v) Base__.Sequence.t -> f:('v -> 'v -> 'v) -> 'v t) Core__.Map_intf.Without_comparator.t
val of_list_with_key : ('k, 'cmp, 'v list -> get_key:('v -> Key.t) -> [ `Duplicate_key of Key.t | `Ok of 'v t ]) Core__.Map_intf.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) Core__.Map_intf.Without_comparator.t
val of_list_with_key_exn : ('k, 'cmp, 'v list -> get_key:('v -> Key.t) -> 'v t) Core__.Map_intf.Without_comparator.t
val of_list_with_key_multi : ('k, 'cmp, 'v list -> get_key:('v -> Key.t) -> 'v list t) Core__.Map_intf.Without_comparator.t
val of_iteri : ('k, 'cmp, iteri:(f:(key:Key.t -> data:'v -> unit) -> unit) -> [ `Duplicate_key of Key.t | `Ok of 'v t ]) Core__.Map_intf.Without_comparator.t
val of_iteri_exn : ('k, 'cmp, iteri:(f:(key:Key.t -> data:'v -> unit) -> unit) -> 'v t) Core__.Map_intf.Without_comparator.t
val of_tree : ('k, 'cmp, (Key.t, 'v, Key.comparator_witness) Core__.Map_intf.Tree.t -> 'v t) Core__.Map_intf.Without_comparator.t
val of_hashtbl_exn : ('k, 'cmp, (Key.t, 'v) Hashtbl.t -> 'v t) Core__.Map_intf.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.

val quickcheck_generator : ('k, 'cmp, Key.t Quickcheck.Generator.t -> 'v Quickcheck.Generator.t -> 'v t Quickcheck.Generator.t) Core__.Map_intf.Without_comparator.t
val map : 'a t -> f:('a -> 'b) -> 'b t
module Provide_of_sexp (Key : sig ... end) : sig ... end
module Provide_bin_io (Key : sig ... end) : Map_intf.Binable.S1 with type 'a t := 'a t
module Provide_hash (Key : sig ... end) : sig ... end
val quickcheck_shrinker : ('k, 'cmp, Key.t Quickcheck.Shrinker.t -> 'v Quickcheck.Shrinker.t -> 'v t Quickcheck.Shrinker.t) Core__.Map_intf.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