package containers

You can search for identifiers within the package.

in-package search v0.2.0

package containers

containers
- CCArray
  - MONO_ARRAY
  - S
  - Sub
- CCBool
- CCChar
- CCError
  - Infix
  - MONAD
  - Traverse
    
    M
- CCFloat
- CCFormat
- 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
- CCInt64
- CCList
  - Assoc
  - Idx
  - MONAD
  - Ref
  - Set
  - Traverse
    
    M
  - Zipper
- CCMap
  - Make
    
    O
  - S
- CCOpt
- CCOrd
- CCPair
- CCPrint
  - MONAD_IO
  - MakeIO
    
    M
- CCRandom
- CCRef
- CCSet
  - Make
    
    O
  - S
- CCString
  - S
  - Split
  - Sub
- CCVector
- Containers
  - Array
  - 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
- 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
  - MONAD
  - Traverse
    
    M
- CCKTree
  - Dot
  - pset
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
- CCFuture
  - Infix
  - Timer
- CCLock
  - LockRef
- CCSemaphore
- CCThread
  - Arr
  - Barrier
  - Queue
containers.top
- CCKList
  - MONAD
  - Traverse
    
    M
- CCVector
- Containers_top
containers.unix
- CCUnix
  - Infix

Legend:
Library
Module
Module type
Parameter
Class
Class type

type key

type +'a t

val empty : 'a t

val is_empty : _ t -> bool

val singleton : key -> 'a -> '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 the key is not present

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

nth i m returns the i-th key, value in the ascending order. Complexity is O(log (cardinal m))

val nth_exn : int -> 'a t -> key * 'a

raises Not_found
if the index is invalid

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

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

val update : key -> ('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 cardinal : _ t -> int

val weight : _ t -> int

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

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

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

split k t returns l, o, r where l is the part of the map with keys smaller than k, r has keys bigger than k, and o = Some v if k, v belonged to the map

val merge : 
  f:(key -> 'a option -> 'b option -> 'c option) ->
  'a t ->
  'b t ->
  'c t

Similar to Map.S.merge

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

extract_min m returns k, v, m' where k,v is the pair with the smallest key in m, and m' does not contain k.

raises Not_found
if the map is empty

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

extract_max m returns k, v, m' where k,v is the pair with the highest key in m, and m' does not contain k.

raises Not_found
if the map is empty

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

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

raises Not_found
if the tree is empty

val random_choose : Random.State.t -> 'a t -> key * 'a

Randomly choose a (key,value) pair within the tree, using weights as probability weights

raises Not_found
if the tree is empty

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

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

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

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

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 of_gen : (key * 'a) gen -> 'a t

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

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