rename rank to sorted_rank

Author: eulerkochy

docs/src/avl_tree.md

@@ -18,7 +18,7 @@ julia> for k in 1:2:20
 julia> haskey(tree, 3)
 true
 
-julia> tree[4] # this operation is O(log n)
+julia> tree[4] # time complexity of this operation is O(log n)
 7
 
 julia> for k in 1:2:10
@@ -28,7 +28,7 @@ julia> for k in 1:2:10
 julia> haskey(tree, 5)
 false
 
-julia> rank(tree, 17)
+julia> sorted_rank(tree, 17) # used for finding rank of the key
 4
 ```
 

src/DataStructures.jl

@@ -60,7 +60,7 @@ module DataStructures
     export DiBitVector
 
     export RBTree, search_node, minimum_node
-    export AVLTree, rank
+    export AVLTree, sorted_rank
 
     export findkey
 

src/avl_tree.jl

@@ -229,11 +229,11 @@ function Base.delete!(tree::AVLTree{K}, d::K) where K
 end
 
 """
-    rank(tree::AVLTree, key)
+    sorted_rank(tree::AVLTree, key)
 
 Returns the rank of `key` present in the `tree`, if it present. A KeyError is thrown if `key` is not present.
 """
-function rank(tree::AVLTree{K}, key::K) where K
+function sorted_rank(tree::AVLTree{K}, key::K) where K
     !haskey(tree, key) && throw(KeyError(key))
     node = tree.root
     rank = 0

test/test_avl_tree.jl

@@ -138,8 +138,8 @@
             push!(t9, i)
         end
         for i in 1:20
-            @test rank(t9, i) == i
+            @test sorted_rank(t9, i) == i
         end
-        @test_throws KeyError rank(t9, 21)
+        @test_throws KeyError sorted_rank(t9, 21)
     end
 end