Merge pull request #638 from eulerkochy/rb_tree

Red Black Tree

Author: eulerkochy

docs/make.jl

@@ -25,6 +25,7 @@ makedocs(
         "intset.md",
         "sorted_containers.md",
         "dibit_vector.md",
+        "red_black_tree.md",
     ],
     modules = [DataStructures],
     format = Documenter.HTML()

docs/src/index.md

@@ -22,6 +22,7 @@ This package implements a variety of data structures, including
 -   DataStructures.IntSet
 -   SparseIntSet
 -   DiBitVector
+-   Red Black Tree
 
 ## Contents
 
@@ -46,6 +47,7 @@ Pages = [
     "intset.md",
     "sorted_containers.md",
     "sparse_int_set.md",
-    "dibit_vector.md"
+    "dibit_vector.md",
+    "red_black_tree.md"
 ]
 ```

docs/src/red_black_tree.md

@@ -0,0 +1,34 @@
+```@meta
+DocTestSetup = :(using DataStructures)
+```
+
+# Red Black Tree
+
+The `RBTree` type is an implementation of Red Black Tree in Julia. It is a self-balancing binary search tree with an extra bit of information, the color, in each of its node. Operations such as search, insert and delete can be done in `O(log n)` complexity, where `n` is the number of nodes in the `RBTree`.
+
+Examples:
+
+```jldoctest
+julia> tree = RBTree{Int}();
+
+julia> for k in 1:2:20
+           push!(tree, k)
+       end
+
+julia> haskey(tree, 3)
+true
+
+julia> tree[4]
+7
+
+julia> for k in 1:2:10
+           delete!(tree, k)
+       end
+
+julia> haskey(tree, 5)
+false
+```
+
+```@meta
+DocTestSetup = nothing
+```

src/DataStructures.jl

@@ -58,6 +58,8 @@ module DataStructures
 
     export DiBitVector
 
+    export RBTree, search_node, minimum_node
+
     export findkey
 
     include("delegate.jl")
@@ -108,5 +110,7 @@ module DataStructures
     export SparseIntSet
 
     include("dibit_vector.jl")
+    include("red_black_tree.jl")
     include("deprecations.jl")
+
 end