Add sort! for unfrozen LittleDict (#136)

Also test sort & sort! more systematically and consistently
between LittleDict and OrderedDict

Author: fingolfin

src/dict_sorting.jl

@@ -31,6 +31,17 @@ function sort!(s::OrderedSet; kwargs...)
     return s
 end
 
+function sort!(d::UnfrozenLittleDict; byvalue::Bool=false, args...)
+    if byvalue
+        p = sortperm(d.vals; args...)
+    else
+        p = sortperm(d.keys; args...)
+    end
+    permute!(d.keys, p)
+    permute!(d.vals, p)
+    return d
+end
+
 sort(d::Union{OrderedDict,OrderedSet}; args...) = sort!(copy(d); args...)
 
 @deprecate sort(d::Dict; args...) sort!(OrderedDict(d); args...)

test/test_little_dict.jl

@@ -495,16 +495,29 @@ using OrderedCollections: FrozenLittleDict, UnfrozenLittleDict
     end
 
     @testset "Sorting" begin
-        d = LittleDict(i=>Char(123-i) for i in [4, 8, 1, 7, 9, 3, 10, 2, 6, 5])
+        ks = [4, 8, 1, 7, 9, 3, 10, 2, 6, 5]
+        d = LittleDict(i=>Char(123-i) for i in ks)
 
-        @test collect(keys(d)) != 1:10
         sd = sort(d)
+        @test collect(keys(d)) == ks    # verify d is not changed by sort()
         @test collect(keys(sd)) == 1:10
         @test collect(values(sd)) == collect('z':-1:'q')
         @test sort(sd) == sd
+
         sdv = sort(d; byvalue=true)
+        @test collect(keys(d)) == ks    # verify d is not changed by sort()
         @test collect(keys(sdv)) == 10:-1:1
         @test collect(values(sdv)) == collect('q':'z')
+
+        sort!(d)
+        @test collect(keys(d)) == 1:10
+        @test collect(values(d)) == collect('z':-1:'q')
+        @test sort(d) == d == sd
+
+        sort!(d; byvalue=true)
+        @test collect(keys(d)) == 10:-1:1
+        @test collect(values(d)) == collect('q':'z')
+        @test sort(d) == d == sd
     end
 
     @testset "Test that LittleDict merge with combiner returns type LittleDict" begin

test/test_ordered_dict.jl

@@ -421,15 +421,29 @@ using OrderedCollections, Test
     end
 
     @testset "Sorting" begin
-        d = Dict(i=>Char(123-i) for i = 1:10)
-        @test collect(keys(d)) != 1:10
-        sd = sort!(OrderedDict(d))
+        ks = [4, 8, 1, 7, 9, 3, 10, 2, 6, 5]
+        d = OrderedDict(i=>Char(123-i) for i in ks)
+
+        sd = sort(d)
+        @test collect(keys(d)) == ks    # verify d is not changed by sort()
         @test collect(keys(sd)) == 1:10
         @test collect(values(sd)) == collect('z':-1:'q')
         @test sort(sd) == sd
-        sdv = sort!(OrderedDict(d); byvalue=true)
+
+        sdv = sort(d; byvalue=true)
+        @test collect(keys(d)) == ks    # verify d is not changed by sort()
         @test collect(keys(sdv)) == 10:-1:1
         @test collect(values(sdv)) == collect('q':'z')
+
+        sort!(d)
+        @test collect(keys(d)) == 1:10
+        @test collect(values(d)) == collect('z':-1:'q')
+        @test sort(d) == d == sd
+
+        sort!(d; byvalue=true)
+        @test collect(keys(d)) == 10:-1:1
+        @test collect(values(d)) == collect('q':'z')
+        @test sort(d) == d == sd
     end
 
     @testset "Test that OrderedDict merge with combiner returns type OrderedDict" begin