OpenSoure_Repos/TheAlgorithms-C-Plus-Plus
1
0
Fork 0
mirror of https://hub.njuu.cf/TheAlgorithms/C-Plus-Plus.git synced 2023-10-11 13:05:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add detailed function definitions (comments)

Browse Source 
Updated with proper function definitions
Information about method included
@param parameter : what it is/explanation included
@return return type included
This commit is contained in:
Anirban Chetia 2019-11-22 22:44:43 +05:30 committed by GitHub
parent 0ef5cbec29
commit 077c758b6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
Graph/Kosaraju.cpp
View File

@ -7,14 +7,12 @@
using namespace std; using namespace std;
/*Common terms/anotations used as parameters in functions below: /**
V: number of vertices, * Iterative function/method to print graph:
adj[]: array of vectors to represent graph, * @param a[] : array of vectors (2D)
vis[]: array to keep track of visited nodes, (boolean type) * @param V : vertices
grev[]: graph with reverse edges. * @return void
*/ **/
//iterative function/method to print graph:
void print(vector<int> a[],int V) void print(vector<int> a[],int V)
{ {
for(int i=0;i<V;i++) for(int i=0;i<V;i++)
@ -28,7 +26,14 @@ void print(vector<int> a[],int V)
} }
} }
//recursive function/method to push vertices into stack passed as parameter: (referenced) /**
* //Recursive function/method to push vertices into stack passed as parameter:
* @param v : vertices
* @param &st : stack passed by reference
* @param vis[] : array to keep track of visited nodes (boolean type)
* @param adj[] : array of vectors to represent graph
* @return void
**/
void push_vertex(int v,stack<int> &st,bool vis[],vector<int> adj[]) void push_vertex(int v,stack<int> &st,bool vis[],vector<int> adj[])
{ {
vis[v]=true; vis[v]=true;
@ -40,7 +45,14 @@ void push_vertex(int v,stack<int> &st,bool vis[],vector<int> adj[])
st.push(v); st.push(v);
} }
//recursive function/method to implement depth first traversal(dfs):
/**
* //Recursive function/method to implement depth first traversal(dfs):
* @param v : vertices
* @param vis[] : array to keep track of visited nodes (boolean type)
* @param grev[] : graph with reversed edges
* @return void
**/
void dfs(int v,bool vis[],vector<int> grev[]) void dfs(int v,bool vis[],vector<int> grev[])
{ {
vis[v]=true; vis[v]=true;
@ -53,6 +65,13 @@ void dfs(int v,bool vis[],vector<int> grev[])
} }
//function/method to implement Kosaraju's Algorithm: //function/method to implement Kosaraju's Algorithm:
/**
* Info about the method
* @param V : vertices in graph
* @param adj[] : array of vectors that represent a graph (adjacency list/array)
* @return int ( 0, 1, 2..and so on, only unsigned values as either there can be no SCCs i.e. none(0) or there will be x no. of SCCs (x>0))
i.e. it returns the count of (number of) strongly connected components (SCCs) in the graph. (variable 'count_scc' within function)
**/
int kosaraju(int V, vector<int> adj[]) int kosaraju(int V, vector<int> adj[])
{ {
bool vis[V]={}; bool vis[V]={};