package containers

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

Parameters

module O : Stdlib.Map.OrderedType

Signature

include Stdlib.Map.S with type 'a t = 'a Stdlib.Map.Make(O).t with type key = O.t
type key = O.t
type 'a t = 'a Stdlib.Map.Make(O).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge : (key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val max_binding : 'a t -> key * 'a
val choose : 'a t -> key * 'a
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val to_seq_from : key -> 'a t -> (key * 'a) Stdlib.Seq.t
val get : key -> 'a t -> 'a option

Safe version of find.

val get_or : key -> 'a t -> default:'a -> 'a

get_or k m ~default returns the value associated to k if present, and returns default otherwise (if k doesn't belong in m).

  • since 0.16
val update : key -> ('a option -> 'a option) -> 'a t -> 'a t

update k f m calls f (Some v) if find k m = v, otherwise it calls f None. In any case, if the result is None k is removed from m, and if the result is Some v' then add k v' m is returned.

val choose_opt : 'a t -> (key * 'a) option

Safe version of choose.

  • since 1.5
val min_binding_opt : 'a t -> (key * 'a) option

Safe version of min_binding.

  • since 1.5
val max_binding_opt : 'a t -> (key * 'a) option

Safe version of max_binding.

  • since 1.5
val find_opt : key -> 'a t -> 'a option

Safe version of find.

  • since 1.5
val find_first : (key -> bool) -> 'a t -> key * 'a

Find smallest binding satisfying the monotonic predicate. See Map.S.find_first.

  • since 1.5
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option

Safe version of find_first.

  • since 1.5
val merge_safe : f:(key -> [ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] -> 'c option) -> 'a t -> 'b t -> 'c t

merge_safe ~f a b merges the maps a and b together.

  • since 0.17
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t

Union of both maps, using the function to combine bindings that belong to both inputs.

  • since 1.4
val add_std_seq : 'a t -> (key * 'a) Stdlib.Seq.t -> 'a t

Like add_list.

  • since 2.8
val of_std_seq : (key * 'a) Stdlib.Seq.t -> 'a t

Like of_list.

  • since 2.8
val add_iter : 'a t -> (key * 'a) iter -> 'a t

Like add_list.

  • since 2.8
val of_iter : (key * 'a) iter -> 'a t

Like of_list.

  • since 2.8
val to_iter : 'a t -> (key * 'a) iter

Like to_list.

  • since 2.8
val of_seq : (key * 'a) sequence -> 'a t
  • deprecated use of_iter instead
val add_seq : 'a t -> (key * 'a) sequence -> 'a t
  • deprecated use add_iter instead
val to_seq : 'a t -> (key * 'a) sequence
  • deprecated use to_iter instead
val of_list : (key * 'a) list -> 'a t

Build a map from the given list of bindings k_i -> v_i, added in order using add. If a key occurs several times, only its last binding will be present in the result.

val add_list : 'a t -> (key * 'a) list -> 'a t
  • since 0.14
val keys : _ t -> key iter

Iterate on keys only.

  • since 0.15
val values : 'a t -> 'a iter

Iterate on values only.

  • since 0.15
val to_list : 'a t -> (key * 'a) list
val pp : ?start:string -> ?stop:string -> ?arrow:string -> ?sep:string -> key printer -> 'a printer -> 'a t printer
OCaml

Innovation. Community. Security.