From 9379ae1a6c0731780c0b5260a553051ab5a46d82 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Fri, 26 Jun 2020 13:46:46 -0400
Subject: [PATCH 01/13] added LGTM status
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 8734158b7..a6cde5f50 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# The Algorithms - C++ # {#mainpage}
-[](https://gitpod.io/#https://github.com/TheAlgorithms/C-Plus-Plus)
+[](https://gitpod.io/#https://github.com/TheAlgorithms/C-Plus-Plus) [](https://lgtm.com/projects/g/TheAlgorithms/C-Plus-Plus/context:cpp)
[](https://gitter.im/TheAlgorithms)
From b3d85cd8e158bb6482735101762f6f73d6348e74 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Fri, 26 Jun 2020 14:23:25 -0400
Subject: [PATCH 02/13] add LGTM status + remove HTML tags and use Markdown
syntax
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
---
README.md | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index a6cde5f50..53320a5b1 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,12 @@
# The Algorithms - C++ # {#mainpage}
+
[](https://gitpod.io/#https://github.com/TheAlgorithms/C-Plus-Plus) [](https://lgtm.com/projects/g/TheAlgorithms/C-Plus-Plus/context:cpp)
[](https://gitter.im/TheAlgorithms)
-
+[]("https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md")
-
-
+[]("https://TheAlgorithms.github.io/C-Plus-Plus")
+[]("https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22")
[Online Documentation](https://TheAlgorithms.github.io/C-Plus-Plus).
From c5933c8525452c300ef961881bf883646db359dc Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Fri, 26 Jun 2020 14:29:10 -0400
Subject: [PATCH 03/13] updated project summary description
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
---
README.md | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 53320a5b1..aa0f96e80 100644
--- a/README.md
+++ b/README.md
@@ -8,12 +8,15 @@
[]("https://TheAlgorithms.github.io/C-Plus-Plus")
[]("https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22")
-[Online Documentation](https://TheAlgorithms.github.io/C-Plus-Plus).
+## Algorithms implemented in C++ (for education)
+The repository is a collection of implementation of a variety of algorithms implemented in C++. These algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations are meant to be a learning resource for educators and students. Hence, one may find more than one implementation for the same algorithm with different optimizations and different strategies used that would be documented therein.
+
+## Documentation
+
+[Online Documentation](https://TheAlgorithms.github.io/C-Plus-Plus) is generated from the repository source codes directly. The documentation contains all resources including source code snippets, details on execution of the programs, diagrammatic representation of program flow, and links to external resources where necessary. The documentation also introduces interactive source code with links to documentation for C++ STL library functions used.
Click on [Files menu](https://TheAlgorithms.github.io/C-Plus-Plus/files.html) to see the list of all the files documented with the code.
-### Algorithms implemented in C++ (for education)
-The implementations are for learning purpose. They may be less efficient than the implementation in the standard library.
+## Contributions
-### Contribute Guidelines
-Read our [Contribution Guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md) before you contribute.
+As a community developed and community maintained repository, we welcome new un-plagiarized contributions. Read our [Contribution Guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md) before you contribute.
From aa16f4d113c028be73c9871d554b95e233ede32d Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Fri, 26 Jun 2020 14:29:45 -0400
Subject: [PATCH 04/13] added features description
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index aa0f96e80..bb8d32dcb 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,16 @@
The repository is a collection of implementation of a variety of algorithms implemented in C++. These algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations are meant to be a learning resource for educators and students. Hence, one may find more than one implementation for the same algorithm with different optimizations and different strategies used that would be documented therein.
+## Features
+
+* The repository provides implementations of various algorithms in one of the most fundamental general purpose languages - [C++](https://en.wikipedia.org/wiki/C%2B%2B).
+* Well documented source code with detailed explanations provide a valuable resource for educators and students alike.
+* Each source code is atomic using [STL classes](https://en.wikipedia.org/wiki/Standard_Template_Library) and _no external libraries_ are required for their compilation and execution. Thus the fundamentals of the algorithms can be studied in much depth.
+* Source codes are [compiled and tested](https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22) for every commit on the latest versions of three major operating systems Windows, MacOS and Ubuntu (Linux) using MSVC 16 2019, AppleClang 11.0 and GNU 7.5.0 respectively.
+* Strict adherence [C++11](https://en.wikipedia.org/wiki/C%2B%2B11) standard ensures portability of code to embedded systems as well like ESP32, ARM Cortex, etc with little to no changes.
+* Self-checks within programs ensure correct implementations with confidence.
+* Modular implementations and OpenSource licensing enable the functions to be utilized conveniently in other applications.
+
## Documentation
[Online Documentation](https://TheAlgorithms.github.io/C-Plus-Plus) is generated from the repository source codes directly. The documentation contains all resources including source code snippets, details on execution of the programs, diagrammatic representation of program flow, and links to external resources where necessary. The documentation also introduces interactive source code with links to documentation for C++ STL library functions used.
From 54dcadf07d5e7810655172fb9ed9f3b94e714c2a Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Fri, 26 Jun 2020 14:38:03 -0400
Subject: [PATCH 05/13] fix contributions description
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index bb8d32dcb..f711c58b8 100644
--- a/README.md
+++ b/README.md
@@ -29,4 +29,4 @@ Click on [Files menu](https://TheAlgorithms.github.io/C-Plus-Plus/files.html) to
## Contributions
-As a community developed and community maintained repository, we welcome new un-plagiarized contributions. Read our [Contribution Guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md) before you contribute.
+As a community developed and community maintained repository, we welcome new un-plagiarized quality contributions. Please read our [Contribution Guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md).
From a9c005da70569a168ffaf17ddd3ee286a6bd31dd Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Fri, 26 Jun 2020 14:49:05 -0400
Subject: [PATCH 06/13] overview + comment why mainpage
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
---
README.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index f711c58b8..0dfb173bf 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# The Algorithms - C++ # {#mainpage}
+
[](https://gitpod.io/#https://github.com/TheAlgorithms/C-Plus-Plus) [](https://lgtm.com/projects/g/TheAlgorithms/C-Plus-Plus/context:cpp)
[](https://gitter.im/TheAlgorithms)
@@ -8,7 +9,7 @@
[]("https://TheAlgorithms.github.io/C-Plus-Plus")
[]("https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22")
-## Algorithms implemented in C++ (for education)
+## Overview
The repository is a collection of implementation of a variety of algorithms implemented in C++. These algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations are meant to be a learning resource for educators and students. Hence, one may find more than one implementation for the same algorithm with different optimizations and different strategies used that would be documented therein.
@@ -18,7 +19,7 @@ The repository is a collection of implementation of a variety of algorithms impl
* Well documented source code with detailed explanations provide a valuable resource for educators and students alike.
* Each source code is atomic using [STL classes](https://en.wikipedia.org/wiki/Standard_Template_Library) and _no external libraries_ are required for their compilation and execution. Thus the fundamentals of the algorithms can be studied in much depth.
* Source codes are [compiled and tested](https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22) for every commit on the latest versions of three major operating systems Windows, MacOS and Ubuntu (Linux) using MSVC 16 2019, AppleClang 11.0 and GNU 7.5.0 respectively.
-* Strict adherence [C++11](https://en.wikipedia.org/wiki/C%2B%2B11) standard ensures portability of code to embedded systems as well like ESP32, ARM Cortex, etc with little to no changes.
+* Strict adherence to [C++11](https://en.wikipedia.org/wiki/C%2B%2B11) standard ensures portability of code to embedded systems as well like ESP32, ARM Cortex, etc with little to no changes.
* Self-checks within programs ensure correct implementations with confidence.
* Modular implementations and OpenSource licensing enable the functions to be utilized conveniently in other applications.
From 8f72445a6dcce05be377bcaf31495385c0f1baf4 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Fri, 26 Jun 2020 20:14:36 -0400
Subject: [PATCH 07/13] minor punctuations
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 0dfb173bf..e5755c3a5 100644
--- a/README.md
+++ b/README.md
@@ -18,8 +18,8 @@ The repository is a collection of implementation of a variety of algorithms impl
* The repository provides implementations of various algorithms in one of the most fundamental general purpose languages - [C++](https://en.wikipedia.org/wiki/C%2B%2B).
* Well documented source code with detailed explanations provide a valuable resource for educators and students alike.
* Each source code is atomic using [STL classes](https://en.wikipedia.org/wiki/Standard_Template_Library) and _no external libraries_ are required for their compilation and execution. Thus the fundamentals of the algorithms can be studied in much depth.
-* Source codes are [compiled and tested](https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22) for every commit on the latest versions of three major operating systems Windows, MacOS and Ubuntu (Linux) using MSVC 16 2019, AppleClang 11.0 and GNU 7.5.0 respectively.
-* Strict adherence to [C++11](https://en.wikipedia.org/wiki/C%2B%2B11) standard ensures portability of code to embedded systems as well like ESP32, ARM Cortex, etc with little to no changes.
+* Source codes are [compiled and tested](https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22) for every commit on the latest versions of three major operating systems viz., Windows, MacOS and Ubuntu (Linux) using MSVC 16 2019, AppleClang 11.0 and GNU 7.5.0 respectively.
+* Strict adherence to [C++11](https://en.wikipedia.org/wiki/C%2B%2B11) standard ensures portability of code to embedded systems as well like ESP32, ARM Cortex, etc. with little to no changes.
* Self-checks within programs ensure correct implementations with confidence.
* Modular implementations and OpenSource licensing enable the functions to be utilized conveniently in other applications.
From 0f42f8f96ca404a90ef9b9a24293782c00f8505e Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Fri, 26 Jun 2020 20:20:43 -0400
Subject: [PATCH 08/13] apply suggestions by reviewers
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index e5755c3a5..e99ec1311 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@
## Overview
-The repository is a collection of implementation of a variety of algorithms implemented in C++. These algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations are meant to be a learning resource for educators and students. Hence, one may find more than one implementation for the same algorithm with different optimizations and different strategies used that would be documented therein.
+The repository is a collection of implementation of a variety of algorithms implemented in C++. These algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations and the associated documentation are meant to provide a learning resource for educators and students. Hence, one may find more than one implementation for the same objective but using a different algorithm strategies and optimizations.
## Features
@@ -30,4 +30,4 @@ Click on [Files menu](https://TheAlgorithms.github.io/C-Plus-Plus/files.html) to
## Contributions
-As a community developed and community maintained repository, we welcome new un-plagiarized quality contributions. Please read our [Contribution Guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md).
+As a community developed and maintained repository, we welcome new un-plagiarized quality contributions. Please read our [Contribution Guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md).
From 988df1ba59a9895dfab2293d63bca5b400f16847 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Sat, 27 Jun 2020 16:59:31 -0400
Subject: [PATCH 09/13] added licenses - #911
---
README.md | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index e99ec1311..9b79c11ef 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@
## Overview
-The repository is a collection of implementation of a variety of algorithms implemented in C++. These algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations and the associated documentation are meant to provide a learning resource for educators and students. Hence, one may find more than one implementation for the same objective but using a different algorithm strategies and optimizations.
+The repository is a collection of open-source implementation of a variety of algorithms implemented in C++ and licensed under [MIT License](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/LICENSE). These algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations and the associated documentation are meant to provide a learning resource for educators and students. Hence, one may find more than one implementation for the same objective but using a different algorithm strategies and optimizations.
## Features
@@ -28,6 +28,9 @@ The repository is a collection of implementation of a variety of algorithms impl
[Online Documentation](https://TheAlgorithms.github.io/C-Plus-Plus) is generated from the repository source codes directly. The documentation contains all resources including source code snippets, details on execution of the programs, diagrammatic representation of program flow, and links to external resources where necessary. The documentation also introduces interactive source code with links to documentation for C++ STL library functions used.
Click on [Files menu](https://TheAlgorithms.github.io/C-Plus-Plus/files.html) to see the list of all the files documented with the code.
+[Documentation of Algorithms in C++](https://thealgorithms.github.io/C-Plus-Plus) by [The Algorithms Contributors](https://github.com/TheAlgorithms) is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1)
+
+
## Contributions
As a community developed and maintained repository, we welcome new un-plagiarized quality contributions. Please read our [Contribution Guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md).
From 2d67ce3f52c3924b258667d4148905922054eb80 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Sat, 27 Jun 2020 17:06:10 -0400
Subject: [PATCH 10/13] fix article `the`
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 9b79c11ef..1d4186d5d 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@
## Overview
-The repository is a collection of open-source implementation of a variety of algorithms implemented in C++ and licensed under [MIT License](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/LICENSE). These algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations and the associated documentation are meant to provide a learning resource for educators and students. Hence, one may find more than one implementation for the same objective but using a different algorithm strategies and optimizations.
+The repository is a collection of open-source implementation of a variety of algorithms implemented in C++ and licensed under [MIT License](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/LICENSE). The algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations and the associated documentation are meant to provide a learning resource for educators and students. Hence, one may find more than one implementation for the same objective but using a different algorithm strategies and optimizations.
## Features
From 998c1ce9be4deb4ae7d6098524ead0748c48c2c7 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Sat, 27 Jun 2020 17:06:59 -0400
Subject: [PATCH 11/13] remove closed pull-requests info graphic
---
README.md | 1 -
1 file changed, 1 deletion(-)
diff --git a/README.md b/README.md
index 1d4186d5d..9db8e85ba 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,6 @@
[](https://gitter.im/TheAlgorithms)
[]("https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md")
-
[]("https://TheAlgorithms.github.io/C-Plus-Plus")
[]("https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22")
From 695851b2888e143d15eaab00172f38a1eca7f841 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Sat, 27 Jun 2020 17:11:19 -0400
Subject: [PATCH 12/13] fix alternatie text for 'by' icon
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 9db8e85ba..417d5769f 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ The repository is a collection of open-source implementation of a variety of alg
Click on [Files menu](https://TheAlgorithms.github.io/C-Plus-Plus/files.html) to see the list of all the files documented with the code.
[Documentation of Algorithms in C++](https://thealgorithms.github.io/C-Plus-Plus) by [The Algorithms Contributors](https://github.com/TheAlgorithms) is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1)
-
+
## Contributions
From de828baa8deed53c9547ea8b2c4d78637039fd75 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Sat, 27 Jun 2020 21:13:48 -0400
Subject: [PATCH 13/13] removed incorrect quotes from links
---
README.md | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 417d5769f..f499f06e7 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,13 @@
# The Algorithms - C++ # {#mainpage}
-[](https://gitpod.io/#https://github.com/TheAlgorithms/C-Plus-Plus) [](https://lgtm.com/projects/g/TheAlgorithms/C-Plus-Plus/context:cpp)
+[](https://gitpod.io/#https://github.com/TheAlgorithms/C-Plus-Plus)
+[](https://lgtm.com/projects/g/TheAlgorithms/C-Plus-Plus/context:cpp)
[](https://gitter.im/TheAlgorithms)
-[]("https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md")
+[](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md)
-[]("https://TheAlgorithms.github.io/C-Plus-Plus")
-[]("https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22")
+[](https://TheAlgorithms.github.io/C-Plus-Plus)
+[](https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22)
## Overview