package containers

You can search for identifiers within the package.

in-package search v0.2.0

containers
- CCArray
- CCArrayLabels
- CCAtomic
- CCBool
- CCByte_buffer
- CCByte_slice
- CCCanonical_sexp
  - Make
    
    Sexp
- CCChar
  - Infix
- CCEither
- CCEqual
  - Infix
- CCEqualLabels
  - Infix
- CCFloat
  - Infix
- CCFormat
  - ANSI_codes
  - Dump
  - Infix
- CCFun
  - Infix
  - Monad
    
    X
- CCHash
- CCHashtbl
  - Make
  - Poly
  - S
- CCHeap
  - Make
    
    E
  - Make_from_compare
    
    E
  - PARTIAL_ORD
  - S
  - TOTAL_ORD
- CCIO
  - File
- CCInt
  - Infix
- CCInt32
  - Infix
- CCInt64
  - Infix
- CCList
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCListLabels
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCMap
  - Make
  - S
- CCNativeint
  - Infix
- CCOpt
  - Infix
- CCOption
  - Infix
- CCOrd
  - Infix
- CCPair
- CCParse
  - Debug_
  - Error
  - Infix
  - Position
  - Slice
  - U
- CCRandom
- CCRef
- CCResult
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSeq
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSet
  - Make
  - S
- CCSexp
  - Decoder
  - Make
    
    Decoder
    
    Sexp
- CCSexp_intf
  - BASIC_SEXP
  - S
    
    Decoder
  - S0
  - SEXP
- CCSexp_lex
- CCString
  - Find
  - Infix
  - Split
- CCStringLabels
  - Find
  - Infix
  - Split
- CCUnit
- CCUtf8_string
- CCVector
- Containers
  - Hashtbl
    
    HashedType
    
    Make
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
- ContainersLabels
  - Hashtbl
    
    HashedType
    
    Make
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
containers.bencode
- Containers_bencode
  - Decode
  - Encode
  - Str_map
containers.cbor
- Containers_cbor
containers.codegen
- Containers_codegen
  - Bitfield
  - Code
containers.monomorphic
- CCMonomorphic
containers.pp
- Containers_pp
  - Char
  - Dump
  - Ext
  - Flatten
  - Infix
  - Out
  - Pretty
  - Term_color
containers.pvec
- Containers_pvec
containers.scc
- Containers_scc
  - ARG
  - Make
    
    A
  - S
    
    A
containers.top
- Containers_top
containers.unix
- CCUnix
  - Infix

Legend:
Library
Module
Module type
Parameter
Class
Class type

since 0.14

include module type of Stdlib.Hashtbl
  with type statistics = Stdlib.Hashtbl.statistics
   and module Make = Stdlib.Hashtbl.Make
   and type ('a, 'b) t = ('a, 'b) Stdlib.Hashtbl.t

type (!'a, !'b) t = ('a, 'b) Stdlib.Hashtbl.t

val create : ?random:bool -> int -> ('a, 'b) t

val clear : ('a, 'b) t -> unit

val reset : ('a, 'b) t -> unit

val copy : ('a, 'b) t -> ('a, 'b) t

val add : ('a, 'b) t -> 'a -> 'b -> unit

val find : ('a, 'b) t -> 'a -> 'b

val find_opt : ('a, 'b) t -> 'a -> 'b option

val find_all : ('a, 'b) t -> 'a -> 'b list

val mem : ('a, 'b) t -> 'a -> bool

val remove : ('a, 'b) t -> 'a -> unit

val replace : ('a, 'b) t -> 'a -> 'b -> unit

val iter : ('a -> 'b -> unit) -> ('a, 'b) t -> unit

val filter_map_inplace : ('a -> 'b -> 'b option) -> ('a, 'b) t -> unit

val fold : ('a -> 'b -> 'acc -> 'acc) -> ('a, 'b) t -> 'acc -> 'acc

val length : ('a, 'b) t -> int

val randomize : unit -> unit

val is_randomized : unit -> bool

val rebuild : ?random:bool -> ('a, 'b) t -> ('a, 'b) t

type statistics = Stdlib.Hashtbl.statistics = {

num_bindings : int;
num_buckets : int;
max_bucket_length : int;
bucket_histogram : int array;

}

val stats : ('a, 'b) t -> statistics

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

val to_seq_keys : ('a, 'b) t -> 'a Stdlib.Seq.t

val to_seq_values : ('a, 'b) t -> 'b Stdlib.Seq.t

val replace_seq : ('a, 'b) t -> ('a * 'b) Stdlib.Seq.t -> unit

module type HashedType = sig ... end

module type S = sig ... end

module Make (H : sig ... end) : sig ... end

module type SeededHashedType = sig ... end

module type SeededS = sig ... end

module MakeSeeded (H : SeededHashedType) : sig ... end

val hash : 'a -> int

val seeded_hash : int -> 'a -> int

val hash_param : int -> int -> 'a -> int

val seeded_hash_param : int -> int -> int -> 'a -> int

include module type of struct include CCHashtbl.Poly end

val get : ('a, 'b) Stdlib.Hashtbl.t -> 'a -> 'b option

get tbl k finds a binding for the key k if present, or returns None if no value is found. Safe version of Hashtbl.find.

val get_or : ('a, 'b) Stdlib.Hashtbl.t -> 'a -> default:'b -> 'b

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

since 0.16

val keys : ('a, 'b) Stdlib.Hashtbl.t -> 'a CCHashtbl.iter

keys tbl f iterates on keys (similar order as Hashtbl.iter).

val values : ('a, 'b) Stdlib.Hashtbl.t -> 'b CCHashtbl.iter

values tbl f iterates on values in the table tbl.

val keys_list : ('a, 'b) Stdlib.Hashtbl.t -> 'a list

keys_list tbl is the list of keys in tbl. If the key is in the Hashtable multiple times, all occurrences will be returned.

since 0.8

val values_list : ('a, 'b) Stdlib.Hashtbl.t -> 'b list

values_list tbl is the list of values in tbl.

since 0.8

val map_list : ('a -> 'b -> 'c) -> ('a, 'b) Stdlib.Hashtbl.t -> 'c list

map_list f tbl maps on a tbl's items. Collect into a list.

val incr : ?by:int -> ('a, int) Stdlib.Hashtbl.t -> 'a -> unit

incr ?by tbl x increments or initializes the counter associated with x. If get tbl x = None, then after update, get tbl x = Some 1; otherwise, if get tbl x = Some n, now get tbl x = Some (n+1).

parameter by
if specified, the int value is incremented by by rather than 1.

since 0.16

val decr : ?by:int -> ('a, int) Stdlib.Hashtbl.t -> 'a -> unit

decr ?by tbl x is like incr but subtract 1 (or the value of by). If the value reaches 0, the key is removed from the table. This does nothing if the key is not already present in the table.

since 0.16

val to_iter : ('a, 'b) Stdlib.Hashtbl.t -> ('a * 'b) CCHashtbl.iter

Iterate on bindings in the table.

since 2.8

val add_list : ('a, 'b list) Stdlib.Hashtbl.t -> 'a -> 'b -> unit

add_list tbl x y adds y to the list x is bound to. If x is not bound, it becomes bound to y.

since 0.16

val add_iter : ('a, 'b) Stdlib.Hashtbl.t -> ('a * 'b) CCHashtbl.iter -> unit

Add the corresponding pairs to the table, using Hashtbl.add.

since 2.8

val add_iter_with : 
  f:('a -> 'b -> 'b -> 'b) ->
  ('a, 'b) Stdlib.Hashtbl.t ->
  ('a * 'b) CCHashtbl.iter ->
  unit

Add the corresponding pairs to the table, using Hashtbl.add. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

since 3.3

val add_seq : ('a, 'b) Stdlib.Hashtbl.t -> ('a * 'b) Stdlib.Seq.t -> unit

Add the corresponding pairs to the table, using Hashtbl.add. Renamed from add_std_seq since 3.0.

since 3.0

val add_seq_with : 
  f:('a -> 'b -> 'b -> 'b) ->
  ('a, 'b) Stdlib.Hashtbl.t ->
  ('a * 'b) Stdlib.Seq.t ->
  unit

Add the corresponding pairs to the table. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

since 3.3

val of_iter : ('a * 'b) CCHashtbl.iter -> ('a, 'b) Stdlib.Hashtbl.t

From the given bindings, added in order.

since 2.8

val of_iter_with : 
  f:('a -> 'b -> 'b -> 'b) ->
  ('a * 'b) CCHashtbl.iter ->
  ('a, 'b) Stdlib.Hashtbl.t

From the given bindings, added in order. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

since 3.3

val of_seq : ('a * 'b) Stdlib.Seq.t -> ('a, 'b) Stdlib.Hashtbl.t

From the given bindings, added in order. Renamed from of_std_seq since 3.0.

since 3.0

val of_seq_with : 
  f:('a -> 'b -> 'b -> 'b) ->
  ('a * 'b) Stdlib.Seq.t ->
  ('a, 'b) Stdlib.Hashtbl.t

From the given bindings, added in order. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

since 3.3

val add_iter_count : ('a, int) Stdlib.Hashtbl.t -> 'a CCHashtbl.iter -> unit

add_iter_count tbl i increments the count of each element of i by calling incr. This is useful for counting how many times each element of i occurs.

since 2.8

val add_seq_count : ('a, int) Stdlib.Hashtbl.t -> 'a Stdlib.Seq.t -> unit

add_seq_count tbl seq increments the count of each element of seq by calling incr. This is useful for counting how many times each element of seq occurs. Renamed from add_std_seq_count since 3.0.

since 3.0

val of_iter_count : 'a CCHashtbl.iter -> ('a, int) Stdlib.Hashtbl.t

Like add_seq_count, but allocates a new table and returns it.

since 2.8

val of_seq_count : 'a Stdlib.Seq.t -> ('a, int) Stdlib.Hashtbl.t

Like add_seq_count, but allocates a new table and returns it. Renamed from of_std_seq_count since 3.0.

since 3.0

val to_list : ('a, 'b) Stdlib.Hashtbl.t -> ('a * 'b) list

to_list tbl returns the list of (key,value) bindings (order unspecified).

val of_list : ('a * 'b) list -> ('a, 'b) Stdlib.Hashtbl.t

of_list l builds a table from the given list l of bindings k_i -> v_i, added in order using add. If a key occurs several times, it will be added several times, and the visible binding will be the last one.

val of_list_with : 
  f:('a -> 'b -> 'b -> 'b) ->
  ('a * 'b) list ->
  ('a, 'b) Stdlib.Hashtbl.t

From the given bindings, added in order. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

since 3.3

val update : 
  ('a, 'b) Stdlib.Hashtbl.t ->
  f:('a -> 'b option -> 'b option) ->
  k:'a ->
  unit

update tbl ~f ~k updates key k by calling f k (Some v) if k was mapped to v, or f k None otherwise; if the call returns None then k is removed/stays removed, if the call returns Some v' then the binding k -> v' is inserted using Hashtbl.replace.

since 0.14

val get_or_add : ('a, 'b) Stdlib.Hashtbl.t -> f:('a -> 'b) -> k:'a -> 'b

get_or_add tbl ~k ~f finds and returns the binding of k in tbl, if it exists. If it does not exist, then f k is called to obtain a new binding v; k -> v is added to tbl and v is returned.

since 1.0

val pp : 
  ?pp_start:unit CCHashtbl.printer ->
  ?pp_stop:unit CCHashtbl.printer ->
  ?pp_sep:unit CCHashtbl.printer ->
  ?pp_arrow:unit CCHashtbl.printer ->
  'a CCHashtbl.printer ->
  'b CCHashtbl.printer ->
  ('a, 'b) Stdlib.Hashtbl.t CCHashtbl.printer

pp ~pp_start ~pp_stop ~pp_sep ~pp arrow pp_k pp_v returns a table printer given a pp_k printer for individual key and a pp_v printer for individual value. pp_start and pp_stop control the opening and closing delimiters, by default print nothing. pp_sep control the separator between binding. pp_arrow control the arrow between the key and value. Renamed from print since 2.0.

since 0.13

module type S' = CCHashtbl.S

module Make' = CCHashtbl.Make