dwww Home | Manual pages | Find package

MoreLabels.Hashtbl.HashedType(3o)OCaml librarMoreLabels.Hashtbl.HashedType(3o)

NAME
       MoreLabels.Hashtbl.HashedType  -  The  input  signature  of the functor
       MoreLabels.Hashtbl.Make.

Module type
       Module type   MoreLabels.Hashtbl.HashedType

Documentation
       Module type HashedType
        = sig end

       The input signature of the functor MoreLabels.Hashtbl.Make .

       type t

       The type of the hashtable keys.

       val equal : t -> t -> bool

       The equality predicate used to compare keys.

       val hash : t -> int

       A hashing function on keys. It must be such that if two keys are  equal
       according  to  equal , then they have identical hash values as computed
       by hash .  Examples: suitable ( equal , hash ) pairs for arbitrary  key
       types include

       -        ( (=) , MoreLabels.Hashtbl.HashedType.hash ) for comparing ob-
       jects by structure (provided objects do not contain floats)

       -        ( (fun x y -> compare x y =  0)  ,  MoreLabels.Hashtbl.Hashed-
       Type.hash  )  for  comparing objects by structure and handling nan cor-
       rectly

       -        ( (==) , MoreLabels.Hashtbl.HashedType.hash  )  for  comparing
       objects by physical equality (e.g. for mutable or cyclic objects).

OCamldoc                          2023-02-12 MoreLabels.Hashtbl.HashedType(3o)

Generated by dwww version 1.15 on Sun Jun 23 03:44:08 CEST 2024.