package containers

You can search for identifiers within the package.

in-package search v0.2.0

package containers

containers
- CCArray
  - S
  - Sub
- CCBool
- 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
  - List
  - Random
  - String
containers.bigarray
- CCArray1
  - Bool
  - Float
    
    Infix
  - Int
    
    Infix
  - S
    
    Infix
  - View
    
    Float
    
    Int
    
    S
- CCBigstring
containers.data
- 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
  - MONAD
  - MakeDecode
    
    M
- CCSexpStream
  - L
  - Lexer
  - ParseGen
  - Source
    
    Manual
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 'a t

A view on an array or part of an array

val of_array : ('a, _, [> `R ]) array_ -> 'a t

val get : 'a t -> int -> 'a

get v i returns the i-th element of v. Caution, this is not as cheap as a regular array indexing, and it might involve recursion.

raises Invalid_argument
if index out of bounds

val length : _ t -> int

length v is the number of elements of v

val map : f:('a -> 'b) -> 'a t -> 'b t

Map values

val map2 : f:('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t

Map values

raises WrongDimension
if lengths do not fit

val select : idx:(int, _, [> `R ]) array_ -> 'a t -> 'a t

select ~idx v is the view that has length length idx and such that get (select ~idx a) i = get a (get idx i)

val select_a : idx:int array -> 'a t -> 'a t

See select

val select_view : idx:int t -> 'a t -> 'a t

See select

val foldi : ('b -> int -> 'a -> 'b) -> 'b -> 'a t -> 'b

fold on values with their index

val iteri : f:(int -> 'a -> unit) -> 'a t -> unit

iteri ~f v iterates on elements of v with their index

module type S = sig ... end

module Int : sig ... end

module Float : sig ... end

val raw : 
  length:(('a, 'b, [> `R ]) array_ -> int) ->
  get:(('a, 'b, [> `R ]) array_ -> int -> 'a) ->
  ('a, 'b, [> `R ]) array_ ->
  'a t

val to_array : 
  ?res:('a, 'b, [> `W ] as 'perm) array_ ->
  ?kind:('a, 'b) Bigarray.kind ->
  'a t ->
  ('a, 'b, 'perm) array_

to_array v returns a fresh copy of the content of v. Exactly one of res and kind must be provided