package containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Copying functions

package containers

containers
- CCArray
  - MONO_ARRAY
- CCArrayLabels
  - MONO_ARRAY
- CCArray_slice
- CCBool
- CCChar
- CCEqual
  - Infix
- CCFloat
  - Infix
- CCFormat
  - Dump
- CCFun
  - Monad
    
    X
- CCHash
- CCHashtbl
  - Make
    
    X
  - Poly
  - S
- CCHeap
  - Make
    
    E
  - PARTIAL_ORD
  - S
- CCIO
  - File
- CCInt
  - Infix
- CCInt64
- CCList
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCListLabels
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCMap
  - Make
    
    O
  - S
- CCOpt
  - Infix
- CCOrd
  - Infix
- CCPair
- CCParse
  - Infix
  - U
- CCRandom
  - State
- CCRef
- CCResult
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSet
  - Make
    
    O
  - S
- CCString
  - Find
  - S
  - Split
  - Sub
- CCVector
- Containers
  - Hashtbl
    
    HashedType
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
containers.data
- CCBV
- CCBitField
  - Make
    
    X
  - S
- CCCache
- CCDeque
- CCFQueue
- CCGraph
  - Dot
  - Lazy_tree
  - MAP
  - Map
    
    O
  - Seq
  - Traverse
    
    Event
- CCHashSet
  - ELEMENT
  - Make
    
    E
  - S
- CCHashTrie
  - KEY
  - Make
    
    K
  - S
  - Transient
- 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
- CCSimple_queue
  - Infix
- CCTrie
  - Make
    
    W
  - MakeArray
    
    X
  - MakeList
    
    X
  - ORDERED
  - S
  - String
  - WORD
- CCWBTree
  - KEY
  - Make
    
    X
  - MakeFull
    
    X
  - ORD
  - S
- CCZipper
containers.iter
- CCKList
  - Infix
  - MONAD
  - Traverse
    
    M
- CCKTree
  - Dot
  - pset
- CCLazy_list
  - Infix
containers.monomorphic
- CCMonomorphic
containers.sexp
- CCSexp
  - Decoder
- CCSexp_lex
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

type drop_if_empty = {

first : bool;
last : bool;

}

Specification of what to do with empty blocks, as in split ~by:"-" "-a-b-".

{first=false; last=false} will return ""; "a"; "b"; "".
{first=true; last=false} will return "a"; "b" "".
{first=false; last=true} will return ""; "a"; "b".
{first=true; last=true} will return "a"; "b".

The default value of all remaining functions is Drop_none.

since 1.5

val no_drop : drop_if_empty

Do not drop any group, even empty and on borders.

since 1.5

val list_ : 
  ?drop:drop_if_empty ->
  by:string ->
  string ->
  (string * int * int) list

Split the given string along the given separator by. Should only be used with very small separators, otherwise use Containers_string.KMP.

returns
a list of slices (s,index,length) that are separated by by. String.sub can then be used to actually extract a string from the slice.

raises Failure
if by = "".

val gen : 
  ?drop:drop_if_empty ->
  by:string ->
  string ->
  (string * int * int) gen

val seq : 
  ?drop:drop_if_empty ->
  by:string ->
  string ->
  (string * int * int) sequence

val klist : 
  ?drop:drop_if_empty ->
  by:string ->
  string ->
  (string * int * int) klist

Copying functions

Those split functions actually copy the substrings, which can be more convenient but less efficient in general.

val list_cpy : ?drop:drop_if_empty -> by:string -> string -> string list

val gen_cpy : ?drop:drop_if_empty -> by:string -> string -> string gen

val seq_cpy : ?drop:drop_if_empty -> by:string -> string -> string sequence

val klist_cpy : ?drop:drop_if_empty -> by:string -> string -> string klist

val left : by:string -> string -> (string * string) option

Split on the first occurrence of by from the leftmost part of the string.

since 0.12

val left_exn : by:string -> string -> string * string

Split on the first occurrence of by from the leftmost part of the string.

raises Not_found
if by is not part of the string.

since 0.16

val right : by:string -> string -> (string * string) option

Split on the first occurrence of by from the rightmost part of the string.

since 0.12

val right_exn : by:string -> string -> string * string

Split on the first occurrence of by from the rightmost part of the string.

raises Not_found
if by is not part of the string.

since 0.16