Skip to content

Commit aaa08b0

Browse files
kvedalagithub-actionsAnmol3299
authored
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 d7af6fd * formatting source-code for d7af6fd * 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 153fb7b * formatting source-code for 153fb7b * updating DIRECTORY.md * fix diff filename * added comments to the code * added test case * formatting source-code for a850308 * 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 f8925e4 * use STL's inner_product * formatting source-code for f94a330 * 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 15ec4c3 * 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 fd69530 * 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 aacaf98 * updating DIRECTORY.md * cpplint: add braces for multiple statement if * add explicit link to badges * remove duplicate line Signed-off-by: Krishna Vedala <[email protected]> * 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 <[email protected]> * cpplint - ignore `build/include` Signed-off-by: Krishna Vedala <[email protected]> * disable redundant gcc compilation in cpplint workflow Signed-off-by: Krishna Vedala <[email protected]> * template header files contain function codes as well and removed redundant subfolders Signed-off-by: Krishna Vedala <[email protected]> * updating DIRECTORY.md * remove semicolons after functions in a class Signed-off-by: Krishna Vedala <[email protected]> * cpplint header guard style Signed-off-by: Krishna Vedala <[email protected]> * remove semilon Signed-off-by: Krishna Vedala <[email protected]> * added LU decomposition algorithm Signed-off-by: Krishna Vedala <[email protected]> * added QR decomposition algorithm Signed-off-by: Krishna Vedala <[email protected]> * use QR decomposition to find eigen values Signed-off-by: Krishna Vedala <[email protected]> * updating DIRECTORY.md * use std::rand for thread safety Signed-off-by: Krishna Vedala <[email protected]> * move srand to main() Signed-off-by: Krishna Vedala <[email protected]> * cpplint braces correction Signed-off-by: Krishna Vedala <[email protected]> * updated eigen value documentation Signed-off-by: Krishna Vedala <[email protected]> * fix matrix shift doc Signed-off-by: Krishna Vedala <[email protected]> * 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 f55ab50 * 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 <[email protected]>
1 parent 70a2aee commit aaa08b0

File tree

313 files changed

+49346
-9847
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

313 files changed

+49346
-9847
lines changed

‎.github/pull_request_template.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33
Thank you for your Pull Request. Please provide a description above and review
44
the requirements below.
55
6-
Contributors guide: https://github.com/TheAlgorithms/C-Plus-Plus/CONTRIBUTION.md
6+
Contributors guide: https://github.com/TheAlgorithms/C-Plus-Plus/CONTRIBUTING.md
77
-->
88

99
#### Checklist
1010
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
1111

1212
- [ ] Added description of change
13-
- [ ] Added file name matches [File name guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTION.md#New-File-Name-guidelines)
13+
- [ ] Added file name matches [File name guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md#New-File-Name-guidelines)
1414
- [ ] Added tests and example, test must pass
15+
- [ ] Added documentation so that the program is self-explanatory and educational - [Doxygen guidelines](https://www.doxygen.nl/manual/docblocks.html)
1516
- [ ] Relevant documentation/comments is changed or added
16-
- [ ] PR title follows semantic [commit guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTION.md#Commit-Guidelines)
17+
- [ ] PR title follows semantic [commit guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md#Commit-Guidelines)
1718
- [ ] Search previous suggestions before making a new one, as yours may be a duplicate.
18-
- [ ] Sort by alphabetical order
1919
- [ ] I acknowledge that all my contributions will be made under the project's license.
2020

2121
Notes: <!-- Please add a one-line description for developers or pull request viewers -->

‎.github/workflows/awesome_forkflow.yml‎

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
name: Awesome CI Workflow
2+
3+
on: [push]
4+
# push:
5+
# branches: [ master ]
6+
# pull_request:
7+
# branches: [ master ]
8+
9+
jobs:
10+
code_format:
11+
name: Code Formatter
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: requirements
15+
run: |
16+
sudo apt -qq -y update
17+
sudo apt -qq install clang-format
18+
- uses: actions/checkout@master
19+
with:
20+
submodules: true
21+
- name: Setup Git Specs
22+
run: |
23+
git config --global user.name github-actions
24+
git config --global user.email '${GITHUB_ACTOR}@users.noreply.github.com'
25+
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
26+
- name: Filename Formatter
27+
run: |
28+
IFS=$'\n'
29+
for fname in `find . -type f -name '*.cpp' -o -name '*.cc' -o -name '*.h'`
30+
do
31+
echo "${fname}"
32+
new_fname=`echo ${fname} | tr ' ' '_'`
33+
echo " ${new_fname}"
34+
new_fname=`echo ${new_fname} | tr 'A-Z' 'a-z'`
35+
echo " ${new_fname}"
36+
new_fname=`echo ${new_fname} | tr '-' '_'`
37+
echo " ${new_fname}"
38+
new_fname=${new_fname/.cc/.cpp}
39+
echo " ${new_fname}"
40+
if [ ${fname} != ${new_fname} ]
41+
then
42+
echo " ${fname} --> ${new_fname}"
43+
git "mv" "${fname}" ${new_fname}
44+
fi
45+
done
46+
git commit -am "formatting filenames $GITHUB_SHA" || true
47+
- name: Clang Formatter
48+
run: |
49+
for fname in $(find . -name '*.cpp' -o -name '*.h')
50+
do
51+
clang-format --verbose -i --style="$line1 $line2 $line3 $line4" "$fname"
52+
done
53+
git commit -am "formatting source-code for $GITHUB_SHA" || true
54+
env:
55+
line1: "{ BasedOnStyle: Google, UseTab: Never,"
56+
line2: "IndentWidth: 4, TabWidth: 4, "
57+
line3: "AllowShortIfStatementsOnASingleLine: false, IndentCaseLabels: false,"
58+
line4: "ColumnLimit: 80, AccessModifierOffset: -3 }"
59+
- name: Git Push
60+
run: git push --force origin HEAD:$GITHUB_REF || true
61+
62+
update_directory_md:
63+
name: Update Directory.md
64+
needs: code_format
65+
runs-on: ubuntu-latest
66+
steps:
67+
- uses: actions/checkout@v2
68+
- uses: actions/setup-python@v1
69+
- name: pull latest commit
70+
run: git pull
71+
- name: Update DIRECTORY.md
72+
shell: python
73+
run: |
74+
import os
75+
from typing import Iterator
76+
77+
URL_BASE = "https://github.com/TheAlgorithms/C-Plus-Plus/blob/master"
78+
g_output = []
79+
80+
def good_filepaths(top_dir: str = ".") -> Iterator[str]:
81+
cpp_exts = tuple(".c .c++ .cc .cpp .cu .cuh .cxx .h .h++ .hh .hpp .hxx".split())
82+
for dirpath, dirnames, filenames in os.walk(top_dir):
83+
dirnames[:] = [d for d in dirnames if d[0] not in "._"]
84+
for filename in filenames:
85+
if os.path.splitext(filename)[1].lower() in cpp_exts:
86+
yield os.path.join(dirpath, filename).lstrip("./")
87+
88+
def md_prefix(i):
89+
return f"{i * ' '}*" if i else "\n##"
90+
91+
def print_path(old_path: str, new_path: str) -> str:
92+
global g_output
93+
old_parts = old_path.split(os.sep)
94+
for i, new_part in enumerate(new_path.split(os.sep)):
95+
if i + 1 > len(old_parts) or old_parts[i] != new_part:
96+
if new_part:
97+
g_output.append(f"{md_prefix(i)} {new_part.replace('_', ' ').title()}")
98+
return new_path
99+
100+
def build_directory_md(top_dir: str = ".") -> str:
101+
global g_output
102+
old_path = ""
103+
for filepath in sorted(good_filepaths(), key=str.lower):
104+
filepath, filename = os.path.split(filepath)
105+
if filepath != old_path:
106+
old_path = print_path(old_path, filepath)
107+
indent = (filepath.count(os.sep) + 1) if filepath else 0
108+
url = "/".join((URL_BASE, filepath, filename)).replace(" ", "%20")
109+
filename = os.path.splitext(filename.replace("_", " ").title())[0]
110+
g_output.append(f"{md_prefix(indent)} [{filename}]({url})")
111+
return "# List of all files\n" + "\n".join(g_output)
112+
113+
with open("DIRECTORY.md", "w") as out_file:
114+
out_file.write(build_directory_md(".") + "\n")
115+
- name: Update DIRECTORY.md
116+
run: |
117+
cat DIRECTORY.md
118+
git config --global user.name github-actions
119+
git config --global user.email '${GITHUB_ACTOR}@users.noreply.github.com'
120+
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
121+
git add DIRECTORY.md
122+
git commit -am "updating DIRECTORY.md" || true
123+
git push --force origin HEAD:$GITHUB_REF || true
124+
125+
# cpplint:
126+
# name: CPPLINT
127+
# needs: code_format
128+
# runs-on: ubuntu-latest
129+
# steps:
130+
# - uses: actions/checkout@master
131+
# - uses: actions/setup-python@master
132+
# - run: pip install cpplint
133+
# - run: git pull
134+
# - run: cpplint --filter=-legal --recursive .
135+
136+
cpplint_modified_files:
137+
runs-on: ubuntu-latest
138+
needs: code_format
139+
name: CPPLINT
140+
steps:
141+
- uses: actions/checkout@master # v2 is broken for git diff
142+
- uses: actions/setup-python@master
143+
- run: python -m pip install cpplint
144+
- run: git remote -v
145+
- run: git branch
146+
- run: git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
147+
- run: git pull
148+
- run: git diff --diff-filter=dr --name-only origin/master > git_diff.txt
149+
- run: echo "Files changed-- `cat git_diff.txt`"
150+
- name: cpplint_modified_files
151+
shell: python
152+
run: |
153+
import os
154+
import subprocess
155+
import sys
156+
157+
print("Python {}.{}.{}".format(*sys.version_info)) # Python 3.8
158+
with open("git_diff.txt") as in_file:
159+
modified_files = sorted(in_file.read().splitlines())
160+
print("{} files were modified.".format(len(modified_files)))
161+
162+
cpp_exts = tuple(".c .c++ .cc .cpp .cu .cuh .cxx .h .h++ .hh .hpp .hxx".split())
163+
cpp_files = [file for file in modified_files if file.lower().endswith(cpp_exts)]
164+
print(f"{len(cpp_files)} C++ files were modified.")
165+
if not cpp_files:
166+
sys.exit(0)
167+
168+
print("cpplint:")
169+
for cpp_file in cpp_files:
170+
subprocess.run(["cpplint", "--filter=-legal/copyright,-build/include", cpp_file], check=True, text=True)
171+
172+
# print("g++:")
173+
# compile_exts = tuple(".c .c++ .cc .cpp .cu .cxx".split())
174+
# compile_files = [file for file in cpp_files if file.lower().endswith(compile_exts)]
175+
# for cpp_file in cpp_files:
176+
# subprocess.run(["g++", cpp_file], check=True, text=True)
177+
178+
upper_files = [file for file in cpp_files if file != file.lower()]
179+
if upper_files:
180+
print(f"{len(upper_files)} files contain uppercase characters:")
181+
print("\n".join(upper_files) + "\n")
182+
183+
space_files = [file for file in cpp_files if " " in file or "-" in file]
184+
if space_files:
185+
print(f"{len(space_files)} files contain space or dash characters:")
186+
print("\n".join(space_files) + "\n")
187+
188+
nodir_files = [file for file in cpp_files if file.count(os.sep) != 1]
189+
if nodir_files:
190+
print(f"{len(nodir_files)} files are not in one and only one directory:")
191+
print("\n".join(nodir_files) + "\n")
192+
193+
bad_files = len(upper_files + space_files + nodir_files)
194+
if bad_files:
195+
sys.exit(bad_files)
196+
197+
build:
198+
name: Compile checks
199+
runs-on: ${{ matrix.os }}
200+
# needs: [cpplint, update_directory_md, cpplint_modified_files]
201+
needs: [update_directory_md]
202+
strategy:
203+
matrix:
204+
os: [ubuntu-latest, windows-latest, macOS-latest]
205+
steps:
206+
- uses: actions/checkout@master
207+
with:
208+
submodules: true
209+
- run: git pull
210+
- run: cmake -B ./build -S .
211+
- run: cmake --build build

‎.github/workflows/cpplint.yml‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎.github/workflows/cpplint_modified_files.yml‎

Lines changed: 0 additions & 64 deletions
This file was deleted.

‎.github/workflows/gh-pages.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Doxygen CI
2+
3+
on:
4+
push:
5+
branches: [master]
6+
7+
jobs:
8+
build:
9+
runs-on: macos-latest
10+
steps:
11+
- uses: actions/checkout@master
12+
with:
13+
submodules: true
14+
- name: Install requirements
15+
run: |
16+
brew install graphviz ninja doxygen
17+
- name: configure
18+
run: cmake -G Ninja -B ./build -S .
19+
- name: build
20+
run: cmake --build build -t doc
21+
- name: gh-pages
22+
uses: actions/checkout@master
23+
with:
24+
ref: "gh-pages"
25+
clean: false
26+
- name: Move & Commit files
27+
run: |
28+
git config --global user.name github-actions
29+
git config --global user.email '${GITHUB_ACTOR}@users.noreply.github.com'
30+
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
31+
rm -rf d* && rm *.html && rm *.svg && rm *.map && rm *.md5 && rm *.png && rm *.js && rm *.css
32+
git add .
33+
cp -rp ./build/html/* . && rm -rf ./build && ls -lah
34+
git add .
35+
git commit -m "Documentation for $GITHUB_SHA" || true
36+
git push --force || true

‎.github/workflows/sorting_non_recursive_merge_sort.yml‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)