Docs / API / Stdlib / Ordering

Ordering

t

RESCRIPT

type t = float

Ordering values represent the result of a comparison: less, equal, or greater.

less

RESCRIPT

let less: float

equal

RESCRIPT

let equal: float

greater

RESCRIPT

let greater: float

isLess

RESCRIPT

let isLess: float => bool

isLess(ordering) returns true when ordering equals Ordering.less.

Examples

RESCRIPT
Ordering.isLess(Ordering.less) == true
Ordering.isLess(Ordering.equal) == false

isEqual

RESCRIPT

let isEqual: float => bool

isEqual(ordering) returns true when ordering equals Ordering.equal.

Examples

RESCRIPT
Ordering.isEqual(Ordering.equal) == true
Ordering.isEqual(Ordering.greater) == false

isGreater

RESCRIPT

let isGreater: float => bool

isGreater(ordering) returns true when ordering equals Ordering.greater.

Examples

RESCRIPT
Ordering.isGreater(Ordering.greater) == true
Ordering.isGreater(Ordering.less) == false

invert

RESCRIPT

let invert: float => float

invert(ordering) flips the ordering result (less becomes greater and vice versa).

Examples

RESCRIPT
Ordering.invert(Ordering.less) == Ordering.greater
Ordering.invert(Ordering.equal) == Ordering.equal

fromInt

RESCRIPT

let fromInt: int => float

fromInt(n) converts an integer comparison result into an ordering.

Examples

RESCRIPT
Ordering.fromInt(-5) == Ordering.less
Ordering.fromInt(0) == Ordering.equal
Ordering.fromInt(3) == Ordering.greater

ignore

RESCRIPT

let ignore: t => unit

ignore(ordering) ignores the provided ordering and returns unit.

This helper is useful when you want to discard a value (for example, the result of an operation with side effects) without having to store or process it further.