package index

  1. Overview
  2. Docs
A platform-agnostic multi-level index for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (16)

Authors

  1. C
    Craig Ferguson <craig@tarides.com>
  2. T
    Thomas Gazagnaire <thomas@tarides.com>
  3. I
    Ioana Cristescu <ioana@tarides.com>
  4. C
    Clément Pascutto <clement@tarides.com>

Maintainers

  1. C
    Clement Pascutto

Sources

index-1.1.0.tbz
sha256=a2966d8aa7d318daea3474ca53c6f0239759ca5c966d36e084758adc49eadfef
sha512=45cff0b3665ca375dfc329faad3a598fe306e47a715ce0abf7842fd119af20591d1568b9c8779ff1a382ed089bdbdf167bf5712ae8da7d86cac9afaebafb8324

doc/index.unix/Index_unix/Make/argument-1-K/index.html

Parameter Make.K

type t

The type for keys.

val equal : t -> t -> bool

The equality function for keys.

val hash : t -> int

Note: Unevenly distributed hash functions may result in performance drops.

val hash_size : int

The number of bits necessary to encode the maximum output value of hash. `Hashtbl.hash` uses 30 bits.

Overestimating the hash_size will result in performance drops; underestimation will result in undefined behavior.

val encode : t -> string

encode is an encoding function. The resultant encoded values must have size encoded_size.

val encoded_size : int

encoded_size is the size of the result of encode, expressed in number of bytes.

val decode : string -> int -> t

decode s off is the decoded form of the encoded value at the offset off of string s. Must satisfy decode (encode t) 0 = t.

val pp : t Fmt.t

Formatter for keys