Skip to content

Commit cb0dd8a

Browse files
committed
Updated Searching.rst
1 parent 6c8ce18 commit cb0dd8a

File tree

1 file changed

+55
-14
lines changed

1 file changed

+55
-14
lines changed

docs/Searching.rst

Lines changed: 55 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -78,32 +78,73 @@ Binary Search
7878
-------------
7979

8080
* Functions and their uses
81-
- search(List, key) : returns the position (index) of the key if key found, else returns -1. Note: `List` parameter **must** be sorted
82-
- time_complexities() : returns time complexities (Best, Average, Worst)
83-
- get_code() : returns the code for the ``binary_search.search()`` function
81+
- .. function:: binary_search.search(List, key)
82+
83+
|**List** : *Sorted* list in which the key is to be searched
84+
|**key** : key to be searched in the list
85+
|**Return Value** : returns the position (index) of the key if key found, else returns -1
86+
87+
- .. function:: binary_search.time_complexities()
88+
89+
|**Return Value** : returns time complexities (Best, Average, Worst)
90+
91+
- .. function:: binary_search.get_code()
92+
93+
|**Return Value** : returns the code for the ``binary_search.search()`` function
8494
8595
Linear Search
8696
-------------
8797

8898
* Functions and their uses
89-
- search(List, key) : returns the position (index) of the key if key found, else returns -1
90-
- time_complexities() : returns time complexities (Best, Average, Worst)
91-
- get_code() : returns the code for the ``linear_search.search()`` function
99+
100+
- .. function:: linear_search.search(List, key)
101+
102+
|**List** : the list in which item is to searched
103+
|**key** : key to be searched in the list
104+
|**Return Value** : returns the position (index) of the key if key found, else returns -1
105+
106+
- .. function:: linear_search.time_complexities()
107+
108+
|**Return value** : returns time complexities (Best, Average, Worst)
109+
- .. function:: linear_search.get_code()
110+
111+
|**Return Value** : returns the code for the ``linear_search.search()`` function
92112
93113
Breadth First Search
94114
--------------------
95115

96116
* Functions and their uses
97-
- .. function:: search(graph, startVertex)
98117

99-
**graph** : takes the graph data structures with edges and vertices
100-
**startVertex** : it tells the function the vertex to start with
101-
Return Value : returns the bfs for the ``graph``
118+
- .. function:: breadth_first_search.search(graph, startVertex)
119+
120+
|**graph** : takes the graph data structures with edges and vertices
121+
|**startVertex** : it tells the function the vertex to start with
122+
|**Return Value** : returns the bfs for the ``graph``
123+
124+
- .. function:: breadth_first_search.time_complexities()
125+
126+
**Return Value** : returns time complexities
127+
128+
- .. function:: breadth_first_search.get_code()
129+
130+
**Return Value** : returns the code for the ``breadth_first_search.search()`` function
131+
132+
Depth First Search
133+
------------------
134+
135+
* Functions and their uses
136+
137+
- .. function:: breadth_first_search.search(graph, start, path)
138+
139+
|**graph** : takes the graph data structures with edges and vertices
140+
|**start** : it tells the function the vertex to start with
141+
|**path** : returns the list containing the required dfs
142+
|**Return Value** : returns the bfs for the ``graph``
102143
103-
- .. function:: time_complexities()
144+
- .. function:: breadth_first_search.time_complexities()
104145

105-
Return Value : returns time complexities
146+
**Return Value** : returns time complexities
106147

107-
- .. function:: get_code()
148+
- .. function:: breadth_first_search.get_code()
108149

109-
Return Value : returns the code for the ``breadth_first_search.search()`` function
150+
**Return Value** : returns the code for the ``depth_first_search.search()`` function

0 commit comments

Comments
 (0)