package containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Signature
1. Conversions
2. IO

package containers

containers
- CCArray
  - MONO_ARRAY
  - S
  - Sub
- CCBool
- CCChar
- CCError
  - Infix
  - MONAD
  - Traverse
    
    M
- CCFloat
  - Infix
- CCFormat
  - Dump
- CCFun
  - Monad
    
    X
- CCHash
  - HASH
  - Make
    
    H
  - S
- CCHashtbl
  - COUNTER
  - DEFAULT
  - Make
    
    X
  - MakeCounter
    
    X
  - MakeDefault
    
    X
  - S
- CCHeap
  - Make
    
    E
  - PARTIAL_ORD
  - S
- CCIO
  - File
- CCInt
  - Infix
- CCInt64
- CCList
  - Assoc
  - Idx
  - Infix
  - MONAD
  - Ref
  - Set
  - Traverse
    
    M
  - Zipper
- CCMap
  - Make
    
    O
  - S
- CCOpt
  - Infix
- CCOrd
- CCPair
- CCPrint
  - MONAD_IO
  - MakeIO
    
    M
- CCRandom
- CCRef
- CCResult
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSet
  - Make
    
    O
  - S
- CCString
  - S
  - Split
  - Sub
- CCVector
- Containers
  - Array
  - Char
  - Format
  - Hashtbl
    
    HashedType
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
  - List
  - Map
  - Random
  - Set
  - String
containers.bigarray
- CCArray1
  - Bool
  - Float
    
    Infix
  - Int
    
    Infix
  - S
    
    Infix
  - View
    
    Float
    
    Int
    
    S
- CCBigstring
containers.data
- CCAllocCache
  - Arr
- CCBV
- CCBitField
  - EMPTY
  - Make
    
    FIELD
    
    X
  - S
    
    FIELD
- CCBloom
- CCCache
- CCDeque
- CCFQueue
- CCFlatHashtbl
  - HASHABLE
  - Make
    
    X
  - S
- CCGraph
  - Dot
  - LazyTree
  - MAP
  - Map
    
    O
  - Seq
  - Traverse
    
    Event
- CCHashSet
  - ELEMENT
  - Make
    
    E
  - S
- CCHashTrie
  - KEY
  - Make
    
    K
  - S
  - Transient
- CCHashconsedSet
  - ELT
  - Make
    
    E
  - S
- CCHet
  - Key
  - Map
  - Tbl
- CCImmutArray
- CCIntMap
- CCMixmap
  - Make
    
    X
  - ORD
  - S
- CCMixset
- CCMixtbl
- CCMultiMap
  - BIDIR
  - Make
    
    K
    
    V
  - MakeBidir
    
    L
    
    R
  - OrderedType
  - S
- CCMultiSet
  - Make
    
    O
  - S
- CCPersistentArray
- CCPersistentHashtbl
  - HashedType
  - Make
    
    H
  - S
- CCRAL
  - Infix
- CCRingBuffer
  - Array
    
    Byte
    
    Make
    
    Elt
    
    S
  - Byte
  - Make
    
    Array
    
    X
  - MakeFromArray
    
    A
  - S
    
    Array
- CCTrie
  - Make
    
    W
  - MakeArray
    
    X
  - MakeList
    
    X
  - ORDERED
  - S
  - String
  - WORD
- CCWBTree
  - KEY
  - Make
    
    X
  - MakeFull
    
    X
  - ORD
  - S
containers.io
- Containers_io_is_deprecated
containers.iter
- CCKList
  - Infix
  - MONAD
  - Traverse
    
    M
- CCKTree
  - Dot
  - pset
- CCLazy_list
  - Infix
containers.sexp
- CCSexp
  - Traverse
- CCSexpM
  - D
  - ID_MONAD
  - MONAD
  - MakeDecode
    
    M
containers.string
- CCApp_parse
  - Chan
  - INPUT
  - Infix
  - Make
    
    I
  - MakeFromReader
    
    R
  - READER
  - S
  - Str
- CCKMP
  - Make
    
    Str
  - S
  - STRING
- CCLevenshtein
  - Index
  - Make
    
    Index
    
    Str
  - S
    
    Index
  - STRING
- CCParse
  - MemoTbl
  - U
- Containers_string
containers.thread
- CCBlockingQueue
- CCLock
  - LockRef
- CCPool
  - Make
    
    Fut
    
    Infix
    
    P
  - PARAM
- CCSemaphore
- CCThread
  - Arr
  - Barrier
- CCTimer
containers.top
- Containers_top
containers.unix
- CCUnix
  - Infix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Signature

type key

type 'a t

val empty : 'a t

val is_empty : _ t -> bool

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

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

val mem : key -> _ t -> bool

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

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

raises Not_found
if key not present

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

Remove the key, if present.

val update : key -> f:('a option -> 'a option) -> 'a t -> 'a t

update k ~f m calls f (Some v) if get k m = Some v, f None otherwise. Then, if f returns Some v' it binds k to v', if f returns None it removes k

val add_mut : id:Transient.t -> key -> 'a -> 'a t -> 'a t

add_mut ~id k v m behaves like add k v m, except it will mutate in place whenever possible. Changes done with an id might affect all versions of the structure obtained with the same id (but not other versions).

raises Transient.Frozen
if id is frozen

val remove_mut : id:Transient.t -> key -> 'a t -> 'a t

Same as remove, but modifies in place whenever possible

raises Transient.Frozen
if id is frozen

val update_mut : 
  id:Transient.t ->
  key ->
  f:('a option -> 'a option) ->
  'a t ->
  'a t

Same as update but with mutability

raises Transient.Frozen
if id is frozen

val cardinal : _ t -> int

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

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

raises Not_found
if not pair was found

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

val fold : f:('b -> key -> 'a -> 'b) -> x:'b -> 'a t -> 'b

Conversions

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

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

val add_list_mut : id:Transient.t -> 'a t -> (key * 'a) list -> 'a t

raises Frozen
if the ID is frozen

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

val add_seq : 'a t -> (key * 'a) sequence -> 'a t

val add_seq_mut : id:Transient.t -> 'a t -> (key * 'a) sequence -> 'a t

raises Frozen
if the ID is frozen

val of_seq : (key * 'a) sequence -> 'a t

val to_seq : 'a t -> (key * 'a) sequence

val add_gen : 'a t -> (key * 'a) gen -> 'a t

val add_gen_mut : id:Transient.t -> 'a t -> (key * 'a) gen -> 'a t

raises Frozen
if the ID is frozen

val of_gen : (key * 'a) gen -> 'a t

val to_gen : 'a t -> (key * 'a) gen

IO

val print : key printer -> 'a printer -> 'a t printer

val as_tree : 'a t -> [ `L of int * (key * 'a) list | `N ] ktree

For debugging purpose: explore the structure of the tree, with `L (h,l) being a leaf (with shared hash h) and `N an inner node