Merge pull request #658 from eulerkochy/ordered_robindict

OrderedRobinDict

Author: eulerkochy

Project.toml

@@ -1,6 +1,6 @@
 name = "DataStructures"
 uuid = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
-version = "0.18.0"
+version = "0.18.1"
 
 [deps]
 Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"

docs/src/index.md

@@ -14,7 +14,7 @@ This package implements a variety of data structures, including
 -   Binary Heap
 -   Mutable Binary Heap
 -   Ordered Dicts and Sets
--   RobinDict (implemented with [Robin Hood Hashing](https://cs.uwaterloo.ca/research/tr/1986/CS-86-14.pdf))
+-   RobinDict and OrderedRobinDict (implemented with [Robin Hood Hashing](https://cs.uwaterloo.ca/research/tr/1986/CS-86-14.pdf))
 -   Dictionaries with Defaults
 -   Trie
 -   Linked List and Mutable Linked List

docs/src/robin_dict.md

@@ -7,6 +7,7 @@ DocTestSetup = :(using DataStructures)
 `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`.
+This has an ordered version called `OrderedRobinDict`, which replicates the interface of `OrderedDict`.
 
 Examples:
 

src/DataStructures.jl

@@ -55,6 +55,7 @@ module DataStructures
 
     export MultiDict, enumerateall
     export RobinDict
+    export OrderedRobinDict, isordered
 
     export DiBitVector
 
@@ -94,6 +95,7 @@ module DataStructures
     include("tokens2.jl")
     include("container_loops.jl")
     include("robin_dict.jl")
+    include("ordered_robin_dict.jl")
     export
         CircularBuffer,
         capacity,