package batteries

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

Parameters

Signature

include sig ... end
type key = Ord.t
type 'a t = 'a BatSplay.Map(Ord).t
val empty : 'a t
val is_empty : 'a t -> bool
val cardinal : 'a t -> int
val add : key -> 'a -> 'a t -> 'a t
val update_stdlib : key -> ('a option -> 'a option) -> 'a t -> 'a t
val update : key -> key -> 'a -> 'a t -> 'a t
val find_opt : key -> 'a t -> 'a option
val find_default : 'a -> key -> 'a t -> 'a
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 remove : key -> 'a t -> 'a t
val remove_exn : key -> 'a t -> 'a t
val modify : key -> ('a -> 'a) -> 'a t -> 'a t
val modify_def : 'a -> key -> ('a -> 'a) -> 'a t -> 'a t
val modify_opt : key -> ('a option -> 'a option) -> 'a t -> 'a t
val extract : key -> 'a t -> 'a * 'a t
val pop : 'a t -> (key * 'a) * 'a t
val mem : key -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val filterv : ('a -> bool) -> 'a t -> 'a t
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val filter_map : (key -> 'a -> 'b option) -> 'a t -> 'b t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val keys : 'a t -> key BatEnum.t
val values : 'a t -> 'a BatEnum.t
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val pop_min_binding : 'a t -> (key * 'a) * 'a t
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val pop_max_binding : 'a t -> (key * 'a) * 'a t
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val singleton : key -> 'a -> 'a t
val bindings : 'a t -> (key * 'a) list
val enum : 'a t -> (key * 'a) BatEnum.t
val backwards : 'a t -> (key * 'a) BatEnum.t
val of_enum : (key * 'a) BatEnum.t -> 'a t
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
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 to_seq : 'a t -> (key * 'a) BatSeq.t
val to_rev_seq : 'a t -> (key * 'a) BatSeq.t
val to_seq_from : key -> 'a t -> (key * 'a) BatSeq.t
val add_seq : (key * 'a) BatSeq.t -> 'a t -> 'a t
val of_seq : (key * 'a) BatSeq.t -> 'a t
val print : ?first:string -> ?last:string -> ?sep:string -> ?kvsep:string -> ('a BatInnerIO.output -> key -> unit) -> ('a BatInnerIO.output -> 'c -> unit) -> 'a BatInnerIO.output -> 'c t -> unit
module Exceptionless : sig ... end
module Infix : sig ... end
module Labels : sig ... end
val print_as_list : ('a BatInnerIO.output -> key -> unit) -> ('a BatInnerIO.output -> 'c -> unit) -> 'a BatInnerIO.output -> 'c t -> unit
val of_list : (Ord.t * 'a) list -> 'a t
val to_list : 'a t -> (Ord.t * 'a) list
include module type of struct include Exceptionless end
val find : key -> 'a t -> 'a option
val choose : 'a t -> (key * 'a) option
val any : 'a t -> (key * 'a) option