Updated Readme.

Author: shreyasvedpathak

Graphs/graphAM.py renamed to Graph/graph.py

@@ -8,6 +8,14 @@
 
 class Graph:
     def __init__(self, vertices, graph_type='directed', weighted = False):
+        '''
+        Initialises Adjacent Matrix with Zeros and other class variables.
+
+        Parameters:
+        vertices -- number of vertices
+        graph_type -- 'directed' or 'undirected'
+        weighted -- True or False
+        '''
         self._vertices = vertices
         self._type = graph_type
         self._weighted = weighted
@@ -16,22 +24,39 @@ def __init__(self, vertices, graph_type='directed', weighted = False):
         self._visited = [False] * self._vertices
 
     def insert_edge(self, u, v, weight=1):
+        '''
+        Adds an edge between the passed vertices (u,v) by allocating the weight at that index position.
+        If the graph is 'undirected', then same weights are also copied to (v,u).
+        '''
         self._adjMAT[u][v] = weight
         if self._type == 'undirected':
             self._adjMAT[v][u] = weight
 
     def remove_edge(self, u, v):
+        '''
+        Removes an edge between the passed vertices (u,v) by making that index position as 0.
+        If the graph is 'undirected', then 0 is also copied to (v,u).
+        '''
         self._adjMAT[u][v] = 0
         if self._type == 'undirected':
             self._adjMAT[v][u] = 0
 
     def exist_edge(self, u, v):
+        '''
+        Returns True if edge exists between vertices (u,v), else False.
+        '''
         return self._adjMAT[u][v] != 0
 
     def vertex_count(self):
+        '''
+        Returns number of vertices present in the Graph.
+        '''
         return self._vertices
 
     def edge_count(self):
+        '''
+        Returns number of edges present in the Graph.
+        '''
         count = 0
         for i in range(self._vertices):
             for j in range(self._vertices):
@@ -40,11 +65,17 @@ def edge_count(self):
         return count
 
     def vertices(self):
+        '''
+        Prints all the vertices.
+        '''
         for i in range(self._vertices):
             print(i, end=' ')
         print()
 
     def edges(self):
+        '''
+        Prints all the edges with weights if the graph is undirected.
+        '''
         for i in range(self._vertices):
             for j in range(self._vertices):
                 if self._adjMAT[i][j] != 0 and self._weighted == True:
@@ -53,21 +84,30 @@ def edges(self):
                     print(f'{i} -- {j}')
 
     def outdegree(self, v):
+        '''
+        Returns the outdegree of the passed vertex v.
+        '''
         count = 0
         for j in range(self._vertices):
             if self._adjMAT[v][j] != 0:
                 count += 1
         return count
 
     def indegree(self, v):
+        '''
+        Returns the indegree of the passed vertex v.
+        '''
         count = 0
         for i in range(self._vertices):
             if self._adjMAT[i][v] != 0:
                 count += 1
         return count
 
-    def BFS(self, start_vertext):
-        i = start_vertext
+    def BFS(self, start_vertex):
+        '''
+        Breadth First Search
+        '''
+        i = start_vertex
         q = Queue()
         visited = [False] * self._vertices
         print(i, end=' ')
@@ -83,6 +123,9 @@ def BFS(self, start_vertext):
                     q.enqueue(j)
 
     def DFS_iterative(self, start_vertex):
+        '''
+        Depth First Search using Stack.
+        '''
         i = start_vertex
         s = Stack()
         visited = [False] * self._vertices
@@ -98,6 +141,9 @@ def DFS_iterative(self, start_vertex):
                         s.push(j)
 
     def DFS_recursive(self, start_vertex):
+        '''
+        Depth First Search using Recursion.
+        '''
         if self._visited[start_vertex] == False:
             print(start_vertex, end=' ')
             self._visited[start_vertex] = True
@@ -107,8 +153,10 @@ def DFS_recursive(self, start_vertex):
                     self.DFS_recursive(j)
 
     def display(self):
+        '''
+        Displays Adjacency Matrix.
+        '''
         n_edges = self.edge_count()
-
         if self._type == 'undirected':
             n_edges = int(n_edges / 2)
 
@@ -142,9 +190,17 @@ def display(self):
 
 g.insert_edge(6, 3, 70)
 
+print("\nAdjacency Matrix")
 g.display()
+
+print("\nEdges")
 g.edges()
-print("DFS Iterative:")
+
+print("\nBFS:")
+g.BFS(0)
+
+print("\nDFS Iterative:")
 g.DFS_iterative(0)
+
 print("\nDFS Iterative:")
 g.DFS_recursive(0)

Graphs/tempCodeRunnerFile.py renamed to Graph/tempCodeRunnerFile.py

@@ -15,7 +15,7 @@ Find the detailed description on [Index](Sorting%20Algorithms/) page.
 
 ## Data Structures
 
-### 1. Linked Lists
+### 1. Linked List
 
 Find the detailed description on operations performed [here.](LinkedList/)
 
@@ -33,7 +33,7 @@ Find the detailed description on operations performed [here.](LinkedList/)
 1. [Queue using inbuilt Python List](Queues/queues.py)
 2. [Queue using Linked List](Queues/queuesLL.py)
 
-### 4. Binary Trees (using Linked List)
+### 4. Binary Tree (using Linked List)
 
 Find the detailed description on operations performed [here.](BinaryTrees/)
 
@@ -49,4 +49,8 @@ Find the detailed description on operations performed [here.](BinaryTrees/)
 Find the detailed description on operations performed [here.](Hashing/)
 
 1. [Hashing using Chaining](Hashing/hashingChaining.py)
-2. [Hashing using Linear, Quadractic Probing and Double Hashing](Hashing/hashingStrategies.py)
+2. [Hashing using Linear, Quadractic Probing and Double Hashing](Hashing/hashingStrategies.py)
+
+### 7. Graph
+
+1. [Graph using Adjacency Matrix](Graph/graph.py)