Add Warnings whenever a floating-point value is used as a Dictionary …

…key (#11417)

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

@@ -1,4 +1,5 @@
 import project.Any.Any
+import project.Data.Numbers.Float
 import project.Data.Numbers.Integer
 import project.Data.Pair.Pair
 import project.Data.Text.Text
@@ -11,8 +12,10 @@ import project.Meta
 import project.Metadata.Widget
 import project.Nothing.Nothing
 import project.Panic.Panic
+import project.Warning.Warning
 from project.Data.Boolean import Boolean, False, True
 from project.Data.Text.Extensions import all
+from project.Errors.Common import Floating_Point_Equality
 from project.Metadata.Choice import Option
 from project.Metadata.Widget import Single_Choice, Vector_Editor
 from project.Widget_Helpers import make_all_selector
@@ -155,6 +158,10 @@ type Dictionary key value
        - key: The key to insert the value for.
        - value: The value to associate with the `key`.
 
+       ! Error Conditions
+         - If a floating-point value is used as a key, a
+           `Floating_Point_Equality` warning is attached.
+
        > Example
          Insert the value "seven" into the dictionary for the key 7.
 
@@ -163,9 +170,14 @@ type Dictionary key value
              example_insert = Examples.dictionary.insert 7 "seven"
     @key (make_all_selector ..Always)
     @value (make_all_selector ..Always)
-    insert : Any -> Any -> Dictionary
-    insert self key=(Missing_Argument.throw "key") value=(Missing_Argument.throw "value") =
-        self.insert_builtin key value
+    insert : Any -> Any -> Boolean -> Dictionary
+    insert self key=(Missing_Argument.throw "key") value=(Missing_Argument.throw "value") no_warning:Boolean=False =
+        new_dict = self.insert_builtin key value
+        case key of
+            _ : Float ->
+                if no_warning then new_dict else
+                    Warning.attach (Floating_Point_Equality.Used_As_Dictionary_Key key) new_dict
+            _ -> new_dict
 
     ## GROUP Selections
        ICON table_clean

distribution/lib/Standard/Base/0.0.0-dev/src/Errors/Common.enso

@@ -1,3 +1,4 @@
+import project.Data.Numbers.Float
 import project.Data.Numbers.Integer
 import project.Data.Text.Extensions
 import project.Data.Text.Text
@@ -553,7 +554,7 @@ type Out_Of_Range
     ## PRIVATE
     to_text : Text
     to_text self =
-        extra = if self.message.is_nothing then "" else ": "+self.message.to_text
+        extra = if self.message.is_nothing then "" else " (message = "+self.message.to_text+")"
         "(Out_Of_Range (value = "+self.value.to_text+")" + extra + ")"
 
 ## Indiciates that the response from a remote endpoint is over the size limit.
@@ -577,3 +578,31 @@ type Response_Too_Large
        Convert the Java exception to an Enso dataflow error.
     handle_java_exception ~action =
         Panic.catch ResponseTooLargeException action (cause-> Error.throw (Response_Too_Large.Error cause.payload.getLimit))
+
+## Indicates that some operation relies on equality on floating-point values,
+   which is not recommended.
+type Floating_Point_Equality
+    ## PRIVATE
+       Represents a general floating-point equality error, such as a direct comparison.
+    Error (location:Text)
+
+    ## PRIVATE
+       Represents the use of a floating-point value as a `Dictionary` key.
+    Used_As_Dictionary_Key value:Float
+
+    ## PRIVATE
+       Create a human-readable version of the error.
+    to_display_text : Text
+    to_display_text self = case self of
+        Floating_Point_Equality.Error location ->
+            "Relying on equality of floating-point numbers is not recommended (within "+location+")."
+        Floating_Point_Equality.Used_As_Dictionary_Key value ->
+            "Float used as dictionary key: "+value.to_text
+
+    ## PRIVATE
+    to_text : Text
+    to_text self = case self of
+        Floating_Point_Equality.Error location ->
+            "(Error  (location = "+location+"))"
+        Floating_Point_Equality.Used_As_Dictionary_Key value ->
+            "(Used_As_Dictionary_Key (value = "+value.to_text+"))"

distribution/lib/Standard/Base/0.0.0-dev/src/Internal/Array_Like_Helpers.enso

@@ -142,7 +142,7 @@ distinct vector on =
                 key = on item
                 if (existing.get key False) then existing else
                     builder.append item
-                    existing.insert key True
+                    existing.insert key True no_warning=True
 
 duplicates vector on = Vector.build builder->
     counts = vector.fold Dictionary.empty current-> item->

distribution/lib/Standard/Database/0.0.0-dev/src/DB_Column.enso

@@ -1,6 +1,7 @@
 from Standard.Base import all
 import Standard.Base.Data.Read.Many_Files_List.Many_Files_List
 import Standard.Base.Errors.Common.Index_Out_Of_Bounds
+import Standard.Base.Errors.Common.Floating_Point_Equality
 import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
 import Standard.Base.Errors.Illegal_State.Illegal_State
 import Standard.Base.Internal.Rounding_Helpers
@@ -15,7 +16,7 @@ import Standard.Table.Internal.Widget_Helpers
 import Standard.Table.Rows_To_Read.Rows_To_Read
 from Standard.Table import Auto, Column, Data_Formatter, Previous_Value, Sort_Column, Table, Value_Type
 from Standard.Table.Column import default_date_period
-from Standard.Table.Errors import Conversion_Failure, Floating_Point_Equality, Inexact_Type_Coercion, Invalid_Value_Type
+from Standard.Table.Errors import Conversion_Failure, Inexact_Type_Coercion, Invalid_Value_Type
 from Standard.Table.Internal.Cast_Helpers import check_cast_compatibility
 
 import project.Connection.Connection.Connection

distribution/lib/Standard/Database/0.0.0-dev/src/DB_Table.enso

@@ -5,6 +5,7 @@ import Standard.Base.Data.Read.Many_Files_List.Many_Files_List
 import Standard.Base.Data.Time.Errors.Date_Time_Format_Parse_Error
 import Standard.Base.Data.Vector.Builder
 import Standard.Base.Errors.Common.Additional_Warnings
+import Standard.Base.Errors.Common.Floating_Point_Equality
 import Standard.Base.Errors.Common.Incomparable_Values
 import Standard.Base.Errors.Common.Index_Out_Of_Bounds
 import Standard.Base.Errors.Common.Type_Error

distribution/lib/Standard/Database/0.0.0-dev/src/Internal/Aggregate_Helper.enso

@@ -1,14 +1,14 @@
 from Standard.Base import all
-import Standard.Base.Errors.Common.No_Such_Method
 import Standard.Base.Errors.Deprecated.Deprecated
 import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
+from Standard.Base.Errors.Common import Floating_Point_Equality, No_Such_Method
 
 import Standard.Table.Internal.Aggregate_Column_Helper
 import Standard.Table.Internal.Aggregate_Column_Helper.Internal_Order_By_Column_Reference
 import Standard.Table.Internal.Problem_Builder.Problem_Builder
 from Standard.Table import Aggregate_Column
 from Standard.Table.Aggregate_Column.Aggregate_Column import all
-from Standard.Table.Errors import Floating_Point_Equality, No_Output_Columns
+from Standard.Table.Errors import No_Output_Columns
 
 import project.DB_Table.DB_Table
 import project.Dialect.Dialect

distribution/lib/Standard/Database/0.0.0-dev/src/Internal/Common/Database_Distinct_Helper.enso

@@ -1,6 +1,5 @@
 from Standard.Base import all
-
-from Standard.Table.Errors import Floating_Point_Equality
+import Standard.Base.Errors.Common.Floating_Point_Equality
 
 import project.Internal.Helpers
 import project.Internal.IR.SQL_Expression.SQL_Expression

distribution/lib/Standard/Database/0.0.0-dev/src/Internal/Common/Database_Join_Helper.enso

@@ -1,10 +1,10 @@
 from Standard.Base import all
 import Standard.Base.Errors.Illegal_State.Illegal_State
+from Standard.Base.Errors.Common import Floating_Point_Equality
 
 import Standard.Table.Internal.Join_Helpers
 import Standard.Table.Internal.Unique_Name_Strategy.Unique_Name_Strategy
 from Standard.Table import Join_Kind
-from Standard.Table.Errors import Floating_Point_Equality
 
 import project.Connection.Connection.Connection
 import project.DB_Table.DB_Table

distribution/lib/Standard/Table/0.0.0-dev/src/Column.enso

@@ -3,6 +3,7 @@ import Standard.Base.Data.Array_Proxy.Array_Proxy
 import Standard.Base.Data.Read.Many_Files_List.Many_Files_List
 import Standard.Base.Data.Vector.No_Wrap
 import Standard.Base.Errors.Common.Arithmetic_Error
+import Standard.Base.Errors.Common.Floating_Point_Equality
 import Standard.Base.Errors.Common.Incomparable_Values
 import Standard.Base.Errors.Common.Index_Out_Of_Bounds
 import Standard.Base.Errors.Common.No_Such_Method
@@ -31,7 +32,7 @@ import project.Rows_To_Read.Rows_To_Read
 import project.Table.Table
 import project.Value_Type.Auto
 import project.Value_Type.Value_Type
-from project.Errors import Conversion_Failure, Floating_Point_Equality, Inexact_Type_Coercion, Invalid_Column_Names, Invalid_Value_Type, No_Index_Set_Error
+from project.Errors import Conversion_Failure, Inexact_Type_Coercion, Invalid_Column_Names, Invalid_Value_Type, No_Index_Set_Error
 from project.Internal.Column_Format import all
 from project.Internal.Java_Exports import make_date_builder_adapter, make_string_builder
 from project.Internal.Storage import enso_to_java, java_to_enso

distribution/lib/Standard/Table/0.0.0-dev/src/Errors.enso

@@ -169,19 +169,6 @@ type Ignored_Nothing_Values
     to_display_text self =
         "The column "+self.column+" contained Nothing values in rows " + self.rows.short_display_text + " which were ignored."
 
-## Indicates that some operation relies on equality on floating-point values,
-   which is not recommended.
-type Floating_Point_Equality
-    ## PRIVATE
-    Error (location:Text)
-
-    ## PRIVATE
-
-       Create a human-readable version of the error.
-    to_display_text : Text
-    to_display_text self =
-        "Relying on equality of floating-point numbers is not recommended (within "+self.location+")."
-
 ## Indicates that a text value with a delimiter was included in a concatenation
    without any quote character
 type Unquoted_Delimiter

distribution/lib/Standard/Table/0.0.0-dev/src/Internal/Java_Problems.enso

@@ -2,6 +2,7 @@ from Standard.Base import all
 import Standard.Base.Data.Vector.No_Wrap
 import Standard.Base.Errors.Common.Additional_Warnings
 import Standard.Base.Errors.Common.Arithmetic_Error
+import Standard.Base.Errors.Common.Floating_Point_Equality
 import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
 
 import project.Internal.Storage

distribution/lib/Standard/Table/0.0.0-dev/src/Internal/Lookup_Helpers.enso

@@ -1,12 +1,13 @@
 from Standard.Base import all
 import Standard.Base.Data.Vector.Builder
 import Standard.Base.Data.Vector.No_Wrap
+import Standard.Base.Errors.Common.Floating_Point_Equality
 import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
 
 import project.Internal.Storage
 import project.Internal.Value_Type_Helpers
 import project.Value_Type.Value_Type
-from project.Errors import Floating_Point_Equality, Missing_Input_Columns, No_Common_Type, No_Output_Columns, Unexpected_Extra_Columns
+from project.Errors import Missing_Input_Columns, No_Common_Type, No_Output_Columns, Unexpected_Extra_Columns
 
 polyglot java import org.enso.table.data.table.join.lookup.LookupColumnDescription
 

distribution/lib/Standard/Table/0.0.0-dev/src/Internal/Multi_Value_Key.enso

@@ -1,10 +1,10 @@
 from Standard.Base import all
 import Standard.Base.Data.Array_Proxy.Array_Proxy
+import Standard.Base.Errors.Common.Floating_Point_Equality
 import Standard.Base.Errors.Illegal_State.Illegal_State
 
 import project.Column.Column
 import project.Value_Type.Value_Type
-from project.Errors import Floating_Point_Equality
 
 ## PRIVATE
    An Enso implementation mirroring `UnorderedMultiValueKey` from the Java

distribution/lib/Standard/Table/0.0.0-dev/src/Table.enso

@@ -5,6 +5,7 @@ import Standard.Base.Data.Read.Many_Files_List.Many_Files_List
 import Standard.Base.Data.Time.Errors.Date_Time_Format_Parse_Error
 import Standard.Base.Data.Vector.No_Wrap
 import Standard.Base.Errors.Common.Additional_Warnings
+import Standard.Base.Errors.Common.Floating_Point_Equality
 import Standard.Base.Errors.Common.Incomparable_Values
 import Standard.Base.Errors.Common.Index_Out_Of_Bounds
 import Standard.Base.Errors.Common.No_Such_Method

test/Base_Tests/src/Data/Dictionary_Spec.enso

@@ -1,6 +1,7 @@
 from Standard.Base import all
 import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
 import Standard.Base.Errors.No_Such_Key.No_Such_Key
+from Standard.Base.Errors.Common import Floating_Point_Equality
 
 from Standard.Test import all
 
@@ -269,6 +270,16 @@ add_specs suite_builder =
             m.at 200 . should_equal 3
             m.at Nothing . should_equal 1
 
+        group_builder.specify "should attach a warning when a Float is used as a key" <|
+            m = Dictionary.empty . insert 1.2 3
+            m.at 1.2 . should_equal 3
+            Problems.expect_only_warning Floating_Point_Equality m
+
+        group_builder.specify "should attach a warning when a Float is used as a key (using from_vector)" <|
+            m = Dictionary.from_vector [[2, 3], [1.2, 3], [4, 5]]
+            m.at 1.2 . should_equal 3
+            Problems.expect_only_warning Floating_Point_Equality m
+
     suite_builder.group "Polyglot keys and values" group_builder->
         group_builder.specify "should support polyglot keys" pending=pending_js_missing <|
             dict = Dictionary.singleton (js_str "A") 42

test/Benchmarks/src/Map/Hash_Map.enso

@@ -9,13 +9,16 @@ polyglot java import org.enso.benchmark_helpers.JavaHashMapWrapper
 options = Bench.options . set_warmup (Bench.phase_conf 2 2) . set_measure (Bench.phase_conf 2 3)
 
 type Data
-    Value ~ints
+    Value ~dense_ints ~sparse_ints
 
     create n =
-        create_ints =
+        create_dense_ints =
             Vector.new n _->
                 Random.integer 0 ((n.div 100) - 1)
-        Data.Value create_ints
+        create_sparse_ints =
+            Vector.new n _->
+                Random.integer 0 (n - 1)
+        Data.Value create_dense_ints create_sparse_ints
 
 type Scenario
     Instance map_constructor
@@ -43,15 +46,23 @@ collect_benches = Bench.build builder->
 
     builder.group ("Enso_Hash_Map_" + n.to_text) options group_builder->
         # Scenario similar to what is done in distinct
+        # 'Sparse' ints have fewer duplicates and cause more inserts and fewer updates to happen.
+        group_builder.specify "Enso_Sparse_Incremental" <|
+            Scenario.Instance (_ -> Dictionary.empty) . run_distinct data.sparse_ints
+        group_builder.specify "Java_Sparse_Incremental" <|
+            Scenario.Instance (_ -> JavaHashMapWrapper.new) . run_distinct data.sparse_ints
+
+        # Scenario similar to what is done in distinct
+        # 'Dense' ints have more duplicates and cause fewer inserts and more updates to happen.
         group_builder.specify "Enso_Incremental" <|
-            Scenario.Instance (_ -> Dictionary.empty) . run_distinct data.ints
+            Scenario.Instance (_ -> Dictionary.empty) . run_distinct data.dense_ints
         group_builder.specify "Java_Incremental" <|
-            Scenario.Instance (_ -> JavaHashMapWrapper.new) . run_distinct data.ints
+            Scenario.Instance (_ -> JavaHashMapWrapper.new) . run_distinct data.dense_ints
 
         # A scenario similar to what is done in add_row_number with grouping
         group_builder.specify "Enso_Replacement" <|
-            Scenario.Instance (_ -> Dictionary.empty) . run_count_keys data.ints
+            Scenario.Instance (_ -> Dictionary.empty) . run_count_keys data.dense_ints
         group_builder.specify "Java_Replacement" <|
-            Scenario.Instance (_ -> JavaHashMapWrapper.new) . run_count_keys data.ints
+            Scenario.Instance (_ -> JavaHashMapWrapper.new) . run_count_keys data.dense_ints
 
 main = collect_benches . run_main

test/Benchmarks/src/Vector/Distinct.enso

@@ -9,25 +9,31 @@ options = Bench.options . set_warmup (Bench.phase_conf 1 3) . set_measure (Bench
 
 
 type Data
-    Value ~random_vec ~uniform_vec ~random_text_vec ~uniform_text_vec
+    Value ~random_integer_vec ~uniform_integer_vec ~random_float_vec ~uniform_float_vec ~random_text_vec ~uniform_text_vec
 
     create =
-        Data.Value create_random_vec create_uniform_vec create_random_text_vec create_uniform_text_vec
+        Data.Value create_random_integer_vec create_uniform_integer_vec create_random_float_vec create_uniform_float_vec create_random_text_vec create_uniform_text_vec
 
 
-create_random_vec = Utils.make_random_vec 100000
+create_random_integer_vec = Utils.make_random_integer_vec 100000
 
 
-create_uniform_vec = Vector.fill 100000 1
+create_random_float_vec = Utils.make_random_float_vec 100000
+
+
+create_uniform_integer_vec = Vector.fill 100000 1
+
+
+create_uniform_float_vec = Vector.fill 100000 1.2
 
 
 create_random_text_vec =
-    random_vec = create_random_vec
+    random_vec = create_random_float_vec
     random_vec.map .to_text
 
 
 create_uniform_text_vec =
-    uniform_vec = create_uniform_vec
+    uniform_vec = create_uniform_integer_vec
     uniform_vec.map .to_text
 
 
@@ -36,9 +42,13 @@ collect_benches = Bench.build builder->
 
     builder.group "Vector_Distinct" options group_builder->
         group_builder.specify "Random_Integer_Vector_Distinct_v2" <|
-            data.random_vec.distinct
+            data.random_integer_vec.distinct
         group_builder.specify "Uniform_Integer_Vector_Distinct" <|
-            data.uniform_vec.distinct
+            data.uniform_integer_vec.distinct
+        group_builder.specify "Random_Float_Vector_Distinct_v2" <|
+            data.random_float_vec.distinct
+        group_builder.specify "Uniform_Float_Vector_Distinct" <|
+            data.uniform_float_vec.distinct
         group_builder.specify "Random_Text_Vector_Distinct_v2" <|
             data.random_text_vec.distinct
         group_builder.specify "Uniform_Text_Vector_Distinct" <|

test/Benchmarks/src/Vector/Operations.enso

@@ -14,8 +14,8 @@ options = Bench.options . set_warmup (Bench.phase_conf 5 5) . set_measure (Bench
 
 collect_benches = Bench.build builder->
     vector_size = 1000000
-    random_vec = Utils.make_random_vec vector_size
-    random_vec_2 = Utils.make_random_vec 100000
+    random_vec = Utils.make_random_float_vec vector_size
+    random_vec_2 = Utils.make_random_float_vec 100000
     random_gen = Java_Random.new 123456
     stateful_fun x =
        s = State.get Number