package links

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

Package contains no libraries

Parameters

module Ord : OrderedType

Signature

include Links_core.Notfound.Map.S with type key = Ord.t

type key = Ord.t

type !+'a t

val empty : 'a t

val add : key -> 'a -> 'a t -> 'a t

val add_to_list : key -> 'a -> 'a list t -> 'a list t

val update : key -> ('a option -> 'a option) -> '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 union : (key -> 'a -> 'a -> 'a option) -> '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 min_binding_opt : 'a t -> (key * 'a) option

val max_binding : 'a t -> key * 'a

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

val choose : 'a t -> key * 'a

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

val find : key -> 'a t -> 'a

val find_opt : key -> 'a t -> 'a option

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

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

val find_last : (key -> bool) -> 'a t -> key * 'a

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

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

val fold : (key -> 'a -> 'acc -> 'acc) -> 'a t -> 'acc -> 'acc

val map : ('a -> 'b) -> 'a t -> 'b t

val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t

val split : key -> 'a t -> 'a t * 'a option * 'a t

val is_empty : 'a t -> bool

val mem : key -> 'a t -> bool

val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool

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

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

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

val of_list : (key * 'a) list -> 'a t

val to_seq : 'a t -> (key * 'a) Stdlib.Seq.t

val to_rev_seq : 'a t -> (key * 'a) Stdlib.Seq.t

val to_seq_from : key -> 'a t -> (key * 'a) Stdlib.Seq.t

val add_seq : (key * 'a) Stdlib.Seq.t -> 'a t -> 'a t

val of_seq : (key * 'a) Stdlib.Seq.t -> 'a t

exception Not_disjoint of key * string

val filterv : ('a -> bool) -> 'a t -> 'a t

filter by value

val size : 'a t -> int

the number of distinct keys in the map

val to_alist : 'a t -> (key * 'a) list

convert the map to an association list

val from_alist : (key * 'a) list -> 'a t

construct a map from an association list

val to_list : (key -> 'a -> 'b) -> 'a t -> 'b list

construct a list from a map

val megamap : ((key * 'a) -> key * 'b) -> 'a t -> 'b t

val pop : key -> 'a t -> 'a * 'a t

remove the item with the given key from the map and return the remainder.

val lookup : key -> 'a t -> 'a option

remove the item with the given key from the map and return the remainder.

as `find', but return an option instead of raising an exception

val union_disjoint : 'a t -> 'a t -> 'a t

disjoint union

val union_all : 'a t list -> 'a t

disjoint union of a list of maps

val superimpose : 'a t -> 'a t -> 'a t

Extend the second map with the first

val split_paired : ('a * 'b) t -> 'a t * 'b t

split a pair map into a pair of maps

val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t

divide the map by a predicate

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

filters using both keys and values

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

filters and applies a function -- None values discarded

val show : (Stdlib.Format.formatter -> 'a -> unit) -> 'a t -> string

val pp : 
  (Stdlib.Format.formatter -> 'a -> unit) ->
  Stdlib.Format.formatter ->
  'a t ->
  unit