package base

  1. Overview
  2. Docs
Full standard library replacement for OCaml

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (19)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

base-v0.14.0.tar.gz
sha256=e89c4b898d9e93527f1c84f6784f9a92a1dfa86877f39ac4450a6cb69e866de6
md5=5a00382c724e97b6768aaa27481dd3cc

doc/base/Base/Ordering/index.html

Module Base.Ordering

Ordering is intended to make code that matches on the result of a comparison more concise and easier to read.

For example, instead of writing:

  let r = compare x y in
  if r < 0 then
    ...
  else if r = 0 then
    ...
  else
    ...

you could simply write:

  match Ordering.of_int (compare x y) with
  | Less -> ...
  | Equal -> ...
  | Greater -> ...
type t =
  1. | Less
  2. | Equal
  3. | Greater
val compare : t -> t -> int
val all : t list
val hash_fold_t : Hash.state -> t -> Hash.state
val hash : t -> Hash.hash_value
include Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Equal.S with type t := t
val equal : t Equal.equal
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