Up

Module Ordering = Core_kernel.Ordering

Signature

type t =
| Less
| Equal
| Greater
val t_of_sexp : Sexplib.Sexp.t -> t
val sexp_of_t : t -> Sexplib.Sexp.t
val compare : t -> t -> int
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_writer_t : t Bin_prot.Type_class.writer
val of_int : int -> t

of_int n is:

      Less     if n < 0
      Equal    if n = 0
      Greater  if n > 0
    
val to_int : t -> int

to_int t is:

      Less     -> -1
      Equal    -> 0
      Greater  -> 1
    

It can be useful when writing a comparison function to allow one to return Ordering.t values and transform them to ints later.

module Export : sig .. end