Added docstring

anshulll · Oct 4, 2017 · 3ba2555 · 3ba2555
1 parent e8e4269
commit 3ba2555
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/search/binary_search/scala/binary_search.scala b/search/binary_search/scala/binary_search.scala
@@ -1,6 +1,13 @@
 
 
-
+/**
+* Recursive binary search algorithm 
+* @param lst the integer array which is being searched
+* @param l lower value for partition
+* @param r upper value for partition
+* @param num number which is being searched for
+* @return the index of the element that matches the search term, returns -1 if not found
+*/
 def binary_search(lst:Array[Int],l:Int,r:Int,num:Int):Int={
 
 	if(l <= r){