Skip to content

Commit 11eebf2

Browse files
committed
Updated Docs
1 parent 6426213 commit 11eebf2

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

docs/Searching.rst

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Features
3636
3737
>>> from pygorithm.searching import modules
3838
>>> modules()
39-
['binary_search', 'breadth_first_search', 'depth_first_search', 'linear_search']
39+
['binary_search', 'breadth_first_search', 'depth_first_search', 'linear_search', 'quick_select']
4040
4141
* For Searching:
4242
Remember ``search()`` function in `binary_search` module takes two parameters as a sorted list and the target element to be searched.
@@ -121,7 +121,7 @@ Breadth First Search
121121

122122
- **graph** : takes the graph data structures with edges and vertices
123123
- **startVertex** : it tells the function the vertex to start with
124-
- **Return Value** : returns the bfs for the ``graph``
124+
- **Return Value** : returns the `set` of bfs for the ``graph``
125125

126126
.. function:: breadth_first_search.time_complexities()
127127

@@ -141,7 +141,7 @@ Depth First Search
141141
- **graph** : takes the graph data structures with edges and vertices
142142
- **start** : it tells the function the vertex to start with
143143
- **path** : returns the list containing the required dfs
144-
- **Return Value** : returns the bfs for the ``graph``
144+
- **Return Value** : returns the `list` of dfs for the ``graph``
145145

146146
.. function:: breadth_first_search.time_complexities()
147147

@@ -150,3 +150,22 @@ Depth First Search
150150
.. function:: breadth_first_search.get_code()
151151

152152
- **Return Value** : returns the code for the ``depth_first_search.search()`` function
153+
154+
Quick Select Search
155+
------------------
156+
157+
* Functions and their uses
158+
159+
.. function:: quick_select.search(array, n)
160+
161+
- **array** : an unsorted array
162+
- **n** : nth number to be searched in the given `array`
163+
- **Return Value** : returns the nth element
164+
165+
.. function:: quick_select.time_complexities()
166+
167+
- **Return Value** : returns time complexities
168+
169+
.. function:: quick_select.get_code()
170+
171+
- **Return Value** : returns the code for the ``quick_select.search()`` function

0 commit comments

Comments
 (0)