package containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package containers

containers
- CCArray
  - S
  - Sub
- CCBool
- CCError
  - MONAD
  - Traverse
    
    M
- CCFloat
- CCFormat
- CCFun
  - Monad
    
    X
- CCHash
- CCHashtbl
  - COUNTER
  - DEFAULT
  - Make
    
    X
  - MakeCounter
    
    X
  - MakeDefault
    
    X
  - S
- CCHeap
  - Make
    
    E
  - PARTIAL_ORD
  - S
- CCInt
- 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
- CCBigstring
containers.data
- CCBV
- CCCache
- CCDeque
- CCFQueue
- CCFlatHashtbl
  - HASHABLE
  - Make
    
    X
  - 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
- 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
containers.io
- CCIO
  - File
containers.iter
- CCKList
  - MONAD
  - Traverse
    
    M
- CCKTree
  - Dot
  - pset
containers.misc
- Containers_misc
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
  - U
- Containers_string
containers.thread
- CCFuture
  - Infix
  - Timer
- CCLock
containers.unix
- CCUnix
  - Infix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Buffer using regular arrays

Parameters

module X : sig ... end

Signature

module Array : Array.S with type elt = X.t

The module type of Array for this ring buffer

type t

Defines the ring buffer type, with both bounded and unbounded flavors

exception Empty

Raised in querying functions when the buffer is empty

val create : ?bounded:bool -> int -> t

create ?bounded size creates a new buffer with given size. Defaults to bounded=false.

val copy : t -> t

Make a fresh copy of the buffer.

val capacity : t -> int

Length of the inner buffer.

val max_capacity : t -> int option

Maximum length of the inner buffer, or None if unbounded.

val length : t -> int

Number of elements currently stored in the buffer.

val blit_from : t -> Array.t -> int -> int -> unit

blit_from buf from_buf o len copies the slice o, ... o + len - 1 from a input buffer from_buf to the end of the buffer.

raises Invalid_argument
if o,len is not a valid slice of s

val blit_into : t -> Array.t -> int -> int -> int

blit_into buf to_buf o len copies at most len elements from buf into to_buf starting at offset o in s.

returns
the number of elements actually copied (min len (length buf)).

raises Invalid_argument
if o,len is not a valid slice of s

val append : t -> into:t -> unit

append b ~into copies all data from b and adds it at the end of into

val to_list : t -> Array.elt list

Extract the current content into a list

val clear : t -> unit

Clear the content of the buffer. Doesn't actually destroy the content.

val reset : t -> unit

Clear the content of the buffer, and also resize it to a default size

val is_empty : t -> bool

Is the buffer empty (i.e. contains no elements)?

val junk_front : t -> unit

Drop the front element from t.

raises Empty
if the buffer is already empty.

val junk_back : t -> unit

Drop the back element from t.

raises Empty
if the buffer is already empty.

val skip : t -> int -> unit

skip b len removes len elements from the front of b.

raises Invalid_argument
if len > length b.

val iter : t -> f:(Array.elt -> unit) -> unit

iter b ~f calls f i t for each element t in buf

val iteri : t -> f:(int -> Array.elt -> unit) -> unit

iteri b ~f calls f i t for each element t in buf, with i being its relative index within buf.

val get_front : t -> int -> Array.elt

get_front buf i returns the i-th element of buf from the front, ie the one returned by take_front buf after i-1 calls to junk_front buf.

raises Invalid_argument
if the index is invalid (> length buf)

val get_back : t -> int -> Array.elt

get_back buf i returns the i-th element of buf from the back, ie the one returned by take_back buf after i-1 calls to junk_back buf.

raises Invalid_argument
if the index is invalid (> length buf)

val push_back : t -> Array.elt -> unit

Push value at the back of t. If t.bounded=false, the buffer will grow as needed, otherwise the oldest elements are replaced first.

val peek_front : t -> Array.elt

First value from front of t.

raises Empty
if buffer is empty.

val peek_back : t -> Array.elt

Get the last value from back of t.

raises Empty
if buffer is empty.

val take_back : t -> Array.elt option

Take the last value from back of t, if any

val take_back_exn : t -> Array.elt

Take the last value from back of t.

raises Empty
if buffer is already empty.

val take_front : t -> Array.elt option

Take the first value from front of t, if any

val take_front_exn : t -> Array.elt

Take the first value from front of t.

raises Empty
if buffer is already empty.

val of_array : Array.t -> t

Create a buffer from an initial array, but doesn't take ownership of it (stills allocates a new internal array)

val to_array : t -> Array.t

Create an array from the elements, in order.

since 0.11