Major rework to improve code quality and add automation checks (#805)

* delete secant method - it is identical to regula falsi

* document + improvize root finding algorithms

* attempt to document gaussian elimination

* added file brief

* commented doxygen-mainpage, added files-list link

* corrected files list link path

* files-list link correction - this time works :)

* document successive approximations

* cleaner equation

* updating DIRECTORY.md

* documented kmp string search

* document brute force string search

* document rabin-karp string search

* fixed mainpage readme

* doxygen v1.8.18 will suppress out the #minipage in the markdown

* cpplint correction for header guard style

* github action to auto format source code per cpplint standard

* updated setting to add 1 space before `private` and `public` keywords

* auto rename files and auto format code

* added missing "run" for step

* corrected asignmemt operation

* fixed trim and assign syntax

* added git move for renaming bad filenames

* added missing pipe for trim

* added missing space

* use old and new fnames

* store old fname using echo

* move files only if there is a change in filename

* put old filenames in quotes

* use double quote for old filename

* escape double quotes

* remove old_fname

* try escape characters and echo"

* add file-type to find

* cleanup echo

* ensure all trim variables are also in quotes

* try escape -quote again

* remove second escpe quote

* use single quote for first check

* use carets instead of quotes

* put variables in brackets

* remove -e from echo

* add debug echos

* try print0 flag

* find command with while instead of for-loop

* find command using IFS instead

* 🎉 IFS fix worked - escaped quotes for git mv

* protetc each word in git mv ..

* filename exists in lower cases - renamed

* 🎉 git push enabled

* updating DIRECTORY.md

* git pull & then push

* formatting filenames d7af6fdc8c

* formatting source-code for d7af6fdc8c

* remove allman break before braces

* updating DIRECTORY.md

* added missing comma lost in previous commit

* orchestrate all workflows

* fix yml indentation

* force push format changes, add title to DIRECTORY.md

* pull before proceeding

* reorganize pull commands

* use master branches for actions

* rename .cc files to .cpp

* added class destructor to clean up dynamic memory allocation

* rename to awesome workflow

* commented whole repo cpplint - added modified files lint check

* removed need for cpplint

* attempt to use actions/checkout@master

* temporary: no dependency on cpplint

* formatting filenames 153fb7b8a5

* formatting source-code for 153fb7b8a5

* updating DIRECTORY.md

* fix diff filename

* added comments to the code

* added test case

* formatting source-code for a850308fba

* updating DIRECTORY.md

* added machine learning folder

* added adaline algorithm

* updating DIRECTORY.md

* fixed issue [LWG2192](https://cplusplus.github.io/LWG/issue2192) for std::abs on MacOS

* add cmath for same bug: [LWG2192](https://cplusplus.github.io/LWG/issue2192) for std::abs on MacOS

* formatting source-code for f8925e4822

* use STL's inner_product

* formatting source-code for f94a330594

* added range comments

* define activation function

* use equal initial weights

* change test2 function to predict

* activation function not friend

* previous commit correction

* added option for predict function to return value before applying activation function as optional argument

* added test case to classify points lying within a sphere

* improve documentation for adaline

* formatting source-code for 15ec4c3aba

* added cmake to geometry folder

* added algorithm include for std::max

* add namespace - machine_learning

* add namespace - statistics

* add namespace - sorting

* added sorting algos to namespace sorting

* added namespace string_search

* formatting source-code for fd69530515

* added documentation to string_search namespace

* feat: Add BFS and DFS algorithms to check for cycle in a directed graph

* Remove const references for input of simple types

Reason: overhead on access

* fix bad code

sorry for force push

* Use pointer instead of the non-const reference

because apparently google says so.

* Remove a useless and possibly bad Graph constuctor overload

* Explicitely specify type of vector during graph instantiation

* updating DIRECTORY.md

* find openMP before adding subdirectories

* added kohonen self organizing map

* updating DIRECTORY.md

* remove older files and folders from gh-pages before adding new files

* remove chronos library due to inacceptability by cpplint

* use c++ specific static_cast instead

* initialize radom number generator

* updated image links with those from CPP repository

* rename computer.... folder to numerical methods

* added durand kerner method for root computation for arbitrarily large polynomials

* fixed additional comma

* fix cpplint errors

* updating DIRECTORY.md

* convert to function module

* update documentation

* move openmp to main loop

* added two test cases

* use INT16_MAX

* remove return statement from omp-for loop and use "break"

* run tests when no input is provided and skip tests when input polynomial is provided

* while loop cannot have break - replaced with continue and check is present in the main while condition

* (1) break while loop (2) skip runs on break_loop instead of hard-break

* add documentation images

* use long double for errors and tolerance checks

* make iterator variable i local to threads

* add critical secions to omp threads

* bugfix: move file writing outside of the parallel loop
othersie, there is no gurantee of the order of roots written to file

* rename folder to data_structures

* updating DIRECTORY.md

* fix ambiguous symbol `size`

* add data_structures to cmake

* docs: enable tree view, add timestamp in footer, try clang assistaed parsing

* doxygen - open links in external window

* remove invalid parameter from function docs

* use HTML5 img tag to resize images

* move file to proper folder

* fix documentations and cpplint

* formatting source-code for aacaf9828c

* updating DIRECTORY.md

* cpplint: add braces for multiple statement if

* add explicit link to badges

* remove  duplicate line

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* remove namespace indentation

* remove file associations in settings

* add author name

* enable cmake in subfolders of data_structures

* create and link object file

* cpp lint fixes and instantiate template classes

* cpp lint fixes and instantiate template classes

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* cpplint - ignore `build/include`

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* disable redundant gcc compilation in cpplint workflow

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* template header files contain function codes as well and removed redundant subfolders

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* updating DIRECTORY.md

* remove semicolons after functions in a class

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* cpplint header guard style

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* remove semilon

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* added LU decomposition algorithm

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* added QR decomposition algorithm

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* use QR decomposition to find eigen values

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* updating DIRECTORY.md

* use std::rand for thread safety

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* move srand to main()

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* cpplint braces correction

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* updated eigen value documentation

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* fix matrix shift doc

Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>

* rename CONTRIBUTION.md to CONTRIBUTING.md #836

* remove 'sort alphabetical order' check

* added documentation check

* remove extra paranthesis

* added gitpod

* added gitpod link from README

* attempt to add vscode gitpod extensions

* update gitpod extensions

* add gitpod extensions cmake-tools and git-graph

* remove gitpod init and add commands

* use init to one time install doxygen, graphviz, cpplint

* use gitpod dockerfile

* add ninja build system to docker

* remove configure task

* add github prebuild specs to gitpod

* disable gitpod addcommit

* update documentation for kohonen_som

* added ode solve using forward euler method

* added mid-point euler ode solver

* fixed itegration step equation

* added semi-implicit euler ODE solver

* updating DIRECTORY.md

* fix cpplint issues - lines 117 and 124

* added documentation to ode group

* corrected semi-implicit euler function

* updated docs and test cases better structure

* replace `free` with `delete` operator

* formatting source-code for f55ab50cf2

* updating DIRECTORY.md

* main function must return

* added machine learning group

* added kohonen som topology algorithm

* fix graph image path

* updating DIRECTORY.md

* fix braces

* use snprintf instead of sprintf

* use static_cast

* hardcode character buffer size

* fix machine learning groups in documentation

* fix missing namespace function

* replace kvedala fork references to TheAlgorithms

* fix bug in counting_sort

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: Anmol3299 <mittalanmol22@gmail.com>

graph/kosaraju.cpp

@@ -1,134 +1,121 @@
-/* Implementation of Kosaraju's Algorithm to find out the strongly connected components (SCCs) in a graph. 
-   Author:Anirban166
-*/   
+/* Implementation of Kosaraju's Algorithm to find out the strongly connected
+   components (SCCs) in a graph. Author:Anirban166
+*/
 
-#include<iostream>
-#include<vector>
+#include <iostream>
+#include <vector>
 
 using namespace std;
 
 /**
-* Iterative function/method to print graph:
-* @param a[] : array of vectors (2D)
-* @param V : vertices
-* @return void 
-**/
-void print(vector<int> a[],int V)
-{
-    for(int i=0;i<V;i++)
-    {
-        if(!a[i].empty())
-            cout<<"i="<<i<<"-->";
-        for(int j=0;j<a[i].size();j++)
-            cout<<a[i][j]<<" ";
-        if(!a[i].empty())
-            cout<<endl;
+ * Iterative function/method to print graph:
+ * @param a[] : array of vectors (2D)
+ * @param V : vertices
+ * @return void
+ **/
+void print(vector<int> a[], int V) {
+    for (int i = 0; i < V; i++) {
+        if (!a[i].empty())
+            cout << "i=" << i << "-->";
+        for (int j = 0; j < a[i].size(); j++) cout << a[i][j] << " ";
+        if (!a[i].empty())
+            cout << endl;
     }
 }
 
 /**
-* //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[])
-{
-    vis[v]=true;
-    for(auto i=adj[v].begin();i!=adj[v].end();i++)
-    {
-        if(vis[*i]==false)
-            push_vertex(*i,st,vis,adj);
+ * //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[]) {
+    vis[v] = true;
+    for (auto i = adj[v].begin(); i != adj[v].end(); i++) {
+        if (vis[*i] == false)
+            push_vertex(*i, st, vis, adj);
     }
     st.push(v);
 }
 
-
 /**
-* //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[])
-{
-    vis[v]=true;
+ * //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[]) {
+    vis[v] = true;
     // cout<<v<<" ";
-    for(auto i=grev[v].begin();i!=grev[v].end();i++)
-    {
-        if(vis[*i]==false)
-            dfs(*i,vis,grev);
+    for (auto i = grev[v].begin(); i != grev[v].end(); i++) {
+        if (vis[*i] == false)
+            dfs(*i, vis, 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)
+* @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[])
-{
-    bool vis[V]={};
+int kosaraju(int V, vector<int> adj[]) {
+    bool vis[V] = {};
     stack<int> st;
-    for(int v=0;v<V;v++)
-    {
-        if(vis[v]==false)
-            push_vertex(v,st,vis,adj);
+    for (int v = 0; v < V; v++) {
+        if (vis[v] == false)
+            push_vertex(v, st, vis, adj);
     }
-    //making new graph (grev) with reverse edges as in adj[]:
+    // making new graph (grev) with reverse edges as in adj[]:
     vector<int> grev[V];
-    for(int i=0;i<V+1;i++)
-    {
-        for(auto j=adj[i].begin();j!=adj[i].end();j++)
-        {
+    for (int i = 0; i < V + 1; i++) {
+        for (auto j = adj[i].begin(); j != adj[i].end(); j++) {
             grev[*j].push_back(i);
         }
     }
     // cout<<"grev="<<endl; ->debug statement
     // print(grev,V);       ->debug statement
-    //reinitialise visited to 0
-    for(int i=0;i<V;i++)
-        vis[i]=false;
-    int count_scc=0;
-    while(!st.empty())
-    {
-        int t=st.top();
+    // reinitialise visited to 0
+    for (int i = 0; i < V; i++) vis[i] = false;
+    int count_scc = 0;
+    while (!st.empty()) {
+        int t = st.top();
         st.pop();
-        if(vis[t]==false)
-        {
-            dfs(t,vis,grev);
+        if (vis[t] == false) {
+            dfs(t, vis, grev);
             count_scc++;
         }
     }
-    // cout<<"count_scc="<<count_scc<<endl; //in case you want to print here itself, uncomment & change return type of function to void.
+    // cout<<"count_scc="<<count_scc<<endl; //in case you want to print here
+    // itself, uncomment & change return type of function to void.
     return count_scc;
 }
 
-//All critical/corner cases have been taken care of.
-//Input your required values: (not hardcoded)
-int main()
-{
+// All critical/corner cases have been taken care of.
+// Input your required values: (not hardcoded)
+int main() {
     int t;
-    cin>>t; 
-    while(t--)
-    {
-        int a,b ; //a->number of nodes, b->directed edges.
-   	  cin>>a>>b;
-   	  int m,n;
-   	  vector<int> adj[a+1];
-        for(int i=0;i<b;i++) //take total b inputs of 2 vertices each required to form an edge.
+    cin >> t;
+    while (t--) {
+        int a, b;  // a->number of nodes, b->directed edges.
+        cin >> a >> b;
+        int m, n;
+        vector<int> adj[a + 1];
+        for (int i = 0; i < b; i++)  // take total b inputs of 2 vertices each
+                                     // required to form an edge.
         {
-            cin>>m>>n; //take input m,n denoting edge from m->n.
+            cin >> m >> n;  // take input m,n denoting edge from m->n.
             adj[m].push_back(n);
         }
-        //pass number of nodes and adjacency array as parameters to function:
-        cout<<kosaraju(a, adj)<<endl;
+        // pass number of nodes and adjacency array as parameters to function:
+        cout << kosaraju(a, adj) << endl;
     }
     return 0;
 }