Skip to content

Commit 299ab2b

Browse files
committed
Updated docs/Searching.rst for interpolation search
1 parent da954a0 commit 299ab2b

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

docs/Searching.rst

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,12 @@ Binary Search
9191

9292
* Functions and their uses
9393

94-
.. function:: binary_search.search(List, key)
94+
.. function:: binary_search.search(_list, target)
9595
:module: pygorithm.searching
9696

97-
- **List** : *Sorted* list in which the key is to be searched
98-
- **key** : key to be searched in the list
99-
- **Return Value** : returns the position (index) of the key if key found, else returns -1
97+
- **_list** : *Sorted* list in which the target is to be searched
98+
- **target** : target to be searched in the list
99+
- **Return Value** : returns the position (index) of the target if target found, else returns False
100100

101101
.. function:: binary_search.time_complexities()
102102

@@ -111,11 +111,11 @@ Linear Search
111111

112112
* Functions and their uses
113113

114-
.. function:: linear_search.search(List, key)
114+
.. function:: linear_search.search(_list, target)
115115

116-
- **List** : the list in which item is to searched
117-
- **key** : key to be searched in the list
118-
- **Return Value** : returns the position (index) of the key if key found, else returns -1
116+
- **_list** : the list in which item is to searched
117+
- **target** : target to be searched in the list
118+
- **Return Value** : returns the position (index) of the target if target found, else returns False
119119

120120
.. function:: linear_search.time_complexities()
121121

@@ -182,3 +182,23 @@ Quick Select Search
182182
.. function:: quick_select.get_code()
183183

184184
- **Return Value** : returns the code for the ``quick_select.search()`` function
185+
186+
Interpolation Search
187+
--------------------
188+
189+
* Functions and their uses
190+
191+
.. function:: interpolation_search.search(_list, target)
192+
:module: pygorithm.searching
193+
194+
- **_list** : *Sorted* list in which the target is to be searched
195+
- **target** : target to be searched in the list
196+
- **Return Value** : returns the position (index) of the target if target found, else returns False
197+
198+
.. function:: interpolation_search.time_complexities()
199+
200+
- **Return Value** : returns time complexities (Best, Average, Worst)
201+
202+
.. function:: interpolation_search.get_code()
203+
204+
- **Return Value** : returns the code for the ``interpolation_search.search()`` function

0 commit comments

Comments
 (0)