RobinDict

docs/src/index.md

@@ -13,6 +13,7 @@ This package implements a variety of data structures, including
 -   Binary Heap
 -   Mutable Binary Heap
 -   Ordered Dicts and Sets
+-   RobinDict
 -   Dictionaries with Defaults
 -   Trie
 -   Linked List and Mutable Linked List
@@ -34,6 +35,7 @@ Pages = [
     "heaps.md",
     "ordered_containers.md",
     "default_dict.md",
+    "robin_dict.md",
     "trie.md",
     "linked_list.md",
     "mutable_linked_list.md"

docs/src/robin_dict.md

@@ -0,0 +1,36 @@
+# RobinDict
+
+`RobinDict` provides a standard dictionary, conforming to the AbstractDict protocol, which uses the Robin Hood hashing algorithm with backward-shift deletion to provide improved average performance over Dict.
+
+The interface of `RobinDict` replicates that of `Dict`.
+
+Examples:
+
+```julia
+julia> d = RobinDict{Int, Char}(1 => 'a', 2 => 'b')
+RobinDict{Int64,Char} with 2 entries:
+  2 => 'b'
+  1 => 'a'
+
+julia> d[3] = 'c';
+
+julia> collect(d)
+3-element Array{Pair{Int64,Char},1}:
+ 2 => 'b'
+ 3 => 'c'
+ 1 => 'a'
+
+julia> delete!(d, 2);
+
+julia> d[1]
+'a': ASCII/Unicode U+0061 (category Ll: Letter, lowercase)
+
+julia> d
+RobinDict{Int64,Char} with 2 entries:
+  3 => 'c'
+  1 => 'a'
+
+julia> pop!(d)
+3 => 'c'
+```
+

src/DataStructures.jl

@@ -55,6 +55,7 @@ module DataStructures
     export orderobject, ordtype, Lt, compare, onlysemitokens
 
     export MultiDict, enumerateall
+    export RobinDict
 
     export findkey
 
@@ -90,7 +91,7 @@ module DataStructures
     include("sorted_set.jl")
     include("tokens2.jl")
     include("container_loops.jl")
-
+    include("robin_dict.jl")
     export
         CircularBuffer,
         capacity,