sort handles incomparable values

CHANGELOG.md

@@ -673,6 +673,7 @@
 - [Detect potential name conflicts between exported types and FQNs][5966]
 - [Ensure calls involving warnings remain instrumented][6067]
 - [One can define lazy atom fields][6151]
+- [Vector.sort handles incomparable types][5998]
 
 [3227]: https://github.com/enso-org/enso/pull/3227
 [3248]: https://github.com/enso-org/enso/pull/3248
@@ -777,6 +778,7 @@
 [5966]: https://github.com/enso-org/enso/pull/5966
 [6067]: https://github.com/enso-org/enso/pull/6067
 [6151]: https://github.com/enso-org/enso/pull/6151
+[5998]: https://github.com/enso-org/enso/pull/5998
 
 # Enso 2.0.0-alpha.18 (2021-10-12)
 

distribution/lib/Standard/Base/0.0.0-dev/src/Any.enso

@@ -453,11 +453,11 @@ type Any
 
 ## PRIVATE
    Checks if the comparators for the given objects are both of the same type. If so,
-   proceeds with the given action, and if not, throws `Type_Error`.
-assert_same_comparators : Any -> Any -> (Any -> Any) -> Any ! Type_Error
+   proceeds with the given action, and if not, throws `Incomparable_Values` error.
+assert_same_comparators : Any -> Any -> (Any -> Any) -> Any ! Incomparable_Values
 assert_same_comparators this that ~action =
     comp_this = Comparable.from this
     comp_that = Comparable.from that
     case Meta.is_same_object comp_this comp_that of
         True -> action
-        False -> Error.throw (Type_Error.Error (Meta.type_of comp_this) comp_that "comp_that")
+        False -> Error.throw (Incomparable_Values.Error this that)

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Array.enso

@@ -135,21 +135,6 @@ type Array
     length : Integer
     length self = @Builtin_Method "Array.length"
 
-    ## Sorts the Array.
-
-      Arguments:
-      - comparator: A comparison function that takes two elements and returns
-        an Ordering that describes how the first element is ordered with
-        respect to the second.
-
-      > Example
-        Getting a sorted array of numbers.
-
-            [3,2,1].to_array.sort
-    sort : (Any -> Any -> Ordering) -> Array
-    sort self comparator=(Ordering.compare _ _) =
-        self.sort_builtin comparator
-
     ## Identity.
        This method is implemented purely for completeness with the runtime's
        primitive array protocol.

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Index_Sub_Range.enso

@@ -117,7 +117,7 @@ invert_range_selection ranges length needs_sorting =
    Empty subranges are discarded.
 sort_and_merge_ranges : Vector Range -> Vector Range
 sort_and_merge_ranges ranges =
-    sorted = ranges.filter (range-> range.is_empty.not) . sort on=(.start)
+    sorted = ranges.filter (range-> range.is_empty.not) . sort on=(_.start)
     if sorted.is_empty then [] else
         current_ref = Ref.new sorted.first
         builder = Vector.new_builder

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Numbers.enso

@@ -1,6 +1,7 @@
 import project.Data.Text.Text
 import project.Data.Locale.Locale
 import project.Errors.Common.Arithmetic_Error
+import project.Errors.Common.Incomparable_Values
 import project.Error.Error
 import project.Nothing.Nothing
 import project.Panic.Panic
@@ -288,7 +289,7 @@ type Number
          Check if 1 is equal to 1.0000001 within 0.001.
 
              1.equals 1.0000001 epsilon=0.001
-    equals : Number -> Number -> Boolean
+    equals : Number -> Number -> Boolean ! Incomparable_Values
     equals self that epsilon=0.0 =
         (self == that) || ((self - that).abs <= epsilon)
 
@@ -457,54 +458,6 @@ type Decimal
     ^ : Number -> Number
     ^ self that = @Builtin_Method "Decimal.^"
 
-    ## Checks if this is greater than that.
-
-       Arguments:
-       - that: The number to compare this against.
-
-       > Example
-         Checking if 10 is greater than 7.3.
-
-             10 > 7.3
-    > : Number -> Boolean
-    > self that = @Builtin_Method "Decimal.>"
-
-    ## Checks if this is greater than or equal to thatthat.
-
-       Arguments:
-       - that: The number to compare this against.
-
-       > Example
-         Checking if 10 is greater than or equal to 7.3.
-
-             10 >= 7.3
-    >= : Number -> Boolean
-    >= self that = @Builtin_Method "Decimal.>="
-
-    ## Checks if this is less than that.
-
-       Arguments:
-       - that: The number to compare this against.
-
-       > Example
-         Checking if 10 is less than 7.3.
-
-             10 < 7.3
-    < : Number -> Boolean
-    < self that = @Builtin_Method "Decimal.<"
-
-    ## Checks if this is less than or equal to thatthat.
-
-       Arguments:
-       - that: The number to compare this against.
-
-       > Example
-         Checking if 10.4 is less than or equal to 7.
-
-             10.4 <= 7
-    <= : Number -> Boolean
-    <= self that = @Builtin_Method "Decimal.<="
-
     ## Computes the absolute value of this.
 
        The absolute value of a positive number is itself, while the absolute
@@ -682,54 +635,6 @@ type Integer
     ^ : Number -> Number
     ^ self that = @Builtin_Method "Integer.^"
 
-    ## Checks if this is greater than that.
-
-       Arguments:
-       - that: The number to compare this against.
-
-       > Example
-         Checking if 10 is greater than 7.
-
-             10 > 7
-    > : Number -> Boolean
-    > self that = @Builtin_Method "Integer.>"
-
-    ## Checks if this is greater than or equal to thatthat.
-
-       Arguments:
-       - that: The number to compare this against.
-
-       > Example
-         Checking if 10 is greater than or equal to 7.
-
-             10 >= 7
-    >= : Number -> Boolean
-    >= self that = @Builtin_Method "Integer.>="
-
-    ## Checks if this is less than that.
-
-       Arguments:
-       - that: The number to compare this against.
-
-       > Example
-         Checking if 10 is less than 7.
-
-             10 < 7
-    < : Number -> Boolean
-    < self that = @Builtin_Method "Integer.<"
-
-    ## Checks if this is less than or equal to thatthat.
-
-       Arguments:
-       - that: The number to compare this against.
-
-       > Example
-         Checking if 10 is less than or equal to 7.
-
-             10 <= 7
-    <= : Number -> Boolean
-    <= self that = @Builtin_Method "Integer.<="
-
     ## Computes the absolute value of this.
 
        The absolute value of a positive number is itself, while the absolute
@@ -937,6 +842,7 @@ type Integer
 
     parse_builtin text radix = @Builtin_Method "Integer.parse"
 
+
 ## UNSTABLE
 
    A syntax error when parsing a double.

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Ordering.enso

@@ -27,7 +27,7 @@ from project.Data.Boolean import all
 
     ```
     type Comparator T
-        compare : T -> T -> (Ordering|Nothing)
+        compare : T -> T -> (Ordering|Nothing) ! Incomparable_Values
         hash : T -> Integer
     ```
 
@@ -170,7 +170,7 @@ type Ordering
     Greater
 
     ## Compares to values and returns an Ordering
-    compare : Any -> Any -> Ordering ! (Incomparable_Values | Type_Error)
+    compare : Any -> Any -> Ordering ! Incomparable_Values
     compare x y =
         if x < y then Ordering.Less else
             if x == y then Ordering.Equal else

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Vector.enso

@@ -4,7 +4,6 @@ import project.Data.Filter_Condition.Filter_Condition
 import project.Data.List.List
 import project.Data.Map.Map
 import project.Data.Numbers.Integer
-import project.Data.Ordering.Ordering
 import project.Data.Ordering.Sort_Direction.Sort_Direction
 import project.Data.Pair.Pair
 import project.Data.Range.Range
@@ -19,10 +18,17 @@ import project.Error.Error
 import project.Errors.Illegal_Argument.Illegal_Argument
 import project.Function.Function
 import project.Math
+import project.Meta
 import project.Nothing.Nothing
 import project.Panic.Panic
 import project.Random
+import project.Warning.Warning
 
+import project.IO
+
+# We have to import also conversion methods, therefore, we import all from the Ordering
+# module
+from project.Data.Ordering import all
 from project.Data.Boolean import Boolean, True, False
 from project.Data.Index_Sub_Range import Index_Sub_Range, take_helper, drop_helper
 
@@ -841,13 +847,16 @@ type Vector a
        Arguments:
        - order: The order in which the vector elements are sorted.
        - on: A projection from the element type to the value of that element
-         being sorted on.
+         being sorted on. If set to `Nothing` (the default argument),
+         identity function will be used.
        - by: A function that compares the result of applying `on` to two
-         elements, returning an Ordering to compare them.
+         elements, returning an an `Ordering` if the two elements are comparable
+         or `Nothing` if they are not. If set to `Nothing` (the default argument),
+         `Ordering.compare _ _` method will be used.
+         Must be a static method.
+
+       By default, elements are sorted in ascending order.
 
-       By default, elements are sorted in ascending order, using the comparator
-       acquired from each element. A custom compare function may be passed to
-       the sort method.
 
        This is a stable sort, meaning that items that compare the same will not
        have their order changed by the sorting process.
@@ -865,6 +874,18 @@ type Vector a
          is partially sorted. When the vector is randomly ordered, the
          performance is equivalent to a standard mergesort.
 
+       ? Multiple comparators
+         Elements with different comparators are incomparable by definition.
+         This case is handled by first grouping the `self` vector into groups
+         with the same comparator, recursively sorting these groups, and then
+         merging them back together. The order of the sorted groups in the
+         resulting vector is based on the order of fully qualified names of
+         the comparators in the `self` vector, with the exception of the group
+         for the default comparator, which is always the first group.
+
+         Additionally, a warning will be attached, explaining that incomparable
+         values were encountered.
+
          It takes equal advantage of ascending and descending runs in the array,
          making it much simpler to merge two or more sorted arrays: simply
          concatenate them and sort.
@@ -878,16 +899,21 @@ type Vector a
          Sorting a vector of `Pair`s on the first element, descending.
 
              [Pair 1 2, Pair -1 8].sort Sort_Direction.Descending (_.first)
-    sort : Sort_Direction -> (Any -> Any) -> (Any -> Any -> Ordering) -> Vector Any ! Incomparable_Values
-    sort self (order = Sort_Direction.Ascending) (on = x -> x) (by = (Ordering.compare _ _)) =
-        comp_ascending l r  = by (on l) (on r)
-        comp_descending l r = by (on r) (on l)
-        compare = if order == Sort_Direction.Ascending then comp_ascending else
-            comp_descending
-
-        new_vec_arr = self.to_array.sort compare
-        if new_vec_arr.is_error then Error.throw new_vec_arr else
-            Vector.from_polyglot_array new_vec_arr
+
+       > Example
+         Sorting a vector with elements with different comparators. Values 1
+         and My_Type have different comparators. 1 will be sorted before My_Type
+         because it has the default comparator, and warning will be attached to
+         the resulting vector.
+
+             [My_Type.Value 'hello', 1].sort == [1, My_Type.Value 'hello']
+    sort : Sort_Direction -> (Any -> Any)|Nothing -> (Any -> Any -> (Ordering|Nothing))|Nothing -> Vector Any ! Incomparable_Values
+    sort self (order = Sort_Direction.Ascending) on=Nothing by=Nothing =
+        comps = case on == Nothing of
+            True -> self.map it-> Comparable.from it
+            False -> self.map it-> Comparable.from (on it)
+        compare_funcs = comps.map (it-> it.compare)
+        self.sort_builtin order.to_sign comps compare_funcs by on
 
     ## UNSTABLE
        Keeps only unique elements within the Vector, removing any duplicates.

distribution/lib/Standard/Test/0.0.0-dev/src/Problems.enso

@@ -3,7 +3,7 @@ from Standard.Base import all
 from project import Test
 import project.Extensions
 
-## Returns values of warnings attached to the value.Nothing
+## Returns values of warnings attached to the value.
 get_attached_warnings v =
     Warning.get_all v . map .value
 

engine/polyglot-api/src/main/java/org/enso/polyglot/HostEnsoUtils.java

@@ -9,7 +9,7 @@ private HostEnsoUtils() {
   /**
    * Extracts a string representation for a polyglot exception.
    *
-   * @param exexception the exception
+   * @param ex the exception
    * @return message representing the exception
    */
   public static String findExceptionMessage(Throwable ex) {

engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/meta/TypeOfNode.java

@@ -2,6 +2,7 @@
 
 import com.oracle.truffle.api.CompilerDirectives;
 import com.oracle.truffle.api.dsl.Fallback;
+import com.oracle.truffle.api.dsl.GenerateUncached;
 import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.api.interop.InteropLibrary;
 import com.oracle.truffle.api.interop.UnsupportedMessageException;
@@ -26,6 +27,7 @@
     name = "type_of",
     description = "Returns the type of a value.",
     autoRegister = false)
+@GenerateUncached
 public abstract class TypeOfNode extends Node {
 
   public abstract Object execute(@AcceptsError Object value);