refactor: use Ordering for compare and sort functions

Author: glennsl

src/Core__Array.mjs

@@ -3,6 +3,7 @@
 import * as Curry from "rescript/lib/es6/curry.js";
 import * as Js_math from "rescript/lib/es6/js_math.js";
 import * as Caml_option from "rescript/lib/es6/caml_option.js";
+import * as Core__Ordering from "./Core__Ordering.mjs";
 
 function make(length, x) {
   if (length <= 0) {
@@ -47,19 +48,19 @@ function equal(a, b, eq) {
 function compare(a, b, cmp) {
   var lenA = a.length;
   var lenB = b.length;
-  if (lenA > lenB) {
-    return 1;
-  } else if (lenA < lenB) {
-    return -1;
+  if (lenA < lenB) {
+    return Core__Ordering.less;
+  } else if (lenA > lenB) {
+    return Core__Ordering.greater;
   } else {
     var _i = 0;
     while(true) {
       var i = _i;
       if (i === lenA) {
-        return 0;
+        return Core__Ordering.equal;
       }
       var c = Curry._2(cmp, a[i], b[i]);
-      if (c !== 0) {
+      if (!Core__Ordering.isEqual(c)) {
         return c;
       }
       _i = i + 1 | 0;

src/Core__Array.res

@@ -57,10 +57,10 @@ let equal = (a, b, eq) => {
 
 let rec compareFromIndex = (a, b, i, cmp, len) =>
   if i === len {
-    0.
+    Core__Ordering.equal
   } else {
     let c = cmp(a->getUnsafe(i), b->getUnsafe(i))
-    if c === 0. {
+    if c->Core__Ordering.isEqual {
       compareFromIndex(a, b, i + 1, cmp, len)
     } else {
       c
@@ -70,13 +70,11 @@ let rec compareFromIndex = (a, b, i, cmp, len) =>
 let compare = (a, b, cmp) => {
   let lenA = a->length
   let lenB = b->length
-  if lenA > lenB {
-    1.
-  } else if lenA < lenB {
-    -1.
-  } else {
-    compareFromIndex(a, b, 0, cmp, lenA)
-  }
+  lenA < lenB
+    ? Core__Ordering.less
+    : lenA > lenB
+    ? Core__Ordering.greater
+    : compareFromIndex(a, b, 0, cmp, lenA)
 }
 
 @send external copyAllWithin: (array<'a>, ~target: int) => array<'a> = "copyWithin"
@@ -139,8 +137,8 @@ let lastIndexOfOpt = (arr, item) =>
 @send external sliceToEnd: (array<'a>, ~start: int) => array<'a> = "slice"
 @send external copy: array<'a> => array<'a> = "slice"
 
-@send external sort: (array<'a>, ('a, 'a) => float) => unit = "sort"
-@send external toSorted: (array<'a>, ('a, 'a) => float) => array<'a> = "toSorted"
+@send external sort: (array<'a>, ('a, 'a) => Core__Ordering.t) => unit = "sort"
+@send external toSorted: (array<'a>, ('a, 'a) => Core__Ordering.t) => array<'a> = "toSorted"
 
 @send external toString: array<'a> => string = "toString"
 @send external toLocaleString: array<'a> => string = "toLocaleString"

src/Core__Array.resi

@@ -29,7 +29,7 @@ let fromInitializer: (~length: int, int => 'a) => array<'a>
 
 let equal: (array<'a>, array<'a>, ('a, 'a) => bool) => bool
 
-let compare: (array<'a>, array<'a>, ('a, 'a) => float) => float
+let compare: (array<'a>, array<'a>, ('a, 'a) => Core__Ordering.t) => Core__Ordering.t
 
 @val external isArray: 'a => bool = "Array.isArray"
 
@@ -212,14 +212,14 @@ See [`Array.toSorted`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/R
 ## Examples
 ```rescript
 let someArray = [3, 2, 1]
-let sorted = someArray->Array.toSorted((a, b) => float(a - b))
+let sorted = someArray->Array.toSorted(Int.compare)
 
 Console.log(sorted) // [1, 2, 3]
 Console.log(someArray) // [3, 2, 1]. Original unchanged
 ```
 */
 @send
-external toSorted: (array<'a>, ('a, 'a) => float) => array<'a> = "toSorted"
+external toSorted: (array<'a>, ('a, 'a) => Core__Ordering.t) => array<'a> = "toSorted"
 
 /**
 `sort(array, comparator)` sorts `array` in-place using the `comparator` function.
@@ -237,7 +237,7 @@ Console.log(someArray) // [1, 2, 3]
 ```
 */
 @send
-external sort: (array<'a>, ('a, 'a) => float) => unit = "sort"
+external sort: (array<'a>, ('a, 'a) => Core__Ordering.t) => unit = "sort"
 
 @variadic @send
 external splice: (array<'a>, ~start: int, ~remove: int, ~insert: array<'a>) => unit = "splice"

src/Core__Date.resi

@@ -434,7 +434,7 @@ external now: unit => msSinceEpoch = "Date.now"
 
 let equal: (t, t) => bool
 
-let compare: (t, t) => float
+let compare: (t, t) => Core__Ordering.t
 
 /**
 `getTime(date)`

src/Core__Float.mjs

@@ -1,5 +1,6 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
+import * as Core__Ordering from "./Core__Ordering.mjs";
 
 var Constants = {};
 
@@ -9,11 +10,11 @@ function equal(a, b) {
 
 function compare(a, b) {
   if (a < b) {
-    return -1;
-  } else if (a === b) {
-    return 0;
+    return Core__Ordering.less;
+  } else if (a > b) {
+    return Core__Ordering.greater;
   } else {
-    return 1;
+    return Core__Ordering.equal;
   }
 }
 

src/Core__Float.res

@@ -10,13 +10,7 @@ module Constants = {
 let equal = (a: float, b: float) => a === b
 
 let compare = (a: float, b: float) =>
-  if a < b {
-    -1.
-  } else if a === b {
-    0.
-  } else {
-    1.
-  }
+  a < b ? Core__Ordering.less : a > b ? Core__Ordering.greater : Core__Ordering.equal
 
 @val external isNaN: float => bool = "isNaN"
 @val external isFinite: float => bool = "isFinite"

src/Core__Float.resi

@@ -111,7 +111,7 @@ module Constants: {
 
 let equal: (float, float) => bool
 
-let compare: (float, float) => float
+let compare: (float, float) => Core__Ordering.t
 
 /**
 `isNaN(v)` tests if the given `v` is `NaN`.

src/Core__Int.mjs

@@ -2,18 +2,19 @@
 
 import * as Pervasives from "rescript/lib/es6/pervasives.js";
 import * as Core__Array from "./Core__Array.mjs";
+import * as Core__Ordering from "./Core__Ordering.mjs";
 
 function equal(a, b) {
   return a === b;
 }
 
 function compare(a, b) {
   if (a < b) {
-    return -1;
-  } else if (a === b) {
-    return 0;
+    return Core__Ordering.less;
+  } else if (a > b) {
+    return Core__Ordering.greater;
   } else {
-    return 1;
+    return Core__Ordering.equal;
   }
 }
 

src/Core__Int.res

@@ -6,13 +6,7 @@ module Constants = {
 let equal = (a: int, b: int) => a === b
 
 let compare = (a: int, b: int) =>
-  if a < b {
-    -1.
-  } else if a === b {
-    0.
-  } else {
-    1.
-  }
+  a < b ? Core__Ordering.less : a > b ? Core__Ordering.greater : Core__Ordering.equal
 
 @send external toExponential: int => string = "toExponential"
 @send external toExponentialWithPrecision: (int, ~digits: int) => string = "toExponential"

src/Core__Int.resi

@@ -58,7 +58,7 @@ module Constants: {
 
 let equal: (int, int) => bool
 
-let compare: (int, int) => float
+let compare: (int, int) => Core__Ordering.t
 
 /**
 `toExponential(n)` return a `string` representing the given value in exponential

src/Core__List.mjs

@@ -4,6 +4,7 @@ import * as Curry from "rescript/lib/es6/curry.js";
 import * as Belt_Array from "rescript/lib/es6/belt_Array.js";
 import * as Caml_option from "rescript/lib/es6/caml_option.js";
 import * as Core__Array from "./Core__Array.mjs";
+import * as Core__Ordering from "./Core__Ordering.mjs";
 
 function head(x) {
   if (x) {
@@ -975,13 +976,13 @@ function compareLength(_l1, _l2) {
     var l1 = _l1;
     if (!l1) {
       if (l2) {
-        return -1;
+        return Core__Ordering.less;
       } else {
-        return 0;
+        return Core__Ordering.equal;
       }
     }
     if (!l2) {
-      return 1;
+      return Core__Ordering.greater;
     }
     _l2 = l2.tl;
     _l1 = l1.tl;
@@ -995,16 +996,16 @@ function compare(_l1, _l2, p) {
     var l1 = _l1;
     if (!l1) {
       if (l2) {
-        return -1;
+        return Core__Ordering.less;
       } else {
-        return 0;
+        return Core__Ordering.equal;
       }
     }
     if (!l2) {
-      return 1;
+      return Core__Ordering.greater;
     }
     var c = Curry._2(p, l1.hd, l2.hd);
-    if (c !== 0) {
+    if (!Core__Ordering.isEqual(c)) {
       return c;
     }
     _l2 = l2.tl;

src/Core__List.res

@@ -682,20 +682,20 @@ let every2 = (l1, l2, p) => every2U(l1, l2, (. a, b) => p(a, b))
 
 let rec compareLength = (l1, l2) =>
   switch (l1, l2) {
-  | (list{}, list{}) => 0.
-  | (_, list{}) => 1.
-  | (list{}, _) => -1.
+  | (list{}, list{}) => Core__Ordering.equal
+  | (_, list{}) => Core__Ordering.greater
+  | (list{}, _) => Core__Ordering.less
   | (list{_, ...l1s}, list{_, ...l2s}) => compareLength(l1s, l2s)
   }
 
 let rec compare = (l1, l2, p) =>
   switch (l1, l2) {
-  | (list{}, list{}) => 0.
-  | (_, list{}) => 1.
-  | (list{}, _) => -1.
+  | (list{}, list{}) => Core__Ordering.equal
+  | (_, list{}) => Core__Ordering.greater
+  | (list{}, _) => Core__Ordering.less
   | (list{a1, ...l1}, list{a2, ...l2}) =>
     let c = p(a1, a2)
-    if c == 0. {
+    if c->Core__Ordering.isEqual {
       compare(l1, l2, p)
     } else {
       c

src/Core__List.resi

@@ -629,7 +629,7 @@ List.compareLength(list{1, 2, 3}, list{4, 5, 6}) // 0.
 List.compareLength(list{1, 2, 3, 4}, list{5, 6}) // 1.
 ```
 */
-let compareLength: (t<'a>, t<'a>) => float
+let compareLength: (t<'a>, t<'a>) => Core__Ordering.t
 
 /**
 `compare(list1, list2, f)` compare elements one by one `f`. `f` returns a negative
@@ -660,7 +660,7 @@ List.compare(list{1, 3, 5}, list{1, 3, 5}, (a, b) => compare(a, b)) /* 0. */
 for Array, we compare the length first and, only if the lengths are equal, elements one by one.
 For lists, we just compare elements one by one.
 */
-let compare: (t<'a>, t<'a>, ('a, 'a) => float) => float
+let compare: (t<'a>, t<'a>, ('a, 'a) => Core__Ordering.t) => Core__Ordering.t
 
 /**
 `equal(list1, list2, f)` check equality of `list2` and `list2` using `f` for
@@ -874,7 +874,7 @@ let setAssoc: (t<('a, 'c)>, 'a, 'c, ('a, 'a) => bool) => t<('a, 'c)>
 ## Examples
 
 ```rescript
-List.sort(list{5, 4, 9, 3, 7}, (a, b) => float(a - b)) // list{3, 4, 5, 7, 9}
+List.sort(list{5, 4, 9, 3, 7}, Int.compare) // list{3, 4, 5, 7, 9}
 ```
 */
-let sort: (t<'a>, ('a, 'a) => float) => t<'a>
+let sort: (t<'a>, ('a, 'a) => Core__Ordering.t) => t<'a>

src/Core__Null.resi

@@ -46,7 +46,7 @@ external make: 'a => t<'a> = "%identity"
 
 let equal: (t<'a>, t<'b>, ('a, 'b) => bool) => bool
 
-let compare: (t<'a>, t<'b>, ('a, 'b) => float) => float
+let compare: (t<'a>, t<'b>, ('a, 'b) => Core__Ordering.t) => Core__Ordering.t
 
 /**
 Converts a nullable value into an option, so it can be pattern matched on.

src/Core__Nullable.resi

@@ -57,7 +57,7 @@ external make: 'a => t<'a> = "%identity"
 
 let equal: (t<'a>, t<'b>, ('a, 'b) => bool) => bool
 
-let compare: (t<'a>, t<'b>, ('a, 'b) => float) => float
+let compare: (t<'a>, t<'b>, ('a, 'b) => Core__Ordering.t) => Core__Ordering.t
 
 /**
 Converts a nullable value into an option, so it can be pattern matched on.

src/Core__Option.mjs

@@ -2,6 +2,7 @@
 
 import * as Curry from "rescript/lib/es6/curry.js";
 import * as Caml_option from "rescript/lib/es6/caml_option.js";
+import * as Core__Ordering from "./Core__Ordering.mjs";
 
 function filter(opt, p) {
   var p$1 = Curry.__1(p);
@@ -95,12 +96,12 @@ function compare(a, b, cmp) {
     if (b !== undefined) {
       return Curry._2(cmp, Caml_option.valFromOption(a), Caml_option.valFromOption(b));
     } else {
-      return 1;
+      return Core__Ordering.greater;
     }
   } else if (b !== undefined) {
-    return -1;
+    return Core__Ordering.less;
   } else {
-    return 0;
+    return Core__Ordering.equal;
   }
 }
 

src/Core__Option.res

@@ -100,7 +100,7 @@ let equal = (a, b, eq) =>
 let compare = (a, b, cmp) =>
   switch (a, b) {
   | (Some(a), Some(b)) => cmp(a, b)
-  | (None, Some(_)) => -1.
-  | (Some(_), None) => 1.
-  | (None, None) => 0.
+  | (None, Some(_)) => Core__Ordering.less
+  | (Some(_), None) => Core__Ordering.greater
+  | (None, None) => Core__Ordering.equal
   }

src/Core__Option.resi

@@ -247,4 +247,4 @@ compare(Some(14), None, clockCompare) // 1.
 compare(None, None, clockCompare) // 0.
 ```
 */
-let compare: (option<'a>, option<'b>, ('a, 'b) => float) => float
+let compare: (option<'a>, option<'b>, ('a, 'b) => Core__Ordering.t) => Core__Ordering.t