package containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Hash combinators

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

Hash combinators

Combination of hashes based on the Murmur Hash (64 bits). See this page

Definitions

type t = int

A hash value is a positive integer

type state = int64

State required by the hash function

type 'a hash_fun = 'a -> state -> state

Hash function for values of type 'a, merging a fingerprint of the value into the state of type t

Applying Murmur Hash

val init : state

Initial value

val finish : state -> int

Extract a usable hash value

val apply : 'a hash_fun -> 'a -> int

Apply a hash function to a value. apply f x is the same as finish (f x init)

Basic Combinators

Those combinators have been renamed in 0.13, so as to remove the trailing "_". They are now defined by the application of Make

val bool_ : bool hash_fun

deprecated
use bool

val char_ : char hash_fun

deprecated
use char

val int_ : int hash_fun

deprecated
use int

val string_ : string hash_fun

deprecated
use string

val int32_ : int32 hash_fun

deprecated
use int32

val int64_ : int64 hash_fun

deprecated
use int64

val nativeint_ : nativeint hash_fun

deprecated
use nativeint

val list_ : 'a hash_fun -> 'a list hash_fun

Hash a list. Each element is hashed using f.

deprecated
use list

val array_ : 'a hash_fun -> 'a array hash_fun

deprecated
use array

Iterators

type 'a sequence = ('a -> unit) -> unit

type 'a gen = unit -> 'a option

type 'a klist = unit -> [ `Nil | `Cons of 'a * 'a klist ]

Generic Hashing

Parametrize over the state, and some primitives to hash basic types. This can for instance be used for cryptographic hashing or checksums such as MD5.

since 0.13

module type HASH = sig ... end

module type S = sig ... end

module Make (H : HASH) : S with type state = H.state

include S with type state := state and type 'a hash_fun := 'a hash_fun

include HASH with type state := state

val int : int -> state -> state

val bool : bool -> state -> state

val char : char -> state -> state

val int32 : int32 -> state -> state

val int64 : int64 -> state -> state

val nativeint : nativeint -> state -> state

val slice : string -> int -> int -> state -> state

slice s i len state hashes the slice i, ... i+len-1 of s into state

val string : string hash_fun

val list : 'a hash_fun -> 'a list hash_fun

val array : 'a hash_fun -> 'a array hash_fun

val opt : 'a hash_fun -> 'a option hash_fun

val pair : 'a hash_fun -> 'b hash_fun -> ('a * 'b) hash_fun

val triple : 
  'a hash_fun ->
  'b hash_fun ->
  'c hash_fun ->
  ('a * 'b * 'c) hash_fun

val if_ : bool -> 'a hash_fun -> 'a hash_fun -> 'a hash_fun

Decide which hash function to use depending on the boolean

Iterators

val seq : 'a hash_fun -> 'a sequence hash_fun

val gen : 'a hash_fun -> 'a gen hash_fun

val klist : 'a hash_fun -> 'a klist hash_fun