base v0.10.0 · OCaml Package

val invariants : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> bool) Options.t

val is_empty : (_, _, _) T.t -> bool

val length : (_, _, _) T.t -> int

val add : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    key:'k Key.t ->
    data:'v ->
    ('k, 'v, 'cmp) T.t)
    Options.t

deprecated [since 2017-11] Use [set] instead

val set : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    key:'k Key.t ->
    data:'v ->
    ('k, 'v, 'cmp) T.t)
    Options.t

val add_multi : 
  ('k,
    'cmp,
    ('k, 'v list, 'cmp) T.t ->
    key:'k Key.t ->
    data:'v ->
    ('k, 'v list, 'cmp) T.t)
    Options.t

val remove_multi : 
  ('k, 'cmp, ('k, 'v list, 'cmp) T.t -> 'k Key.t -> ('k, 'v list, 'cmp) T.t)
    Options.t

val find_multi : 
  ('k, 'cmp, ('k, 'v list, 'cmp) T.t -> 'k Key.t -> 'v list) Options.t

val change : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    'k Key.t ->
    f:('v option -> 'v option) ->
    ('k, 'v, 'cmp) T.t)
    Options.t

val update : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    'k Key.t ->
    f:('v option -> 'v) ->
    ('k, 'v, 'cmp) T.t)
    Options.t

val find : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> 'k Key.t -> 'v option) Options.t

val find_exn : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> 'k Key.t -> 'v) Options.t

val remove : 
  ('k, 'cmp, ('k, 'v, 'cmp) T.t -> 'k Key.t -> ('k, 'v, 'cmp) T.t) Options.t

val mem : ('k, 'cmp, ('k, _, 'cmp) T.t -> 'k Key.t -> bool) Options.t

val iter_keys : ('k, _, _) T.t -> f:('k Key.t -> unit) -> unit

val iter : (_, 'v, _) T.t -> f:('v -> unit) -> unit

val iteri : ('k, 'v, _) T.t -> f:(key:'k Key.t -> data:'v -> unit) -> unit

val iter2 : 
  ('k,
    'cmp,
    ('k, 'v1, 'cmp) T.t ->
    ('k, 'v2, 'cmp) T.t ->
    f:
      (key:'k Key.t ->
        data:[ `Left of 'v1 | `Right of 'v2 | `Both of 'v1 * 'v2 ] ->
        unit) ->
    unit)
    Options.t

val map : ('k, 'v1, 'cmp) T.t -> f:('v1 -> 'v2) -> ('k, 'v2, 'cmp) T.t

val mapi : 
  ('k, 'v1, 'cmp) T.t ->
  f:(key:'k Key.t -> data:'v1 -> 'v2) ->
  ('k, 'v2, 'cmp) T.t

val fold : 
  ('k, 'v, _) T.t ->
  init:'a ->
  f:(key:'k Key.t -> data:'v -> 'a -> 'a) ->
  'a

val fold_right : 
  ('k, 'v, _) T.t ->
  init:'a ->
  f:(key:'k Key.t -> data:'v -> 'a -> 'a) ->
  'a

val fold2 : 
  ('k,
    'cmp,
    ('k, 'v1, 'cmp) T.t ->
    ('k, 'v2, 'cmp) T.t ->
    init:'a ->
    f:
      (key:'k Key.t ->
        data:[ `Left of 'v1 | `Right of 'v2 | `Both of 'v1 * 'v2 ] ->
        'a ->
        'a) ->
    'a)
    Options.t

val filter_keys : 
  ('k, 'cmp, ('k, 'v, 'cmp) T.t -> f:('k Key.t -> bool) -> ('k, 'v, 'cmp) T.t)
    Options.t

val filter : 
  ('k, 'cmp, ('k, 'v, 'cmp) T.t -> f:('v -> bool) -> ('k, 'v, 'cmp) T.t)
    Options.t

val filteri : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    f:(key:'k Key.t -> data:'v -> bool) ->
    ('k, 'v, 'cmp) T.t)
    Options.t

val filter_map : 
  ('k,
    'cmp,
    ('k, 'v1, 'cmp) T.t ->
    f:('v1 -> 'v2 option) ->
    ('k, 'v2, 'cmp) T.t)
    Options.t

val filter_mapi : 
  ('k,
    'cmp,
    ('k, 'v1, 'cmp) T.t ->
    f:(key:'k Key.t -> data:'v1 -> 'v2 option) ->
    ('k, 'v2, 'cmp) T.t)
    Options.t

val partition_mapi : 
  ('k,
    'cmp,
    ('k, 'v1, 'cmp) T.t ->
    f:(key:'k Key.t -> data:'v1 -> [ `Fst of 'v2 | `Snd of 'v3 ]) ->
    ('k, 'v2, 'cmp) T.t * ('k, 'v3, 'cmp) T.t)
    Options.t

val partition_map : 
  ('k,
    'cmp,
    ('k, 'v1, 'cmp) T.t ->
    f:('v1 -> [ `Fst of 'v2 | `Snd of 'v3 ]) ->
    ('k, 'v2, 'cmp) T.t * ('k, 'v3, 'cmp) T.t)
    Options.t

val partitioni_tf : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    f:(key:'k Key.t -> data:'v -> bool) ->
    ('k, 'v, 'cmp) T.t * ('k, 'v, 'cmp) T.t)
    Options.t

val partition_tf : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    f:('v -> bool) ->
    ('k, 'v, 'cmp) T.t * ('k, 'v, 'cmp) T.t)
    Options.t

val compare_direct : 
  ('k,
    'cmp,
    ('v -> 'v -> int) ->
    ('k, 'v, 'cmp) T.t ->
    ('k, 'v, 'cmp) T.t ->
    int)
    Options.t

val equal : 
  ('k,
    'cmp,
    ('v -> 'v -> bool) ->
    ('k, 'v, 'cmp) T.t ->
    ('k, 'v, 'cmp) T.t ->
    bool)
    Options.t

val keys : ('k, _, _) T.t -> 'k Key.t list

val data : (_, 'v, _) T.t -> 'v list

val to_alist : 
  ?key_order:[ `Increasing | `Decreasing ] ->
  ('k, 'v, _) T.t ->
  ('k Key.t * 'v) list

val validate : 
  name:('k Key.t -> string) ->
  'v Validate.check ->
  ('k, 'v, _) T.t Validate.check

val merge : 
  ('k,
    'cmp,
    ('k, 'v1, 'cmp) T.t ->
    ('k, 'v2, 'cmp) T.t ->
    f:
      (key:'k Key.t ->
        [ `Left of 'v1 | `Right of 'v2 | `Both of 'v1 * 'v2 ] ->
        'v3 option) ->
    ('k, 'v3, 'cmp) T.t)
    Options.t

val symmetric_diff : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    ('k, 'v, 'cmp) T.t ->
    data_equal:('v -> 'v -> bool) ->
    ('k Key.t, 'v) Symmetric_diff_element.t Sequence.t)
    Options.t

val min_elt : ('k, 'v, _) T.t -> ('k Key.t * 'v) option

val min_elt_exn : ('k, 'v, _) T.t -> 'k Key.t * 'v

val max_elt : ('k, 'v, _) T.t -> ('k Key.t * 'v) option

val max_elt_exn : ('k, 'v, _) T.t -> 'k Key.t * 'v

val for_all : ('k, 'v, _) T.t -> f:('v -> bool) -> bool

val for_alli : ('k, 'v, _) T.t -> f:(key:'k Key.t -> data:'v -> bool) -> bool

val exists : ('k, 'v, _) T.t -> f:('v -> bool) -> bool

val existsi : ('k, 'v, _) T.t -> f:(key:'k Key.t -> data:'v -> bool) -> bool

val count : ('k, 'v, _) T.t -> f:('v -> bool) -> int

val counti : ('k, 'v, _) T.t -> f:(key:'k Key.t -> data:'v -> bool) -> int

val split : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    'k Key.t ->
    ('k, 'v, 'cmp) T.t * ('k Key.t * 'v) option * ('k, 'v, 'cmp) T.t)
    Options.t

val append : 
  ('k,
    'cmp,
    lower_part:('k, 'v, 'cmp) T.t ->
    upper_part:('k, 'v, 'cmp) T.t ->
    [ `Ok of ('k, 'v, 'cmp) T.t | `Overlapping_key_ranges ])
    Options.t

val subrange : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    lower_bound:'k Key.t Maybe_bound.t ->
    upper_bound:'k Key.t Maybe_bound.t ->
    ('k, 'v, 'cmp) T.t)
    Options.t

val fold_range_inclusive : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    min:'k Key.t ->
    max:'k Key.t ->
    init:'a ->
    f:(key:'k Key.t -> data:'v -> 'a -> 'a) ->
    'a)
    Options.t

val range_to_alist : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    min:'k Key.t ->
    max:'k Key.t ->
    ('k Key.t * 'v) list)
    Options.t

val closest_key : 
  ('k,
    'cmp,
    ('k, 'v, 'cmp) T.t ->
    [ `Greater_or_equal_to | `Greater_than | `Less_or_equal_to | `Less_than ] ->
    'k Key.t ->
    ('k Key.t * 'v) option)
    Options.t

val nth : 
  ('k, 'cmp, ('k, 'v, 'cmp) T.t -> int -> ('k Key.t * 'v) option) Options.t

val nth_exn : ('k, 'cmp, ('k, 'v, 'cmp) T.t -> int -> 'k Key.t * 'v) Options.t

val rank : ('k, 'cmp, ('k, _, 'cmp) T.t -> 'k Key.t -> int option) Options.t

val to_tree : ('k, 'v, 'cmp) T.t -> ('k Key.t, 'v, 'cmp) Tree.t

val to_sequence : 
  ('k,
    'cmp,
    ?order:[ `Increasing_key | `Decreasing_key ] ->
    ?keys_greater_or_equal_to:'k Key.t ->
    ?keys_less_or_equal_to:'k Key.t ->
    ('k, 'v, 'cmp) T.t ->
    ('k Key.t * 'v) Sequence.t)
    Options.t

package base