package containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Basic Functions
1. Monad

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

Basic Functions

val (|>) : 'a -> ('a -> 'b) -> 'b

Pipeline. x |> f is the same as f x.

val compose : ('a -> 'b) -> ('b -> 'c) -> 'a -> 'c

Composition

val compose_binop : ('a -> 'b) -> ('b -> 'b -> 'c) -> 'a -> 'a -> 'c

compose_binop f g is fun x y -> g (f x) (f y) Example (partial order): List.sort (compose_binop fst CCInt.compare) [1, true; 2, false; 1, false]

since 0.6

val (%>) : ('a -> 'b) -> ('b -> 'c) -> 'a -> 'c

Alias to compose

val (@@) : ('a -> 'b) -> 'a -> 'b

f @@ x is the same as f x, but right-associative.

since 0.5

val id : 'a -> 'a

Identity function

val const : 'a -> 'b -> 'a

const x y = x for any y

val flip : ('a -> 'b -> 'c) -> 'b -> 'a -> 'c

Flip arguments

val curry : (('a * 'b) -> 'c) -> 'a -> 'b -> 'c

val uncurry : ('a -> 'b -> 'c) -> ('a * 'b) -> 'c

val tap : ('a -> 'b) -> 'a -> 'a

tap f x evaluates f x, discards it, then returns x. Useful in a pipeline, for instance:

CCArray.(1 -- 10)
|> tap CCArray.shuffle
|> tap CCArray.sort Pervasives.compare

val (%) : ('b -> 'c) -> ('a -> 'b) -> 'a -> 'c

Mathematical composition

val lexicographic : ('a -> 'a -> int) -> ('a -> 'a -> int) -> 'a -> 'a -> int

Lexicographic combination of comparison functions

val finally : h:(unit -> unit) -> f:(unit -> 'a) -> 'a

finally h f calls f () and returns its result. If it raises, the same exception is raised; in any case, h () is called after f () terminates.

Monad

Functions with a fixed domain are monads in their codomain

module Monad (X : sig ... end) : sig ... end