package core

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

Industrial strength alternative to OCaml's standard library

Install

dune-project

Dependency

github.com Edit opam file Versions (13)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.15.1.tar.gz

sha256=6f7bbdda1d97f2f542a45331f062127dd5264d6ed73ece7b2c6b330785dfc991

doc/core/Core/Map/Make_binable/index.html

Module `Map.Make_binable`

Parameters

module Key : Key_binable

Signature

module Key : sig ... end

include Map_intf.S with module Key := Key

include Map_intf.S_plain with module Key := Key

type +'a t = (Key.t, 'a, Key.comparator_witness) Base.Map.t

include Ppx_compare_lib.Comparable.S1 with type +'a t := 'a t

val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int

include Map_intf.Creators_and_accessors1
  with type 'a t := 'a t
  with type 'a tree :=
         (Key.t, 'a, Key.comparator_witness) Base.Map.Using_comparator.Tree.t
  with type key := Key.t
  with type comparator_witness := Key.comparator_witness

include Map_intf.Creators1
  with type 'a t := 'a t
  with type 'a tree :=
         (Key.t, 'a, Key.comparator_witness) Base.Map.Using_comparator.Tree.t
  with type key := Key.t
  with type comparator_witness := Key.comparator_witness

include Base.Map.Creators1
  with type 'a t := 'a t
  with type 'a tree :=
         (Key.t, 'a, Key.comparator_witness) Base.Map.Using_comparator.Tree.t
  with type key := Key.t
  with type comparator_witness := Key.comparator_witness

val empty : _ t

val singleton : Key.t -> 'a -> 'a t

val map_keys : 
  'v t ->
  f:(Key.t -> Key.t) ->
  [ `Ok of 'v t | `Duplicate_key of Key.t ]

val map_keys_exn : 'v t -> f:(Key.t -> Key.t) -> 'v t

val of_alist : (Key.t * 'a) list -> [ `Ok of 'a t | `Duplicate_key of Key.t ]

val of_alist_or_error : (Key.t * 'a) list -> 'a t Base.Or_error.t

val of_alist_exn : (Key.t * 'a) list -> 'a t

val of_alist_multi : (Key.t * 'a) list -> 'a list t

val of_alist_fold : (Key.t * 'a) list -> init:'b -> f:('b -> 'a -> 'b) -> 'b t

val of_alist_reduce : (Key.t * 'a) list -> f:('a -> 'a -> 'a) -> 'a t

val of_sorted_array : (Key.t * 'a) array -> 'a t Base.Or_error.t

val of_sorted_array_unchecked : (Key.t * 'a) array -> 'a t

val of_increasing_iterator_unchecked : len:int -> f:(int -> Key.t * 'a) -> 'a t

val of_increasing_sequence : 
  (Key.t * 'a) Base.Sequence.t ->
  'a t Base.Or_error.t

val of_sequence : 
  (Key.t * 'a) Base.Sequence.t ->
  [ `Ok of 'a t | `Duplicate_key of Key.t ]

val of_sequence_or_error : (Key.t * 'a) Base.Sequence.t -> 'a t Base.Or_error.t

val of_sequence_exn : (Key.t * 'a) Base.Sequence.t -> 'a t

val of_sequence_multi : (Key.t * 'a) Base.Sequence.t -> 'a list t

val of_sequence_fold : 
  (Key.t * 'a) Base.Sequence.t ->
  init:'b ->
  f:('b -> 'a -> 'b) ->
  'b t

val of_sequence_reduce : 
  (Key.t * 'a) Base.Sequence.t ->
  f:('a -> 'a -> 'a) ->
  'a t

val of_iteri : 
  iteri:(f:(key:Key.t -> data:'v -> unit) -> unit) ->
  [ `Ok of 'v t | `Duplicate_key of Key.t ]

val of_iteri_exn : iteri:(f:(key:Key.t -> data:'v -> unit) -> unit) -> 'v t

val of_tree : 
  (Key.t, 'a, Key.comparator_witness) Base.Map.Using_comparator.Tree.t ->
  'a t

val of_hashtbl_exn : (Key.t, 'a) Hashtbl.t -> 'a t

val of_key_set : 
  (Key.t, Key.comparator_witness) Base.Set.t ->
  f:(Key.t -> 'v) ->
  'v t

val quickcheck_generator : 
  Key.t Quickcheck.Generator.t ->
  'a Quickcheck.Generator.t ->
  'a t Quickcheck.Generator.t

include Map_intf.Accessors1
  with type 'a t := 'a t
  with type 'a tree :=
         (Key.t, 'a, Key.comparator_witness) Base.Map.Using_comparator.Tree.t
  with type key := Key.t
  with type comparator_witness := Key.comparator_witness

include Base.Map.Accessors1
  with type 'a t := 'a t
  with type 'a tree :=
         (Key.t, 'a, Key.comparator_witness) Base.Map.Using_comparator.Tree.t
  with type key := Key.t
  with type comparator_witness := Key.comparator_witness

val invariants : _ t -> bool

val is_empty : _ t -> bool

val length : _ t -> int

val add : 'a t -> key:Key.t -> data:'a -> [ `Ok of 'a t | `Duplicate ]

val add_exn : 'a t -> key:Key.t -> data:'a -> 'a t

val set : 'a t -> key:Key.t -> data:'a -> 'a t

val add_multi : 'a list t -> key:Key.t -> data:'a -> 'a list t

val remove_multi : 'a list t -> Key.t -> 'a list t

val find_multi : 'a list t -> Key.t -> 'a list

val change : 'a t -> Key.t -> f:('a option -> 'a option) -> 'a t

val update : 'a t -> Key.t -> f:('a option -> 'a) -> 'a t

val find : 'a t -> Key.t -> 'a option

val find_exn : 'a t -> Key.t -> 'a

val remove : 'a t -> Key.t -> 'a t

val mem : _ t -> Key.t -> bool

val iter_keys : _ t -> f:(Key.t -> unit) -> unit

val iter : 'a t -> f:('a -> unit) -> unit

val iteri : 'a t -> f:(key:Key.t -> data:'a -> unit) -> unit

val iteri_until : 
  'a t ->
  f:(key:Key.t -> data:'a -> Base.Map.Continue_or_stop.t) ->
  Base.Map.Finished_or_unfinished.t

val iter2 : 
  'a t ->
  'b t ->
  f:
    (key:Key.t ->
      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.t -> data:'a -> 'b) -> 'b t

val fold : 'a t -> init:'b -> f:(key:Key.t -> data:'a -> 'b -> 'b) -> 'b

val fold_until : 
  'a t ->
  init:'acc ->
  f:
    (key:Key.t ->
      data:'a ->
      'acc ->
      ('acc, 'final) Base.Container.Continue_or_stop.t) ->
  finish:('acc -> 'final) ->
  'final

val fold_right : 'a t -> init:'b -> f:(key:Key.t -> data:'a -> 'b -> 'b) -> 'b

val fold2 : 
  'a t ->
  'b t ->
  init:'c ->
  f:
    (key:Key.t ->
      data:[ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] ->
      'c ->
      'c) ->
  'c

val filter_keys : 'a t -> f:(Key.t -> bool) -> 'a t

val filter : 'a t -> f:('a -> bool) -> 'a t

val filteri : 'a t -> f:(key:Key.t -> data:'a -> bool) -> 'a t

val filter_map : 'a t -> f:('a -> 'b option) -> 'b t

val filter_mapi : 'a t -> f:(key:Key.t -> data:'a -> 'b option) -> 'b t

val partition_mapi : 
  'a t ->
  f:(key:Key.t -> data:'a -> ('b, 'c) Base.Either.t) ->
  'b t * 'c t

val partition_map : 'a t -> f:('a -> ('b, 'c) Base.Either.t) -> 'b t * 'c t

val partitioni_tf : 'a t -> f:(key:Key.t -> data:'a -> bool) -> 'a t * 'a t

val partition_tf : 'a t -> f:('a -> bool) -> 'a t * 'a t

val combine_errors : 'a Base.Or_error.t t -> 'a t Base.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.t list

val data : 'a t -> 'a list

val to_alist : 
  ?key_order:[ `Increasing | `Decreasing ] ->
  'a t ->
  (Key.t * 'a) list

val merge : 
  'a t ->
  'b t ->
  f:
    (key:Key.t ->
      [ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] ->
      'c option) ->
  'c t

val merge_skewed : 
  'v t ->
  'v t ->
  combine:(key:Key.t -> 'v -> 'v -> 'v) ->
  'v t

val symmetric_diff : 
  'a t ->
  'a t ->
  data_equal:('a -> 'a -> bool) ->
  (Key.t * [ `Left of 'a | `Right of 'a | `Unequal of 'a * 'a ])
    Base.Sequence.t

val fold_symmetric_diff : 
  'a t ->
  'a t ->
  data_equal:('a -> 'a -> bool) ->
  init:'c ->
  f:
    ('c ->
      (Key.t * [ `Left of 'a | `Right of 'a | `Unequal of 'a * 'a ]) ->
      'c) ->
  'c

val min_elt : 'a t -> (Key.t * 'a) option

val min_elt_exn : 'a t -> Key.t * 'a

val max_elt : 'a t -> (Key.t * 'a) option

val max_elt_exn : 'a t -> Key.t * 'a

val for_all : 'a t -> f:('a -> bool) -> bool

val for_alli : 'a t -> f:(key:Key.t -> data:'a -> bool) -> bool

val exists : 'a t -> f:('a -> bool) -> bool

val existsi : 'a t -> f:(key:Key.t -> data:'a -> bool) -> bool

val count : 'a t -> f:('a -> bool) -> int

val counti : 'a t -> f:(key:Key.t -> data:'a -> bool) -> int

val split : 'a t -> Key.t -> 'a t * (Key.t * '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.t Base.Maybe_bound.t ->
  upper_bound:Key.t Base.Maybe_bound.t ->
  'a t

val fold_range_inclusive : 
  'a t ->
  min:Key.t ->
  max:Key.t ->
  init:'b ->
  f:(key:Key.t -> data:'a -> 'b -> 'b) ->
  'b

val range_to_alist : 'a t -> min:Key.t -> max:Key.t -> (Key.t * 'a) list

val closest_key : 
  'a t ->
  [ `Greater_or_equal_to | `Greater_than | `Less_or_equal_to | `Less_than ] ->
  Key.t ->
  (Key.t * 'a) option

val nth : 'a t -> int -> (Key.t * 'a) option

val nth_exn : 'a t -> int -> Key.t * 'a

val rank : _ t -> Key.t -> int option

val to_tree : 
  'a t ->
  (Key.t, 'a, Key.comparator_witness) Base.Map.Using_comparator.Tree.t

val to_sequence : 
  ?order:[ `Increasing_key | `Decreasing_key ] ->
  ?keys_greater_or_equal_to:Key.t ->
  ?keys_less_or_equal_to:Key.t ->
  'a t ->
  (Key.t * 'a) Base.Sequence.t

val binary_search : 
  'a t ->
  compare:(key:Key.t -> data:'a -> 'key -> int) ->
  Base.Binary_searchable.Which_target_by_key.t ->
  'key ->
  (Key.t * 'a) option

val binary_search_segmented : 
  'a t ->
  segment_of:(key:Key.t -> data:'a -> [ `Left | `Right ]) ->
  Base.Binary_searchable.Which_target_by_segment.t ->
  (Key.t * 'a) option

val binary_search_subrange : 
  'a t ->
  compare:(key:Key.t -> data:'a -> 'bound -> int) ->
  lower_bound:'bound Base.Maybe_bound.t ->
  upper_bound:'bound Base.Maybe_bound.t ->
  'a t

val key_set : _ t -> (Key.t, Key.comparator_witness) Base.Set.t

val validate : 
  name:(Key.t -> Base.String.t) ->
  'a Validate.check ->
  'a t Validate.check

val validatei : 
  name:(Key.t -> Base.String.t) ->
  (Key.t * 'a) Validate.check ->
  'a t Validate.check

val quickcheck_observer : 
  Key.t Quickcheck.Observer.t ->
  'v Quickcheck.Observer.t ->
  'v t Quickcheck.Observer.t

val quickcheck_shrinker : 
  Key.t Quickcheck.Shrinker.t ->
  'v Quickcheck.Shrinker.t ->
  'v t Quickcheck.Shrinker.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 : Base.Hasher.S with type t := Key.t) : sig ... end

include Sexpable.S1 with type 'a t := 'a t

val t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t

val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

include Map_intf.Binable.S1 with type 'a t := 'a t

val bin_shape_t : Bin_prot.Shape.t -> Bin_prot.Shape.t

val bin_size_t : ('a, 'a t) Bin_prot.Size.sizer1

val bin_write_t : ('a, 'a t) Bin_prot.Write.writer1

val bin_read_t : ('a, 'a t) Bin_prot.Read.reader1

val __bin_read_t__ : ('a, int -> 'a t) Bin_prot.Read.reader1

val bin_writer_t : ('a, 'a t) Bin_prot.Type_class.S1.writer

val bin_reader_t : ('a, 'a t) Bin_prot.Type_class.S1.reader

val bin_t : ('a, 'a t) Bin_prot.Type_class.S1.t