OCaml library : MoreLabels.Map.OrderedType (original) (raw)

OCaml

API Version 5.3

< General Index

OCaml library : MoreLabels.Map.OrderedType

Module type MoreLabels.Map.OrderedType

module type OrderedType = sig .. end

Input signature of the functor MoreLabels.Map.Make.


type ``t

The type of the map keys.

val compare : [t](MoreLabels.Map.OrderedType.html#TYPEt) -> [t](MoreLabels.Map.OrderedType.html#TYPEt) -> int

A total ordering function over the keys. This is a two-argument function f such thatf e1 e2 is zero if the keys e1 and e2 are equal,f e1 e2 is strictly negative if e1 is smaller than e2, and f e1 e2 is strictly positive if e1 is greater than e2. Example: a suitable ordering function is the generic structural comparison function compare.