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>

search/exponential_search.cpp

@@ -1,56 +1,84 @@
-// Copyright 2020 Divide-et-impera-11
-#include <assert.h>
+/**
+ * \file
+ * \brief [Exponential search
+ * algorithm](https://en.wikipedia.org/wiki/Exponential_search)
+ * \copyright 2020 Divide-et-impera-11
+ *
+ * The algorithm try to search the range where the key should be.
+ * If it has been found we do a binary search there.
+ * The range of the search grows by exponential every time.
+ * If the key is larger than the last element of array, the start of
+ * block(block_front) will be equal to the end of block(block_size) and the
+ * algorithm return null ponter, every other cases the algoritm return fom the
+ * loop.
+ */
+#include <cassert>
+#include <cmath>
 #include <iostream>
-#include <string>
-using namespaces std;
-// Binary Search Algorithm(use by struzik algorithm)
-// Time Complexity O(log n) where 'n' is the number of elements
-// Worst Time Complexity O(log n)
-// Best Time Complexity Ω(1)
-// Space Complexity O(1)
-// Auxiliary Space Complexity O(1)
-template<class Type> inline Type* binary_s(Type *array, size_t size, Type key) {
-int32_t lower_index(0), upper_index(size - 1), middle_index;
-while (lower_index <= upper_index) {
-     middle_index = floor((lower_index + upper_index) / 2);
-     if (*(array + middle_index) < key) lower_index = (middle_index + 1);
-     else if (*(array + middle_index) > key)upper_index = (middle_index - 1);
-     else  return (array + middle_index);
-     }
-return nullptr;
+#ifdef _MSC_VER
+#include <string>  // use for MS Visual C++
+#else
+#include <cstring>  // for all other compilers
+#endif
+
+/** Binary Search Algorithm (used by ::struzik_search)\n
+ * * Time Complexity O(log n) where 'n' is the number of elements
+ * * Worst Time Complexity O(log n)
+ * * Best Time Complexity Ω(1)
+ * * Space Complexity O(1)
+ * * Auxiliary Space Complexity O(1)
+ * \returns pointer to value in the array
+ * \returns `nullptr` if value not found
+ */
+template <class Type>
+inline Type* binary_s(Type* array, size_t size, Type key) {
+    int32_t lower_index(0), upper_index(size - 1), middle_index;
+
+    while (lower_index <= upper_index) {
+        middle_index = std::floor((lower_index + upper_index) / 2);
+
+        if (*(array + middle_index) < key)
+            lower_index = (middle_index + 1);
+        else if (*(array + middle_index) > key)
+            upper_index = (middle_index - 1);
+        else
+            return (array + middle_index);
+    }
+
+    return nullptr;
 }
-// Struzik Search Algorithm(Exponential)
-// Time Complexity O(log i)where i is the position of search key in the list
-// Worst Time Complexity O(log i)
-// Best Time Complexity Ω(1)
-// Space Complexity O(1)
-// Auxiliary Space Complexity O(1)
-/* Tha algorithm try to search the range where the key should be.
-If it has been found we do a binary search there.
-The range of the search grows by exponential every time.
-If the key is larger than the last element of array,
-the start of block(block_front) will be equal to the end of block(block_size)
-and the algorithm return null ponter,
-every other cases the algoritm return fom the loop. */
-template<class Type> Type* struzik_search(Type* array, size_t size, Type key) {
-  uint32_t block_front(0), block_size = size == 0 ? 0 : 1;
-  while (block_front != block_size) {
+
+/** Struzik Search Algorithm(Exponential)
+ * * Time Complexity O(log i) where i is the position of search key in the list
+ * * Worst Time Complexity O(log i)
+ * * Best Time Complexity Ω(1)
+ * * Space Complexity O(1)
+ * * Auxiliary Space Complexity O(1)
+ */
+template <class Type>
+Type* struzik_search(Type* array, size_t size, Type key) {
+    uint32_t block_front(0), block_size = size == 0 ? 0 : 1;
+    while (block_front != block_size) {
         if (*(array + block_size - 1) < key) {
-           block_front = block_size;
-           (block_size * 2 - 1 < size) ? (block_size *= 2) : block_size = size;
-           continue;
+            block_front = block_size;
+            (block_size * 2 - 1 < size) ? (block_size *= 2) : block_size = size;
+            continue;
         }
-  return binary_s<Type>(array + block_front, (block_size - block_front), key);
-  }
-return nullptr;
+        return binary_s<Type>(array + block_front, (block_size - block_front),
+                              key);
+    }
+    return nullptr;
 }
+
+/** Main function */
 int main() {
-// TEST CASES
-int *sorted_array = new int[7]{7, 10, 15, 23, 70, 105, 203};
-assert(struzik_search<int>(sorted_array, 7, 0) == nullptr);
-assert(struzik_search<int>(sorted_array, 7, 1000) == nullptr);
-assert(struzik_search<int>(sorted_array, 7, 50) == nullptr);
-assert(struzik_search<int>(sorted_array, 7, 7) == sorted_array);
-// TEST CASES
-return 0;
+    // TEST CASES
+    int* sorted_array = new int[7]{7, 10, 15, 23, 70, 105, 203};
+    assert(struzik_search<int>(sorted_array, 7, 0) == nullptr);
+    assert(struzik_search<int>(sorted_array, 7, 1000) == nullptr);
+    assert(struzik_search<int>(sorted_array, 7, 50) == nullptr);
+    assert(struzik_search<int>(sorted_array, 7, 7) == sorted_array);
+    // TEST CASES
+    delete[] sorted_array;
+    return 0;
 }