[esp] Add Rust example with std.

+ Sitemap generator I created while learning the dispose pattern
+ Testing project for learning general C#

.gitignore

@@ -10,3 +10,5 @@
 **/Makefile
 **/*.cbp
 **/node-modules/
+**/CMakeLists.txt.user
+**/catch2/bin/

README.md

@@ -2,12 +2,16 @@
 
 This repository is a collection of useful code snippets and configurations.
 
-```
-github.com/shaunrd0/klips/
+```bash
+shaunrd0/klips/
 ├── ansible     # Ansible roles, playbooks, and examples
 ├── blockchain  # Blockchain related project templates and examples
 ├── cpp         # C++ programs, datastructures, and other examples
+├── dotnet      # .NET projects and examples
+├── esp         # ESP32 projects and examples
 ├── figlet      # Figlet fonts I like :)
-├── README.md   
-└── scripts     # Bash scripts
+├── javascript  # Javascript projects and examples
+├── python      # Python scripts and tools I've made
+├── scripts     # Bash scripts
+└── README.md
 ```

ansible/README.md

@@ -1,4 +1,4 @@
-# Ansible 
+# ansible
 
 A few simple roles / plays I've put together in learning how to use Ansible can be found under their corresponding directories.
 

blockchain/eth/truffle-solidity/README.md

@@ -1,3 +1,4 @@
+# blockchain
 
 A template project for getting started working on the Ethereum blockchain.
 This project comes with basic packages for compiling and deploying Solidity contracts with Truffle.
@@ -72,7 +73,7 @@ I explain how to configure metamask on ropsten on [Knoats - Solidity](https://kn
 
 Give yourself test Ethereum with the [Ropsten ETH Faucet](https://faucet.ropsten.be)
 
-To deploy to ropsten test network, and verify using `truffle-verify-plugin` - 
+To deploy to ropsten test network, and verify using `truffle-verify-plugin` -
 
 ```asm
 npx truffle migrate --network ropsten

cpp/CMakeLists.txt

@@ -1,13 +1,13 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A root project for practicing C++                                  ##
-##        This project can be built to debug and run all nested projects     ##
-##        Or, any subdirectory with a project() statement can be selected    ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2025 Shaun Reed, all rights reserved                ##
+## About: A root project for practicing C++                                   ##
+##        This project can be built to debug and run all nested projects      ##
+##        Or, any subdirectory with a project() statement can be selected     ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
 project(
@@ -16,12 +16,49 @@ project(
     DESCRIPTION "A root project for several small cpp practice projects"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+add_compile_options("-Wall")
+
+option(KLIPS_CCACHE "Enable ccache" ON)
+
+if (KLIPS_CCACHE)
+  find_program(SCCACHE_PATH sccache)
+  if(SCCACHE_PATH)
+    message(STATUS "[Klips] Found sccache: ${SCCACHE_PATH}")
+    set(CMAKE_CXX_COMPILER_LAUNCHER ${SCCACHE_PATH})
+    set(CMAKE_C_COMPILER_LAUNCHER ${SCCACHE_PATH})
+  else()
+    message(STATUS "[Klips] Failed to find sccache, falling back to ccache.")
+    find_program(CCACHE_PATH ccache)
+    if(CCACHE_PATH)
+      message(STATUS "[Klips] Found ccache: ${CCACHE_PATH}")
+      set(CMAKE_CXX_COMPILER_LAUNCHER ${CCACHE_PATH})
+      set(CMAKE_C_COMPILER_LAUNCHER ${CCACHE_PATH})
+    else()
+      message(WARNING "[Klips] Failed to find sccache and ccache. Compilation will not be cached.")
+    endif()
+  endif()
+endif()
 
 add_subdirectory(algorithms)
-add_subdirectory(cmake)
+add_subdirectory(catch2)
+add_subdirectory(cmake-example)
 add_subdirectory(cryptography)
 add_subdirectory(datastructs)
 add_subdirectory(graphics)
+add_subdirectory(multithreading)
 add_subdirectory(patterns)
+
+find_package(Qt6 COMPONENTS UiPlugin Core Gui Widgets)
+if (NOT Qt6_FOUND)
+  message(
+      WARNING
+      "[Klips] Qt examples will not be built.\n"
+      "On Ubuntu 24.04 Qt6 can be installed using apt:\n"
+      "  sudo apt install qt6-base-dev qt6-tools-dev\n"
+  )
+else()
+  add_subdirectory(qt)
+endif()

cpp/README.md

@@ -1,21 +1,23 @@
-# Cpp
+# cpp
 
 ```bash
 shaunrd0/klips/cpp/
-├── algorithms    # Examples of various algorithms written in C++
-├── cmake         # Example of using cmake to build and organize larger projects
-├── cryptography  # Examples of encrypting / decrypting using ciphers in C++
-├── datastructs   # Collection of useful datastructures written in C++
-├── graphics      # Examples of graphics projects written in C++
-├── patterns      # Examples of various design patterns written in C++
+├── algorithms     # Examples of various algorithms written in C++
+├── cmake          # Example of using cmake to build and organize larger projects
+├── cryptography   # Examples of encrypting / decrypting using ciphers in C++
+├── datastructs    # Collection of useful datastructures written in C++
+├── graphics       # Examples of graphics projects written in C++
+├── multithreading # Basic multithreading examples in C++
+├── patterns       # Examples of various design patterns written in C++
+├── qt             # Qt project examples using C++
 └── README.md
 ```
 
-This directory contains a `CMakeLists.txt`, which can be selected to open as a 
+This directory contains a `CMakeLists.txt`, which can be selected to open as a
 project within your preferred IDE. From there, all nested examples can be built,
 debugged, and ran.
 
-Some of the more recent projects in this repository requires the latest CMake LTS. 
+Some of the more recent projects in this repository requires the latest CMake LTS.
 To install `cmake` LTS with `apt` we can follow [official instructions from kitware](https://apt.kitware.com/)
 Alternatively, we can install the LTS with python's `pip`.
 ```bash
@@ -32,7 +34,7 @@ cmake version 3.22.1
 
 Once cmake is installed, dependencies for all examples can be installed with the command below.
 ```bash
-sudo apt install libsdl2-dev freeglut3-dev 
+sudo apt install libsdl2-dev freeglut3-dev
 ```
 
 If we build from this directory, we build all C++ projects and examples
@@ -61,7 +63,7 @@ graph-test-object            sdl-test              visitor-test
 graph-test-simple            select-sort
 ```
 
-We can also build from subdirectories. 
+We can also build from subdirectories.
 To only build projects related to design patterns we build from the `patterns/` subdirectory, for example
 ```bash
 cd /path/to/klips/cpp/patterns
@@ -78,5 +80,5 @@ adapter-test           factory-test  prototype-test  state-test
 
 If cmake is not being used in a project, it can be built with `g++` manually using
 the commands outlined in `*/.vscode/tasks.json`, or by using VSCode to open the example
-and running the build task. 
+and running the build task.
 Check the header comments in the main source file for the example for instructions.

cpp/algorithms/CMakeLists.txt

@@ -1,11 +1,11 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A root project for practicing algorithms in C++                    ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A root project for practicing algorithms in C++                     ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
 project (
@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing various algorithms in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/algorithms/graphs/CMakeLists.txt

@@ -1,11 +1,11 @@
 ###############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: A root project for practicing graph algorithms in C++              ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
 ##############################################################################
-#
+
 cmake_minimum_required(VERSION 3.15)
 
 project (
@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing algorithms using graphs in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/algorithms/graphs/object/CMakeLists.txt

@@ -1,11 +1,10 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
 ## About: A root project for practicing graph algorithms in C++               ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################
-#
 
 cmake_minimum_required(VERSION 3.15)
 
@@ -15,8 +14,9 @@ project(
     DESCRIPTION "Practice implementing and using object graphs in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-graph-object "lib-graph.cpp")
-
-add_executable(graph-test-object "graph.cpp")
-target_link_libraries(graph-test-object lib-graph-object)
+add_executable(
+    algo-graphs-object graph.cpp
+    lib-graph.cpp lib-graph.hpp
+)

cpp/algorithms/graphs/object/graph.cpp

@@ -1,8 +1,7 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
-## About: An example of an object graph implementation                        ##
-##        Algorithms in this example are found in MIT Intro to Algorithms     ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: Driver program to test object graph implementation                  ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################

cpp/algorithms/graphs/object/lib-graph.cpp

@@ -1,7 +1,8 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
-## About: Driver program to test object graph implementation                  ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of an object graph implementation                        ##
+##        Algorithms in this example are found in MIT Intro to Algorithms     ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################
@@ -183,4 +184,3 @@ std::vector<Node> Graph::TopologicalSort(const Node &startNode) const
   // + Output is handled in main as FILO, similar to a stack
   return order;
 }
-

cpp/algorithms/graphs/object/lib-graph.hpp

@@ -1,6 +1,6 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
 ## About: An example of an object graph implementation                        ##
 ##        Algorithms in this example are found in MIT Intro to Algorithms     ##
 ##                                                                            ##
@@ -10,51 +10,14 @@
 #ifndef LIB_GRAPH_HPP
 #define LIB_GRAPH_HPP
 
-#include <iostream>
 #include <algorithm>
+#include <iostream>
 #include <map>
+#include <queue>
+#include <unordered_map>
+#include <unordered_set>
 #include <utility>
 #include <vector>
-#include <queue>
-#include <unordered_set>
-#include <unordered_map>
-
-
-/******************************************************************************/
-// Structures for tracking information gathered from various traversals
-struct Node;
-// Color represents the discovery status of any given node
-// + White is undiscovered, Gray is in progress, Black is fully discovered
-enum Color {White, Gray, Black};
-
-// Information used in all searches
-struct SearchInfo {
-  // Coloring of the nodes is used in both DFS and BFS
-  Color discovered = White;
-};
-
-// Information that is only used in BFS
-struct BFS : SearchInfo {
-  // Used to represent distance from start node
-  int distance = 0;
-  // Used to represent the parent node that discovered this node
-  // + If we use this node as the starting point, this will remain a nullptr
-  const Node *predecessor = nullptr;
-};
-
-// Information that is only used in DFS
-struct DFS : SearchInfo {
-  // Create a pair to track discovery / finish time
-  // + Discovery time is the iteration the node is first discovered
-  // + Finish time is the iteration the node has been checked completely
-  // ++ A finished node has considered all adjacent nodes
-  std::pair<int, int> discoveryFinish;
-};
-
-// Store search information in unordered_maps so we can pass it around easily
-// + Allows each node to store relative information on the traversal
-using InfoBFS = std::unordered_map<int, struct BFS>;
-using InfoDFS = std::unordered_map<int, struct DFS>;
 
 
 /******************************************************************************/
@@ -63,14 +26,16 @@ struct Node {
 public:
   // Constructors
   Node(const Node &rhs) = default;
-  Node & operator=(Node rhs) {
+  Node & operator=(Node rhs)
+  {
     if (this == &rhs) return *this;
     swap(*this, rhs);
     return *this;
   }
   Node(int num, std::vector<int> adj) : number(num), adjacent(std::move(adj)) {}
 
-  friend void swap(Node &a, Node &b) {
+  friend void swap(Node &a, Node &b)
+  {
     std::swap(a.number, b.number);
     std::swap(a.adjacent, b.adjacent);
   }
@@ -85,8 +50,61 @@ public:
 };
 
 
+/******************************************************************************/
+// Base struct for storing traversal information on all nodes
+
+// Color represents the discovery status of any given node
+enum Color {
+  // Node is marked as undiscovered
+  White,
+  // Node discovery is in progress; Some adjacent nodes have not been checked
+  Gray,
+  // Node has been discovered; All adjacent nodes have been checked
+  Black
+};
+
+// Information used in all searches tracked for each node
+struct NodeInfo {
+  // Coloring of the nodes is used in both DFS and BFS
+  Color discovered = White;
+};
+
+
+/******************************************************************************/
+// BFS search information struct
+
+// Node information that is only used in BFS
+struct BFS : NodeInfo {
+  // Used to represent distance from start node
+  int distance = 0;
+  // Used to represent the parent node that discovered this node
+  // + If we use this node as the starting point, this will remain a nullptr
+  const Node *predecessor = nullptr;
+};
+
+// Store search information in unordered_maps so we can pass it around easily
+// + Allows each node to store relative information on the traversal
+using InfoBFS = std::unordered_map<int, struct BFS>;
+
+
+/******************************************************************************/
+// DFS search information struct
+
+// Node information that is only used in DFS
+struct DFS : NodeInfo {
+  // Create a pair to track discovery / finish time
+  // + Discovery time is the iteration the node is first discovered
+  // + Finish time is the iteration the node has been checked completely
+  // ++ A finished node has considered all adjacent nodes
+  std::pair<int, int> discoveryFinish;
+};
+
+using InfoDFS = std::unordered_map<int, struct DFS>;
+
+
 /******************************************************************************/
 // Graph class declaration
+
 class Graph {
 public:
   // Constructor
@@ -101,7 +119,7 @@ public:
   // An alternate DFS that checks each node of the graph beginning at startNode
   InfoDFS DFS(const Node &startNode) const;
   // Visit function is used in both versions of DFS
-  void DFSVisit(int &time, const Node& startNode, InfoDFS &searchInfo) const;
+  void DFSVisit(int &time, const Node& startNode, InfoDFS &dfs) const;
   // Topological sort, using DFS
   std::vector<Node> TopologicalSort(const Node &startNode) const;
 

cpp/algorithms/graphs/simple/CMakeLists.txt

@@ -1,11 +1,10 @@
 ###############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: A CMakeLists configuration to test a simple graph implementation   ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
 ##############################################################################
-#
 
 cmake_minimum_required(VERSION 3.15)
 
@@ -15,8 +14,9 @@ project(
     DESCRIPTION "Practice implementing and using simple graphs in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-graph-simple "lib-graph.cpp")
-
-add_executable(graph-test-simple "graph.cpp")
-target_link_libraries(graph-test-simple lib-graph-simple)
+add_executable(
+    algo-graphs-simple graph.cpp
+    lib-graph.cpp lib-graph.hpp
+)

cpp/algorithms/graphs/simple/graph.cpp

@@ -1,6 +1,6 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
 ## About: Driver program to test a simple graph implementation                ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##

cpp/algorithms/graphs/simple/lib-graph.cpp

@@ -1,6 +1,6 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
 ## About: An example of a simple graph implementation                         ##
 ##        Algorithms in this example are found in MIT Intro to Algorithms     ##
 ##                                                                            ##
@@ -8,9 +8,8 @@
 ################################################################################
 */
 
-#include <algorithm>
 #include "lib-graph.hpp"
-
+#include <algorithm>
 
 void Graph::BFS(int startNode)
 {

cpp/algorithms/graphs/simple/lib-graph.hpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example of a simple graph implementation                        ##
 ##        Algorithms in this example are found in MIT Intro to Algorithms    ##
 ##                                                                           ##
@@ -12,9 +12,10 @@
 
 #include <iostream>
 #include <queue>
-#include <vector>
 #include <unordered_map>
 #include <unordered_set>
+#include <vector>
+#include <cstdint>
 
 
 class Graph {

cpp/algorithms/graphs/templated/CMakeLists.txt

@@ -1,11 +1,10 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
 ## About: A basic CMakeLists to test templated graph implementation           ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################
-#
 
 cmake_minimum_required(VERSION 3.15)
 
@@ -15,8 +14,6 @@ project(
     DESCRIPTION "Practice implementing and using templated graphs in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-#add_library(lib-graph-templated "lib-graph.cpp")
-
-add_executable(graph-test-templated "graph.cpp")
-#target_link_libraries(graph-test-templated lib-graph-templated)
+add_executable(algo-graphs-templated graph.cpp)

cpp/algorithms/graphs/templated/graph.cpp

@@ -1,7 +1,7 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
-## About: An example of a weighted graph implementation                       ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: Driver program to test templated object graph implementation        ##
 ##        Algorithms in this example are found in MIT Intro to Algorithms     ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##

cpp/algorithms/graphs/templated/lib-graph.hpp

@@ -1,7 +1,7 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
-## About: An example of an object graph implementation                        ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of a templated object graph implementation               ##
 ##        Algorithms in this example are found in MIT Intro to Algorithms     ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
@@ -10,38 +10,89 @@
 #ifndef LIB_GRAPH_HPP
 #define LIB_GRAPH_HPP
 
-#include <iostream>
 #include <algorithm>
+#include <iostream>
 #include <map>
+#include <queue>
+#include <unordered_map>
+#include <unordered_set>
 #include <utility>
 #include <vector>
-#include <queue>
-#include <unordered_set>
-#include <unordered_map>
+#include <cstdint>
+
+
+/******************************************************************************/
+// Node structure for representing a graph
+
+template <typename T>
+struct Node {
+public:
+  template <typename> friend class Graph;
+  template <typename> friend class InfoMST;
+
+  // Constructors
+  Node(const Node &rhs) = default;
+  Node & operator=(Node rhs)
+  {
+    if (this == &rhs) return *this;
+    swap(*this, rhs);
+    return *this;
+  }
+  Node(T data, const std::vector<std::pair<T, int>> &adj) : data_(data)
+  {
+    // Place each adjacent node in vector into our unordered_map of edges
+    for (const auto &i : adj) adjacent_.emplace(i.first, i.second);
+  }
+
+  friend void swap(Node &a, Node &b)
+  {
+    std::swap(a.data_, b.data_);
+    std::swap(a.adjacent_, b.adjacent_);
+  }
+
+  // Operators
+  // Define operator== for std::find; And comparisons between nodes
+  bool operator==(const Node<T> &b) const { return this->data_ == b.data_;}
+  // Define an operator!= for comparing nodes for inequality
+  bool operator!=(const Node<T> &b) const { return this->data_ != b.data_;}
+
+  // Accessors
+  inline T GetData() const { return data_;}
+  inline std::unordered_map<int, int> GetAdjacent() const { return adjacent_;}
+
+private:
+  T data_;
+  // Adjacent stored in an unordered_map<adj.number, edgeWeight>
+  std::unordered_map<T, int> adjacent_;
+};
 
 
 /******************************************************************************/
 // Base struct for storing traversal information on all nodes
 
-template <typename T> struct Node;
-
 // Color represents the discovery status of any given node
-// + White is undiscovered, Gray is in progress, Black is fully discovered
-enum Color {White, Gray, Black};
+enum Color {
+  // Node is marked as undiscovered
+  White,
+  // Node discovery is in progress; Some adjacent nodes have not been checked
+  Gray,
+  // Node has been discovered; All adjacent nodes have been checked
+  Black
+};
 
-// Information used in all searches
-struct SearchInfo {
+// Information used in all searches tracked for each node
+struct NodeInfo {
   // Coloring of the nodes is used in both DFS and BFS
   Color discovered = White;
 };
 
 
 /******************************************************************************/
-// BFS search information structs
+// BFS search information struct
 
-// Information that is only used in BFS
+// Node information that is only used in BFS
 template <typename T>
-struct BFS : SearchInfo {
+struct BFS : NodeInfo {
   // Used to represent distance from start node
   int distance = 0;
   // Used to represent the parent node that discovered this node
@@ -49,12 +100,16 @@ struct BFS : SearchInfo {
   const Node<T> *predecessor = nullptr;
 };
 
+// Store search information in unordered_maps so we can pass it around easily
+// + Allows each node to store relative information on the traversal
+template <typename T> using InfoBFS = std::unordered_map<T, struct BFS<T>>;
+
 
 /******************************************************************************/
-// DFS search information structs
+// DFS search information struct
 
-// Information that is only used in DFS
-struct DFS : SearchInfo {
+// Node information that is only used in DFS
+struct DFS : NodeInfo {
   // Create a pair to track discovery / finish time
   // + Discovery time is the iteration the node is first discovered
   // + Finish time is the iteration the node has been checked completely
@@ -62,22 +117,16 @@ struct DFS : SearchInfo {
   std::pair<int, int> discoveryFinish;
 };
 
+template <typename T> using InfoDFS = std::unordered_map<T, struct DFS>;
+
 
 /******************************************************************************/
-// Alias types for storing search information structures
+// MST search information struct
 
-// Store search information in unordered_maps so we can pass it around easily
-// + Allows each node to store relative information on the traversal
-template <typename T> using InfoBFS = std::unordered_map<T, struct BFS<T>>;
-template <typename T> using InfoDFS = std::unordered_map<T, struct DFS>;
 // Edges stored as multimap<weight, pair<nodeA.data_, nodeB.data_>>
 template <typename T> using Edges = std::multimap<int, std::pair<T, T>>;
 
-
-/******************************************************************************/
-// MST search information structs
-
-struct MST : SearchInfo {
+struct MST : NodeInfo {
   int32_t parent = INT32_MIN;
   int rank = 0;
 };
@@ -86,8 +135,9 @@ template <typename T>
 struct InfoMST {
   template <typename> friend class Graph;
 
-  explicit InfoMST(const std::vector<Node<T>> &nodes) {
-    for (const auto &node : nodes){
+  explicit InfoMST(const std::vector<Node<T>> &nodes)
+  {
+    for (const auto &node : nodes) {
       // Initialize the default values for forest tracked by this struct
       // + This data is used in KruskalMST() to find the MST
       MakeSet(node.data_);
@@ -157,51 +207,6 @@ private:
 };
 
 
-/******************************************************************************/
-// Node structure for representing a graph
-
-template <typename T>
-struct Node {
-public:
-  template <typename> friend class Graph;
-  template <typename> friend class InfoMST;
-
-  // Constructors
-  Node(const Node &rhs) = default;
-  Node & operator=(Node rhs) {
-    if (this == &rhs) return *this;
-    swap(*this, rhs);
-    return *this;
-  }
-  Node(T data, const std::vector<std::pair<T, int>> &adj)
-  : data_(data)
-  {
-    // Place each adjacent node in vector into our unordered_map of edges
-    for (const auto &i : adj) adjacent_.emplace(i.first, i.second);
-  }
-
-  friend void swap(Node &a, Node &b) {
-    std::swap(a.data_, b.data_);
-    std::swap(a.adjacent_, b.adjacent_);
-  }
-
-  // Operators
-  // Define operator== for std::find; And comparisons between nodes
-  bool operator==(const Node<T> &b) const { return this->data_ == b.data_;}
-  // Define an operator!= for comparing nodes for inequality
-  bool operator!=(const Node<T> &b) const { return this->data_ != b.data_;}
-
-  // Accessors
-  inline T GetData() const { return data_;}
-  inline std::unordered_map<int, int> GetAdjacent() const { return adjacent_;}
-
-private:
-  T data_;
-  // Adjacent stored in an unordered_map<adj.number, edgeWeight>
-  std::unordered_map<T, int> adjacent_;
-};
-
-
 /******************************************************************************/
 // Templated graph class
 
@@ -209,7 +214,7 @@ template <class T>
 class Graph {
 public:
   // Constructor
-  Graph(std::vector<Node<T>> nodes) : nodes_(std::move(nodes)) {}
+  explicit Graph(std::vector<Node<T>> nodes) : nodes_(std::move(nodes)) {}
 
   // Breadth First Search
   InfoBFS<T> BFS(const Node<T>& startNode) const;

cpp/algorithms/graphs/weighted/CMakeLists.txt

@@ -1,11 +1,10 @@
 ################################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
 ## About: A basic CMakeLists configuration to test RBT implementation         ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################
-#
 
 cmake_minimum_required(VERSION 3.15)
 
@@ -15,8 +14,9 @@ project(
     DESCRIPTION "Practice implementing and using weighted graphs in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-graph-weighted "lib-graph.cpp")
-
-add_executable(graph-test-weighted "graph.cpp")
-target_link_libraries(graph-test-weighted lib-graph-weighted)
+add_executable(
+    algo-graphs-weighted graph.cpp
+    lib-graph.cpp lib-graph.hpp
+)

cpp/algorithms/graphs/weighted/graph.cpp

@@ -1,8 +1,7 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
-## About: An example of a weighted graph implementation                       ##
-##        Algorithms in this example are found in MIT Intro to Algorithms     ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: Driver program to test weighted graph implementation                ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################
@@ -105,7 +104,7 @@ int main (const int argc, const char * argv[])
   // + Chapter 22, Figure 22.4 on DFS
   // Unlike the simple-graph example, this final result matches MIT Algorithms
   // + Aside from the placement of the watch node, which is not connected
-  // +  This is because the node is visited after all other nodes are finished
+  // + This is because the node is visited after all other nodes are finished
   std::vector<Node> order =
       topologicalGraph.TopologicalSort(topologicalGraph.GetNodeCopy(6));
   std::cout << "\nTopological order: ";
@@ -157,11 +156,19 @@ int main (const int argc, const char * argv[])
           {9, {{3, 2}, {7, 6}}}
       }
   );
+  std::cout << "\nChecking weight traversing graph from node 1 using DFS...\n";
+  InfoDFS resultDFS = graphMST.DFS(graphMST.GetNodeCopy(1));
+  std::cout << "DFS total weight traversed: " << resultDFS.totalWeight << std::endl;
+
+  std::cout << "\nChecking weight traversing graph from node 1 using BFS...\n";
+  InfoBFS resultBFS = graphMST.BFS(graphMST.GetNodeCopy(1));
+  std::cout << "BFS total weight traversed: " << resultBFS.totalWeight << std::endl;
+
   InfoMST resultMST = graphMST.KruskalMST();
-  std::cout << "Finding MST using Kruskal's...\n\nMST result: \n";
+  std::cout << "\n\nFinding MST using Kruskal's...\n\nMST result: \n";
   for (const auto &edge : resultMST.edgesMST) {
     std::cout << "Connected nodes: " << edge.second.first << "->"
               << edge.second.second << " with weight of " << edge.first << "\n";
   }
-  std::cout << "Total MST weight: " << resultMST.weightMST << std::endl;
+  std::cout << "Total MST weight: " << resultMST.totalWeight << std::endl;
 }

cpp/algorithms/graphs/weighted/lib-graph.cpp

@@ -1,7 +1,8 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
-## About: Driver program to test object graph implementation                  ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of a weighted graph implementation                       ##
+##        Algorithms in this example are found in MIT Intro to Algorithms     ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################
@@ -13,13 +14,13 @@
 InfoBFS Graph::BFS(const Node& startNode) const
 {
   // Create local object to track the information gathered during traversal
-  InfoBFS searchInfo;
+  InfoBFS bfs;
 
   // Create a queue to visit discovered nodes in FIFO order
   std::queue<const Node *> visitQueue;
 
   // Mark the startNode as in progress until we finish checking adjacent nodes
-  searchInfo[startNode.number].discovered = Gray;
+  bfs.nodeInfo[startNode.number].discovered = Gray;
 
   // Visit the startNode
   visitQueue.push(&startNode);
@@ -30,17 +31,17 @@ InfoBFS Graph::BFS(const Node& startNode) const
     const Node * thisNode = visitQueue.front();
     visitQueue.pop();
     std::cout << "Visiting node " << thisNode->number << std::endl;
-
     // Check if we have already discovered all the adjacentNodes to thisNode
     for (const auto &adjacent : thisNode->adjacent) {
-      if (searchInfo[adjacent.first].discovered == White) {
+      if (bfs.nodeInfo[adjacent.first].discovered == White) {
         std::cout << "Found undiscovered adjacentNode: " << adjacent.first
-                  << "\n";
+                  << " with weight of " << adjacent.second << std::endl;
+        bfs.totalWeight += adjacent.second;
         // Mark the adjacent node as in progress
-        searchInfo[adjacent.first].discovered = Gray;
-        searchInfo[adjacent.first].distance =
-            searchInfo[thisNode->number].distance + 1;
-        searchInfo[adjacent.first].predecessor =
+        bfs.nodeInfo[adjacent.first].discovered = Gray;
+        bfs.nodeInfo[adjacent.first].distance =
+            bfs.nodeInfo[thisNode->number].distance + 1;
+        bfs.nodeInfo[adjacent.first].predecessor =
             &GetNode(thisNode->number);
 
         // Add the discovered node the the visitQueue
@@ -48,11 +49,11 @@ InfoBFS Graph::BFS(const Node& startNode) const
       }
     }
     // We are finished with this node and the adjacent nodes; Mark it discovered
-    searchInfo[thisNode->number].discovered = Black;
+    bfs.nodeInfo[thisNode->number].discovered = Black;
   }
 
   // Return the information gathered from this search, JIC caller needs it
-  return searchInfo;
+  return bfs;
 }
 
 std::deque<Node> Graph::PathBFS(const Node &start, const Node &finish) const
@@ -61,8 +62,8 @@ std::deque<Node> Graph::PathBFS(const Node &start, const Node &finish) const
   // + If the caller modifies these, it will not impact the graph's data
   std::deque<Node> path;
 
-  InfoBFS searchInfo = BFS(start);
-  const Node * next = searchInfo[finish.number].predecessor;
+  InfoBFS bfs = BFS(start);
+  const Node * next = bfs.nodeInfo[finish.number].predecessor;
   bool isValid = false;
   do {
     // If we have reached the start node, we have found a valid path
@@ -73,7 +74,7 @@ std::deque<Node> Graph::PathBFS(const Node &start, const Node &finish) const
     path.emplace_front(*next);
 
     // Move to the next node
-    next = searchInfo[next->number].predecessor;
+    next = bfs.nodeInfo[next->number].predecessor;
   } while (next != nullptr);
   // Use emplace_back to call Node copy constructor
   path.emplace_back(finish);
@@ -88,85 +89,83 @@ std::deque<Node> Graph::PathBFS(const Node &start, const Node &finish) const
 InfoDFS Graph::DFS() const
 {
   // Track the nodes we have discovered
-  InfoDFS searchInfo;
+  InfoDFS dfs;
   int time = 0;
 
   // Visit each node in the graph
-  for (const auto& node : nodes_) {
+  for (const auto & node : nodes_) {
     std::cout << "Visiting node " << node.number << std::endl;
     // If the node is undiscovered, visit it
-    if (searchInfo[node.number].discovered == White) {
+    if (dfs.nodeInfo[node.number].discovered == White) {
       std::cout << "Found undiscovered node: " << node.number << std::endl;
       // Visiting the undiscovered node will check it's adjacent nodes
-      DFSVisit(time, node, searchInfo);
+      DFSVisit(time, node, dfs);
     }
   }
 
-  return searchInfo;
+  return dfs;
 }
 
 InfoDFS Graph::DFS(const Node &startNode) const
 {
   // Track the nodes we have discovered
-  InfoDFS searchInfo;
+  InfoDFS dfs;
   int time = 0;
 
-  auto startIter = std::find(nodes_.begin(), nodes_.end(),
-                             Node(startNode.number, {})
-  );
-
+  auto startIter =
+      std::find(nodes_.begin(), nodes_.end(), Node(startNode.number, { }));
   // beginning at startNode, visit each node in the graph until we reach the end
   while (startIter != nodes_.end()) {
     std::cout << "Visiting node " << startIter->number << std::endl;
     // If the startIter is undiscovered, visit it
-    if (searchInfo[startIter->number].discovered == White) {
-      std::cout << "Found undiscovered node: " << startIter->number << std::endl;
+    if (dfs.nodeInfo[startIter->number].discovered == White) {
+      std::cout << "Found undiscovered node: " << startIter->number
+                << std::endl;
       // Visiting the undiscovered node will check it's adjacent nodes
-      DFSVisit(time, *startIter, searchInfo);
+      DFSVisit(time, *startIter, dfs);
     }
     startIter++;
   }
 
   // Once we reach the last node, check the beginning for unchecked nodes
   startIter = nodes_.begin();
-
   // Once we reach the initial startNode, we have checked all nodes
   while (*startIter != startNode) {
     std::cout << "Visiting node " << startIter->number << std::endl;
     // If the startIter is undiscovered, visit it
-    if (searchInfo[startIter->number].discovered == White) {
+    if (dfs.nodeInfo[startIter->number].discovered == White) {
       std::cout << "Found undiscovered node: " << startIter->number << std::endl;
       // Visiting the undiscovered node will check it's adjacent nodes
-      DFSVisit(time, *startIter, searchInfo);
+      DFSVisit(time, *startIter, dfs);
     }
     startIter++;
   }
 
-  return searchInfo;
+  return dfs;
 }
 
-void Graph::DFSVisit(int &time, const Node& startNode, InfoDFS &searchInfo) const
+void Graph::DFSVisit(int &time, const Node& startNode, InfoDFS &dfs) const
 {
-  searchInfo[startNode.number].discovered = Gray;
+  dfs.nodeInfo[startNode.number].discovered = Gray;
   time++;
-  searchInfo[startNode.number].discoveryFinish.first = time;
+  dfs.nodeInfo[startNode.number].discoveryFinish.first = time;
 
   // Check the adjacent nodes of the startNode
-  for (const auto &adjacent : startNode.adjacent) {
-    auto iter = std::find(nodes_.begin(), nodes_.end(),
-                          Node(adjacent.first, {}));
+  for (const auto & adjacent : startNode.adjacent) {
+    const auto node = GetNode(adjacent.first);
     // If the adjacentNode is undiscovered, visit it
     // + Offset by 1 to account for 0 index of discovered vector
-    if (searchInfo[iter->number].discovered == White) {
-      std::cout << "Found undiscovered adjacentNode: "
-                << GetNode(adjacent.first).number << std::endl;
+    if (dfs.nodeInfo[node.number].discovered == White) {
+      std::cout << "Found undiscovered adjacentNode: " << adjacent.first
+                << " with weight of " << adjacent.second << std::endl;
       // Visiting the undiscovered node will check it's adjacent nodes
-      DFSVisit(time, *iter, searchInfo);
+      dfs.totalWeight += adjacent.second;
+      DFSVisit(time, node, dfs);
     }
   }
-  searchInfo[startNode.number].discovered = Black;
+  dfs.nodeInfo[startNode.number].discovered = Black;
   time++;
-  searchInfo[startNode.number].discoveryFinish.second = time;
+  dfs.nodeInfo[startNode.number].discoveryFinish.second = time;
 }
 
 std::vector<Node> Graph::TopologicalSort(const Node &startNode) const
@@ -176,8 +175,8 @@ std::vector<Node> Graph::TopologicalSort(const Node &startNode) const
   std::vector<Node> order(nodes_);
 
   auto comp = [&topological](const Node &a, const Node &b) {
-    return (topological[a.number].discoveryFinish.second <
-      topological[b.number].discoveryFinish.second);
+    return (topological.nodeInfo[a.number].discoveryFinish.second <
+            topological.nodeInfo[b.number].discoveryFinish.second);
   };
 
   std::sort(order.begin(), order.end(), comp);
@@ -189,27 +188,26 @@ std::vector<Node> Graph::TopologicalSort(const Node &startNode) const
 
 InfoMST Graph::KruskalMST() const
 {
-  InfoMST searchInfo(nodes_);
+  InfoMST mst(nodes_);
   // The ctor for InfoMST initializes all edges within the graph into a multimap
   // + Key for multimap is edge weight, so they're already sorted in ascending
 
   // For each edge in the graph, check if they are part of the same tree
   // + Since we do not want to create a cycle in the MST forest -
   // + we don't connect nodes that are part of the same tree
-  for (const auto &edge : searchInfo.edges) {
+  for (const auto &edge : mst.edges) {
     // Two integers representing the node.number for the connected nodes
     const int u = edge.second.first;
     const int v = edge.second.second;
     // Check if the nodes are of the same tree
-    if (searchInfo.FindSet(u) != searchInfo.FindSet(v)) {
+    if (mst.FindSet(u) != mst.FindSet(v)) {
       // If they are not, add the edge to our MST
-      searchInfo.edgesMST.emplace(edge);
-      searchInfo.weightMST += edge.first;
+      mst.edgesMST.emplace(edge);
+      mst.totalWeight += edge.first;
       // Update the forest to reflect this change
-      searchInfo.Union(u, v);
+      mst.Union(u, v);
     }
   }
 
-  return searchInfo;
+  return mst;
 }
-

cpp/algorithms/graphs/weighted/lib-graph.hpp

@@ -1,7 +1,7 @@
 /*##############################################################################
 ## Author: Shaun Reed                                                         ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
-## About: An example of an object graph implementation                        ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of a weighted graph implementation                       ##
 ##        Algorithms in this example are found in MIT Intro to Algorithms     ##
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
@@ -10,56 +10,15 @@
 #ifndef LIB_GRAPH_HPP
 #define LIB_GRAPH_HPP
 
-#include <iostream>
 #include <algorithm>
+#include <iostream>
 #include <map>
+#include <queue>
+#include <unordered_map>
+#include <unordered_set>
 #include <utility>
 #include <vector>
-#include <queue>
-#include <unordered_set>
-#include <unordered_map>
-
-
-/******************************************************************************/
-// Structures for tracking information gathered from various traversals
-struct Node;
-// Color represents the discovery status of any given node
-// + White is undiscovered, Gray is in progress, Black is fully discovered
-enum Color {White, Gray, Black};
-
-// Information used in all searches
-struct SearchInfo {
-  // Coloring of the nodes is used in both DFS and BFS
-  Color discovered = White;
-};
-
-// Information that is only used in BFS
-struct BFS : SearchInfo {
-  // Used to represent distance from start node
-  int distance = 0;
-  // Used to represent the parent node that discovered this node
-  // + If we use this node as the starting point, this will remain a nullptr
-  const Node *predecessor = nullptr;
-};
-
-// Information that is only used in DFS
-struct DFS : SearchInfo {
-  // Create a pair to track discovery / finish time
-  // + Discovery time is the iteration the node is first discovered
-  // + Finish time is the iteration the node has been checked completely
-  // ++ A finished node has considered all adjacent nodes
-  std::pair<int, int> discoveryFinish;
-};
-
-struct MST : SearchInfo {
-  int32_t parent = INT32_MIN;
-  int rank = 0;
-};
-
-// Store search information in unordered_maps so we can pass it around easily
-// + Allows each node to store relative information on the traversal
-using InfoBFS = std::unordered_map<int, struct BFS>;
-using InfoDFS = std::unordered_map<int, struct DFS>;
+#include <cstdint>
 
 
 /******************************************************************************/
@@ -69,7 +28,8 @@ struct Node {
 public:
   // Constructors
   Node(const Node &rhs) = default;
-  Node & operator=(Node rhs) {
+  Node & operator=(Node rhs)
+  {
     if (this == &rhs) return *this;
     swap(*this, rhs);
     return *this;
@@ -80,7 +40,8 @@ public:
     for (const auto &i : adj) adjacent.emplace(i.first, i.second);
   }
 
-  friend void swap(Node &a, Node &b) {
+  friend void swap(Node &a, Node &b)
+  {
     std::swap(a.number, b.number);
     std::swap(a.adjacent, b.adjacent);
   }
@@ -95,10 +56,81 @@ public:
   bool operator!=(const Node &b) const { return this->number != b.number;}
 };
 
+
+/******************************************************************************/
+// Base struct for storing traversal information on all nodes
+
+// Color represents the discovery status of any given node
+enum Color {
+  // Node is marked as undiscovered
+  White,
+  // Node discovery is in progress; Some adjacent nodes have not been checked
+  Gray,
+  // Node has been discovered; All adjacent nodes have been checked
+  Black
+};
+
+// Information used in all searches tracked for each node
+struct NodeInfo {
+  // Coloring of the nodes is used in both DFS and BFS
+  Color discovered = White;
+};
+
+// Template for tracking graph information gathered during traversals
+// + Used for DFS, BFS, and MST
+template <typename T>
+struct GraphInfo {
+  // Store search information in unordered_maps so we can pass it around easily
+  // + Allows each node to store relative information on the traversal
+  std::unordered_map<int, T> nodeInfo;
+  // Track total weight for all traversals
+  int totalWeight = 0;
+};
+
+
+/******************************************************************************/
+// BFS search information struct
+
+// Node search information that is only used in BFS
+struct BFS : NodeInfo {
+  // Used to represent distance from start node
+  int distance = 0;
+  // Used to represent the parent node that discovered this node
+  // + If we use this node as the starting point, this will remain a nullptr
+  const Node *predecessor = nullptr;
+};
+
+struct InfoBFS : GraphInfo<BFS> {/* Members inherited from GraphInfo */};
+
+
+/******************************************************************************/
+// DFS search information struct
+
+// Information that is only used in DFS
+struct DFS : NodeInfo {
+  // Create a pair to track discovery / finish time
+  // + Discovery time is the iteration the node is first discovered
+  // + Finish time is the iteration the node has been checked completely
+  // ++ A finished node has considered all adjacent nodes
+  std::pair<int, int> discoveryFinish;
+};
+
+struct InfoDFS : GraphInfo<DFS> {/* Members inherited from GraphInfo */};
+
+
+/******************************************************************************/
+// MST search information struct
+
+struct MST : NodeInfo {
+  int32_t parent = INT32_MIN;
+  int rank = 0;
+};
+
 using Edges = std::multimap<int, std::pair<int, int>>;
-struct InfoMST {
-  explicit InfoMST(const std::vector<Node> &nodes) {
-    for (const auto &node : nodes){
+struct InfoMST : GraphInfo<MST>{
+  explicit InfoMST(const std::vector<Node> &nodes)
+  {
+    for (const auto &node : nodes) {
       // Initialize the default values for forest tracked by this struct
       // + This data is used in KruskalMST() to find the MST
       MakeSet(node.number);
@@ -113,20 +145,17 @@ struct InfoMST {
     }
   }
 
-  std::unordered_map<int, struct MST> searchInfo;
   // All of the edges within our graph
   // + Since each node stores its own edges, this is initialized in InfoMST ctor
   Edges edges;
 
   // A multimap of the edges found for our MST
   Edges edgesMST;
-  // The total weight of our resulting MST
-  int weightMST = 0;
 
   void MakeSet(int x)
   {
-    searchInfo[x].parent = x;
-    searchInfo[x].rank = 0;
+    nodeInfo[x].parent = x;
+    nodeInfo[x].rank = 0;
   }
 
   void Union(int x, int y)
@@ -136,29 +165,30 @@ struct InfoMST {
 
   void Link(int x, int y)
   {
-    if (searchInfo[x].rank > searchInfo[y].rank) {
-      searchInfo[y].parent = x;
+    if (nodeInfo[x].rank > nodeInfo[y].rank) {
+      nodeInfo[y].parent = x;
     }
     else {
-      searchInfo[x].parent = y;
-      if (searchInfo[x].rank == searchInfo[y].rank) {
-        searchInfo[y].rank += 1;
+      nodeInfo[x].parent = y;
+      if (nodeInfo[x].rank == nodeInfo[y].rank) {
+        nodeInfo[y].rank += 1;
       }
     }
   }
 
   int FindSet(int x)
   {
-    if (x != searchInfo[x].parent) {
-      searchInfo[x].parent = FindSet(searchInfo[x].parent);
+    if (x != nodeInfo[x].parent) {
+      nodeInfo[x].parent = FindSet(nodeInfo[x].parent);
     }
-    return searchInfo[x].parent;
+    return nodeInfo[x].parent;
   }
-
 };
 
+
 /******************************************************************************/
 // Graph class declaration
+
 class Graph {
 public:
   // Constructor
@@ -173,7 +203,7 @@ public:
   // An alternate DFS that checks each node of the graph beginning at startNode
   InfoDFS DFS(const Node &startNode) const;
   // Visit function is used in both versions of DFS
-  void DFSVisit(int &time, const Node& startNode, InfoDFS &searchInfo) const;
+  void DFSVisit(int &time, const Node& startNode, InfoDFS &dfs) const;
   // Topological sort, using DFS
   std::vector<Node> TopologicalSort(const Node &startNode) const;
   // Kruskal's MST

cpp/algorithms/sorting/CMakeLists.txt

@@ -1,11 +1,11 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A root project for practicing sorting algorithms in C++            ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A root project for practicing sorting algorithms in C++             ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
 project (
@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing various sorting algorithms in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/algorithms/sorting/bubble/CMakeLists.txt

@@ -1,6 +1,6 @@
 ###############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: A basic CMakeLists configuration to practice bubble sort           ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -9,7 +9,7 @@
 cmake_minimum_required(VERSION 3.16)
 project(BubbleSort LANGUAGES CXX)
 
-add_executable(bubble-sort "bubble-sort.cpp")
-
-add_library(lib-bubble "lib-bubble.cpp")
-target_link_libraries(bubble-sort lib-bubble)
+add_executable(
+    algo-sort-bubble bubble-sort.cpp
+    lib-bubble.cpp lib-bubble.hpp
+)

cpp/algorithms/sorting/bubble/bubble-sort.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of bubble sort using a custom library    ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/bubble/lib-bubble.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of bubble sort using a custom library    ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -15,9 +15,9 @@
 void BubbleSort(std::vector<int> &array)
 {
   // For each value within the set, starting at 0
-  for (int sortedPivot = 0; sortedPivot < array.size(); sortedPivot++) {
+  for (size_t sortedPivot = 0; sortedPivot < array.size(); sortedPivot++) {
     // Check every other remaining value in the set
-    for (int j = array.size() - 1; j > sortedPivot; j--) {
+    for (size_t j = array.size() - 1; j > sortedPivot; j--) {
       // Swap if the value at j is less than the value before it
       if (array[j] < array[j - 1]) {
         std::swap(array[j], array[j - 1]);

cpp/algorithms/sorting/bubble/lib-bubble.hpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of bubble sort using a custom library    ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/bucket/CMakeLists.txt

@@ -1,6 +1,6 @@
 ###############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: A basic CMakeLists configuration to practice bucket sort           ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -9,7 +9,7 @@
 cmake_minimum_required(VERSION 3.16)
 project(BucketSort LANGUAGES CXX)
 
-add_executable(bucket-sort "bucket-sort.cpp")
-
-add_library(lib-bucket "lib-bucket.cpp")
-target_link_libraries(bucket-sort lib-bucket)
+add_executable(
+    algo-sort-bucket bucket-sort.cpp
+    lib-bucket.cpp lib-bucket.hpp
+)

cpp/algorithms/sorting/bucket/bucket-sort.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of bucket sort using a custom library    ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/bucket/lib-bucket.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of bucket sort using a custom library    ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/bucket/lib-bucket.hpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of bucket sort using a custom library    ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/count/CMakeLists.txt

@@ -1,6 +1,6 @@
 ###############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: A basic CMakeLists configuration to practice counting sort         ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -9,7 +9,7 @@
 cmake_minimum_required(VERSION 3.16)
 project(CountingSort LANGUAGES CXX)
 
-add_executable(counting-sort "counting-sort.cpp")
-
-add_library(lib-counting "lib-counting.cpp")
-target_link_libraries(counting-sort lib-counting)
+add_executable(
+    algo-sort-counting counting-sort.cpp
+    lib-counting.cpp lib-counting.hpp
+)

cpp/algorithms/sorting/count/counting-sort.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of counting sort using a custom library  ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/count/lib-counting.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of counting sort using a custom library  ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -33,15 +33,19 @@ void CountingSort(std::vector<int> &array)
 
   // Count the values less than or equal to each element of tempArray
   // + Since each element stores its own count, just add the count at index i-1
-  for (size_t i = 1; i <= maxValue; i++) {
+  for (int32_t i = 1; i <= maxValue; i++) {
     tempArray[i] += tempArray[i - 1];
+    // tempArray[i] - 1 now represents the sorted 0-index pos for each value i
   }
 
+  // Step through the array from right-to-left and place each value in their pos
+  // + As we run into values lookup their position with tempArray[value]
   for (ssize_t arrayIndex = array.size() - 1; arrayIndex >= 0; arrayIndex--) {
-    // Store as references; Changes reflect on actual values within each array
     const int &arrayValue = array[arrayIndex];
+    // Store as reference; Changes to valueCount reflect within tempArray
     int &valueCount = tempArray[arrayValue];
     sortedArray[valueCount - 1] = arrayValue;
+    // Subtract from tempArray[arrayValue] to update position of next occurrence
     valueCount = valueCount - 1;
   }
 

cpp/algorithms/sorting/count/lib-counting.hpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of counting sort using a custom library  ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/heap/CMakeLists.txt

@@ -9,7 +9,8 @@
 cmake_minimum_required(VERSION 3.16)
 project(HeapSort LANGUAGES CXX)
 
-add_executable(heap-sort "heap-sort.cpp")
+add_executable(
+    algo-sort-heap heap-sort.cpp
+    lib-heap.cpp lib-heap.hpp
+)
 
-add_library(lib-heap "lib-heap.cpp")
-target_link_libraries(heap-sort lib-heap)

cpp/algorithms/sorting/heap/heap-sort.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of heap sort using a custom library      ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/heap/lib-heap.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of heap sort using a custom library      ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -17,7 +17,7 @@ size_t Parent(const size_t &index) { return index / 2;}
 size_t Left(const size_t &index) { return 2 * index + 1;}
 size_t Right(const size_t &index) { return (2 * index) + 2;}
 
-void MaxHeapify(std::vector<int> &array, size_t thisIndex, const int &heapSize)
+void MaxHeapify(std::vector<int> &array, size_t thisIndex, const size_t &heapSize)
 {
   // Get an index for the left and right nodes attached to thisIndex
   size_t l = Left(thisIndex);

cpp/algorithms/sorting/heap/lib-heap.hpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of heap sort using a custom library      ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -18,7 +18,7 @@ size_t Parent(const size_t &index);
 size_t Left(const size_t &index);
 size_t Right(const size_t &index);
 
-void MaxHeapify(std::vector<int> &array, size_t thisIndex, const int &heapSize);
+void MaxHeapify(std::vector<int> &array, size_t thisIndex, const size_t &heapSize);
 
 void BuildMaxHeap(std::vector<int> &array);
 

cpp/algorithms/sorting/insertion/CMakeLists.txt

@@ -1,15 +1,22 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A basic CMakeLists configuration to practice insertion sort        ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-###############################################################################
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A basic CMakeLists configuration to practice insertion sort         ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 
 cmake_minimum_required(VERSION 3.16)
-project(InsertionSort LANGUAGES CXX)
 
-add_executable(insertion-sort "insertion-sort.cpp")
+project (
+    #[[NAME]]   InsertionSort
+    VERSION     1.0
+    DESCRIPTION "A project for practicing insertion sort in C++"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-insertion "lib-insertion.cpp")
-target_link_libraries(insertion-sort lib-insertion)
+add_executable(
+    algo-sort-insertion insertion-sort.cpp
+    lib-insertion.cpp lib-insertion.hpp
+)

cpp/algorithms/sorting/insertion/insertion-sort.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of insertion sort using a custom library ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/insertion/lib-insertion.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of insertion sort using a custom library ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -9,14 +9,13 @@
 
 #include "lib-insertion.hpp"
 
-#include <algorithm>
 #include <vector>
 
 void InsertionSort(std::vector<int> &array)
 {
   // For each value, move left until we find sortedPosition for keyValue
   // + Starting with keyValue at array[1], to check sortedPosition at array[0]
-  for (int keyIndex = 1; keyIndex <= array.size(); keyIndex++) {
+  for (size_t keyIndex = 1; keyIndex <= array.size(); keyIndex++) {
     // Save the current key value
     // + We will look for the sorted position of this value
     const int keyValue = array[keyIndex];

cpp/algorithms/sorting/insertion/lib-insertion.hpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of insertion sort using a custom library ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/merge/CMakeLists.txt

@@ -1,15 +1,23 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2020 Shaun Reed, all rights reserved               ##
-## About: A basic CMakeLists configuration to practice merge sort            ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-###############################################################################
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A basic CMakeLists configuration to practice merge sort             ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 
 cmake_minimum_required(VERSION 3.17)
-project(MergeSort LANGUAGES CXX)
 
-add_executable(merge-sort "merge-sort.cpp")
+project (
+    #[[NAME]]   MergeSort
+    VERSION     1.0
+    DESCRIPTION "A project for practicing merge sort in C++"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+
+add_executable(
+    algo-sort-merge merge-sort.cpp
+    lib-merge.cpp lib-merge.h
+)
 
-add_library(lib-merge "lib-merge.cpp")
-target_link_libraries(merge-sort lib-merge)

cpp/algorithms/sorting/merge/lib-merge.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of merge sort using a custom library     ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -12,6 +12,7 @@
 #include <algorithm>
 #include <iostream>
 #include <vector>
+#include <cstdint>
 
 void MergeSort(std::vector<int> &array, size_t lhs, size_t rhs)
 {

cpp/algorithms/sorting/merge/lib-merge.h

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of merge sort using a custom library     ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/merge/merge-sort.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of merge sort using a custom library     ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/quick/CMakeLists.txt

@@ -1,15 +1,22 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A basic CMakeLists configuration to practice quick sort            ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-###############################################################################
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A basic CMakeLists configuration to practice quick sort             ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 
 cmake_minimum_required(VERSION 3.16)
-project(QuickSort LANGUAGES CXX)
 
-add_executable(quick-sort "quick-sort.cpp")
+project (
+    #[[NAME]]   QuickSort
+    VERSION     1.0
+    DESCRIPTION "A project for practicing quick sort in C++"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-quick "lib-quick.cpp")
-target_link_libraries(quick-sort lib-quick)
+add_executable(
+    algo-sort-quick quick-sort.cpp
+    lib-quick.cpp lib-quick.hpp
+)

cpp/algorithms/sorting/quick/lib-quick.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of quick sort using a custom library     ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -50,7 +50,7 @@ size_t Partition(std::vector<int> &array, size_t begin, size_t end)
   // + Return this value when done, so we know where the lhs partition ends
   ssize_t lhsIndex = begin - 1;
   // For each value within this partition, check for values < keyValue
-  for (int j = begin; j <= end - 1; j++) {
+  for (size_t j = begin; j <= end - 1; j++) {
     if (array[j] <= keyValue) {
       // Swap all values < keyValue into the lhs portion of array
       std::swap(array[++lhsIndex], array[j]);

cpp/algorithms/sorting/quick/lib-quick.hpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of quick sort using a custom library     ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/quick/quick-sort.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of quick sort using a custom library     ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/radix/CMakeLists.txt

@@ -1,17 +1,23 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A basic CMakeLists configuration to practice radix sort            ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-###############################################################################
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A basic CMakeLists configuration to practice radix sort             ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 
 cmake_minimum_required(VERSION 3.16)
-project(RadixSort LANGUAGES CXX)
 
-add_executable(radix-sort "radix-sort.cpp")
+project (
+    #[[NAME]]   RadixSort
+    VERSION     1.0
+    DESCRIPTION "A project for practicing radix sort in C++"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-radix-counting "lib-counting.cpp")
-add_library(lib-radix "lib-radix.cpp")
-
-target_link_libraries(radix-sort lib-radix lib-radix-counting)
+add_executable(
+    algo-sort-radix radix-sort.cpp
+    lib-counting.cpp lib-counting.hpp
+    lib-radix.cpp lib-radix.hpp
+)

cpp/algorithms/sorting/radix/lib-counting.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of counting sort using a custom library  ##
 ##        + In support of a radix sort implementation                        ##
 ##                                                                           ##
@@ -41,7 +41,7 @@ void CountingSort(std::vector<int> &array, int placeValue)
 
   // Count the values less than or equal to each element of tempArray
   // + Since each element stores its own count, just add the count at index i-1
-  for (int i = 1; i < tempArray.size(); i++) {
+  for (size_t i = 1; i < tempArray.size(); i++) {
     tempArray[i] = tempArray[i] + tempArray[i - 1];
   }
 

cpp/algorithms/sorting/radix/lib-counting.hpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of counting sort using a custom library  ##
 ##        + In support of a radix sort implementation                        ##
 ##                                                                           ##

cpp/algorithms/sorting/radix/lib-radix.cpp

@@ -1,3 +1,11 @@
+/*#############################################################################
+## Author: Shaun Reed                                                        ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
+## About: An example implementation of radix sort using a custom library     ##
+##                                                                           ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
+###############################################################################
+*/
 
 #include "lib-radix.hpp"
 #include "lib-counting.hpp"

cpp/algorithms/sorting/radix/lib-radix.hpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of radix sort using a custom library     ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/radix/radix-sort.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of radix sort using a custom library     ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/selection/CMakeLists.txt

@@ -1,15 +1,22 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A basic CMakeLists configuration to practice selection sort        ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-###############################################################################
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A basic CMakeLists configuration to practice selection sort         ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 
 cmake_minimum_required(VERSION 3.16)
-project(SelectionSort LANGUAGES CXX)
 
-add_executable(select-sort "select-sort.cpp")
+project (
+    #[[NAME]]   SelectionSort
+    VERSION     1.0
+    DESCRIPTION "A project for practicing selection sort in C++"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-select "lib-select.cpp")
-target_link_libraries(select-sort lib-select)
+add_executable(
+    algo-sort-select select-sort.cpp
+    lib-select.cpp lib-select.h
+)

cpp/algorithms/sorting/selection/lib-select.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of selection sort using a custom library ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
@@ -12,10 +12,10 @@
 #include <vector>
 
 void SelectionSort(std::vector<int> &arr) {
-  for (int leftIndex = 0; leftIndex < arr.size(); leftIndex++) {
+  for (size_t leftIndex = 0; leftIndex < arr.size(); leftIndex++) {
     // Get the index for the minimum number in the unsorted set
-    int min = leftIndex;
-    for (int i = leftIndex; i < arr.size(); i++) {
+    size_t min = leftIndex;
+    for (size_t i = leftIndex; i < arr.size(); i++) {
       // Check if value at i is smaller than value at min index
       min = (arr[min] > arr[i]) ? i : min; // Update min value to i if true
     }

cpp/algorithms/sorting/selection/lib-select.h

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of selection sort using a custom library ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/sorting/selection/select-sort.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example implementation of selection sort using a custom library ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/trees/CMakeLists.txt

@@ -1,11 +1,11 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A root project for practicing algorithms in C++                    ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A root project for practicing algorithms in C++                     ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
 project (
@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing algorithms using trees in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/algorithms/trees/binary/CMakeLists.txt

@@ -1,11 +1,11 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A basic CMakeLists configuration to test BST implementation        ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A basic CMakeLists configuration to test BST implementation         ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
 project (
@@ -14,8 +14,9 @@ project (
     DESCRIPTION "A project for testing BST algorithms"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-bst-algo "bst.cpp")
-
-add_executable(test-bst-algo "driver.cpp")
-target_link_libraries(test-bst-algo lib-bst-algo)
+add_executable(
+    algo-trees-bst driver.cpp
+    bst.cpp bst.h
+)

cpp/algorithms/trees/binary/bst.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example of a binary search tree implementation                  ##
 ##        The algorithms in this example are seen in MIT Intro to Algorithms ##
 ##                                                                           ##

cpp/algorithms/trees/binary/bst.h

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example of a binary search tree implementation                  ##
 ##        The algorithms in this example are seen in MIT Intro to Algorithms ##
 ##                                                                           ##

cpp/algorithms/trees/binary/driver.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: Driver program to test BST algorithms from MIT intro to algorithms ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/trees/redblack/CMakeLists.txt

@@ -1,11 +1,11 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A basic CMakeLists configuration to test RBT implementation        ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A basic CMakeLists configuration to test RBT implementation         ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
 project (
@@ -14,8 +14,9 @@ project (
     DESCRIPTION "A project for testing red-black tree algorithms"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-redblack "redblack.cpp")
-
-add_executable(test-redblack "driver.cpp")
-target_link_libraries(test-redblack lib-redblack)
+add_executable(
+    algo-trees-redblack driver.cpp
+    redblack.cpp redblack.h
+)

cpp/algorithms/trees/redblack/driver.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: Driver program to test RBT algorithms from MIT intro to algorithms ##
 ##                                                                           ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##

cpp/algorithms/trees/redblack/redblack.cpp

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example of a red-black tree implementation                      ##
 ##        The algorithms in this example are seen in MIT Intro to Algorithms ##
 ##                                                                           ##

cpp/algorithms/trees/redblack/redblack.h

@@ -1,6 +1,6 @@
 /*#############################################################################
 ## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved               ##
 ## About: An example of a red black tree implementation                      ##
 ##        The algorithms in this example are seen in MIT Intro to Algorithms ##
 ##                                                                           ##
@@ -12,6 +12,7 @@
 #define REDBLACK_H
 
 #include <iostream>
+#include <cstdint>
 
 enum Color {Black, Red};
 

cpp/catch2/CMakeLists.txt

@@ -0,0 +1,35 @@
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: Practice project for testing with catch2 framework                  ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
+cmake_minimum_required(VERSION 3.15)
+
+project(
+    #[[NAME]]       Catch2
+    VERSION         1.0
+    DESCRIPTION     "Practice project for learning Catch2"
+    LANGUAGES       CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+
+add_compile_options(-Wall)
+
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+
+Include(FetchContent)
+FetchContent_Declare(
+    Catch2
+    GIT_REPOSITORY https://github.com/catchorg/Catch2.git
+    GIT_TAG        v3.4.0
+)
+FetchContent_MakeAvailable(Catch2)
+
+add_library(klips SHARED src/klips.cpp)
+target_include_directories(klips PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
+
+add_executable(test_klips src/test_klips.cpp)
+target_link_libraries(test_klips PUBLIC Catch2::Catch2WithMain klips)

cpp/catch2/include/klips.hpp

@@ -0,0 +1,10 @@
+
+#ifndef KLIPS_KLIPS_H
+#define KLIPS_KLIPS_H
+
+
+class klips { };
+
+unsigned int factorial(unsigned int);
+
+#endif  // KLIPS_KLIPS_H

cpp/catch2/include/type_name.hpp

@@ -0,0 +1,29 @@
+// Authored by 康桓瑋 on SO: https://stackoverflow.com/a/56766138
+#ifndef CATCH2_TYPE_NAME_HPP
+
+#include <string_view>
+
+template <typename T>
+constexpr auto type_name() {
+  std::string_view name, prefix, suffix;
+#ifdef __clang__
+  name = __PRETTY_FUNCTION__;
+  prefix = "auto type_name() [T = ";
+  suffix = "]";
+#elif defined(__GNUC__)
+  name = __PRETTY_FUNCTION__;
+  prefix = "constexpr auto type_name() [with T = ";
+  suffix = "]";
+#elif defined(_MSC_VER)
+  name = __FUNCSIG__;
+  prefix = "auto __cdecl type_name<";
+  suffix = ">(void)";
+#endif
+  name.remove_prefix(prefix.size());
+  name.remove_suffix(suffix.size());
+  return name;
+}
+
+#define CATCH2_TYPE_NAME_HPP
+
+#endif  // CATCH2_TYPE_NAME_HPP

cpp/catch2/src/klips.cpp

@@ -0,0 +1,4 @@
+
+unsigned int factorial( unsigned int number ) {
+  return number <= 1 ? number : factorial(number-1)*number;
+}

cpp/catch2/src/test_klips.cpp

@@ -0,0 +1,148 @@
+#define CATCH_CONFIG_MAIN
+
+#include <iostream>
+
+#include "catch2/catch_all.hpp"
+
+#include "klips.hpp"
+#include "type_name.hpp"
+
+#define TT() std::cout << "T = " << type_name<TestType>() << std::endl;
+#define TD(x)                                                                  \
+  std::cout << type_name<decltype(x)>() << " " << #x << " = " << x << std::endl;
+#define T(x) std::cout << "T = " << type_name<x>() << std::endl;
+
+TEST_CASE("factorials are computed", "[factorial]") {
+  REQUIRE(factorial(1) == 1);
+  REQUIRE(factorial(2) == 2);
+  REQUIRE(factorial(3) == 6);
+  REQUIRE(factorial(10) == 3628800);
+}
+
+TEST_CASE("Generators") {
+  auto i = GENERATE(1, 3, 5);
+  TD(i);
+}
+
+TEST_CASE("Generators 2") {
+  auto i = GENERATE(1, 2);
+  SECTION("one") {
+    auto j = GENERATE(-3, -2);
+    REQUIRE(j < i);
+    std::cout << "i = " << i << "; j = " << j << std::endl;
+  }
+  SECTION("two") {
+    auto k = GENERATE(4, 5, 6);
+    REQUIRE(i != k);
+    std::cout << "i = " << i << "; k = " << k << std::endl;
+  }
+}
+
+TEST_CASE("Complex mix of sections and generates") {
+  auto i = GENERATE(1, 2);
+  SECTION("A") {
+    std::cout << "i = " << i << "; A passed" << std::endl;
+    SUCCEED("A");
+  }
+  std::cout << "left A\n";
+  auto j = GENERATE(3, 4);
+  std::cout << "i = " << i << "; j = " << j << std::endl;
+  SECTION("B") {
+    std::cout << "i = " << i << "; j = " << j << "; B passed;" << std::endl;
+    SUCCEED("B");
+  }
+  auto k = GENERATE(5, 6);
+  std::cout << "i = " << i << "; k = " << k << std::endl;
+  SUCCEED();
+}
+
+TEST_CASE("Test generaators 3", "[test]") { GENERATE(values({1, 2})); }
+
+TEMPLATE_TEST_CASE("Testing template tests", "[test][template]", int8_t,
+                   int16_t, int32_t, int64_t) {
+  TT();
+}
+
+template <typename T> struct Foo {
+  size_t size() { return 0; }
+};
+
+template <typename T> struct Test {
+  T test() {
+    T x;
+    return x;
+  }
+};
+
+TEMPLATE_PRODUCT_TEST_CASE("A Template product test case",
+                           "[template][product]", (std::vector, Test),
+                           (int, float)) {
+  TT();
+}
+
+TEMPLATE_PRODUCT_TEST_CASE("Product with differing arities",
+                           "[template][product]", std::tuple,
+                           (int, (int, double), (int, double, float))) {
+  TT();
+}
+
+using types = std::tuple<int8_t, int16_t, int32_t, int64_t>;
+
+TEMPLATE_LIST_TEST_CASE("Testing template list tests", "[test][template][list]",
+                        types) {
+  TT();
+}
+
+TEMPLATE_TEST_CASE_SIG(
+    "TemplateTestSig: arrays can be created from NTTP arguments",
+    "[vector][template][nttp]", ((typename T, int V), T, V), (int, 5),
+    (float, 4), (std::string, 15), ((std::tuple<int, float>), 6)) {
+  T(T);
+  std::cout << "V = " << V;
+  std::array<T, V> v;
+  REQUIRE(v.size() > 1);
+}
+
+template <typename T, size_t S> struct Bar {
+  size_t size() { return S; }
+};
+
+TEMPLATE_PRODUCT_TEST_CASE_SIG(
+    "A Template product test case with array signature",
+    "[template][product][nttp]", ((typename T, size_t S), T, S),
+    (std::array, Bar), ((int, 9), (float, 42))) {
+  TT();
+  TestType x;
+  REQUIRE(x.size() > 0);
+}
+
+template <typename T> struct test_config_get {
+  template <bool must_find> void run() {
+    //    Config c{};
+    //    std::string key{"the_key"};
+    //    std::string value{"the_value"};
+    //    c.set(key, value);
+    if constexpr (must_find) {
+      std::cout << "Test 1 ran";
+    } else {
+      std::cout << "Test 2 ran";
+    }
+  }
+};
+template <> template <bool must_find> void test_config_get<std::string>::run() {
+  if constexpr (must_find) {
+    std::cout << "Test 1 ran for strings";
+  } else {
+    std::cout << "Test 2 ran for strings";
+  }
+}
+
+TEMPLATE_PRODUCT_TEST_CASE("Test", "[test]", test_config_get,
+                           (int, std::string)) {
+  TT();
+  // TestType t;
+  test_config_get<int> s;
+  s.template run<true>();
+  //  TestType t;
+  //  t.run<true>();
+}

cpp/cmake-example/CMakeLists.txt

@@ -1,19 +1,28 @@
-###############################################################################
-## Author: Shaun Reed							                                           ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved	 	           ##
-## About: A template project for getting started working with CMake          ##
-##								                                                    	     ##
-## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed							                                            ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved	 	            ##
+## About: A template project for getting started working with CMake           ##
+##								                                                    	      ##
+## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 
 # Define the version of CMake
 cmake_minimum_required(VERSION 3.15)
 
+# CMake options
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
+# Compiler options
+add_compile_options("-Wall")
+
 # Define the your project name
-project(cmake-template)
+project (
+    #[[NAME]]   CMakeTemplate
+    VERSION     1.0
+    DESCRIPTION "A basic CMake template for C++ projects"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 # Include any directories the compiler may need
 include_directories(./include)

cpp/cmake-example/apps/CMakeLists.txt

@@ -1,17 +1,16 @@
-###############################################################################
-## Author: Shaun Reed				                                      			     ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved	      	     ##
-##									                                                         ##
-## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
+################################################################################
+## Author: Shaun Reed				                                      			      ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved	      	      ##
+##									                                                          ##
+## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 ## This directory is for storing / compiling our executable code
 
 # Create a reference / variable to refer to our source code
 set(APP_SRC say-hello.cpp)
 
 # Add our executable, naming it and linking it to our source code
-add_executable(execute-hello ${APP_SRC})
+add_executable(cmake-example-template ${APP_SRC})
 
 # Link to our custom library, defined in c-cmake/src/
-target_link_libraries(execute-hello lib-klips)
-
+target_link_libraries(cmake-example-template cmake-example-lib)

cpp/cmake-example/apps/say-hello.cpp

@@ -1,12 +1,12 @@
-/*#############################################################################
-## Author: Shaun Reed							     ##
-## Legal: All Content (c) 2019 Shaun Reed, all rights reserved	 	     ##
-##									     ##
-## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
+/*##############################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 */
 
-#include <lib-klips.hpp>
+#include <lib-example.hpp>
 #include <iostream>
 
 int main () {

cpp/cmake-example/include/lib-example.hpp

@@ -1,9 +1,9 @@
-/*#############################################################################
-## Author: Shaun Reed							     ##
-## Legal: All Content (c) 2019 Shaun Reed, all rights reserved	 	     ##
-##									     ##
-## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
+/*##############################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 */
 
 /**

cpp/cmake-example/src/CMakeLists.txt

@@ -1,14 +1,13 @@
-###############################################################################
-## Author: Shaun Reed						                                      	     ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved	 	           ##
-##								                                                    	     ##
-## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
+################################################################################
+## Author: Shaun Reed						                                      	      ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved	 	            ##
+##								                                                    	      ##
+## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 ## This directory is for storing source code
 
 # Create any links we might need
-set(LIB_SRC lib-klips.cpp)
+set(LIB_SRC lib-example.cpp)
 
 # Define our library within CMake and link to the source code
-add_library(lib-klips ${LIB_SRC})
-
+add_library(cmake-example-lib ${LIB_SRC})

cpp/cmake-example/src/lib-example.cpp

@@ -1,12 +1,12 @@
-/*#############################################################################
-## Author: Shaun Reed							     ##
-## Legal: All Content (c) 2019 Shaun Reed, all rights reserved	 	     ##
-##									     ##
-## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
+/*##############################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com	| URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
 */
 
-#include <lib-klips.hpp>
+#include <lib-example.hpp>
 #include <iostream>
 
 void PrintHello(int n) {

cpp/cryptography/CMakeLists.txt

@@ -1,11 +1,11 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A root project for practicing cryptography in C++                  ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2021 Shaun Reed, all rights reserved                ##
+## About: A root project for practicing cryptography in C++                   ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
 project (
@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing cryptography in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/cryptography/columnar-transposition/CMakeLists.txt

@@ -5,7 +5,6 @@
 ##                                                                            ##
 ## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
 ################################################################################
-#
 
 cmake_minimum_required(VERSION 3.15)
 
@@ -15,8 +14,9 @@ project(
     DESCRIPTION "Practice implementing columnar transposition in C++"
     LANGUAGES CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-cipher "lib-cipher.cpp")
-
-add_executable(columnar-transposition-test "driver.cpp")
-target_link_libraries(columnar-transposition-test lib-cipher)
+add_executable(
+    crypto-columnar-transposition driver.cpp
+    lib-cipher.cpp lib-cipher.hpp
+)

cpp/cryptography/columnar-transposition/lib-cipher.cpp

@@ -21,9 +21,9 @@ void Columnar::InitOrder(std::string temp)
   temp.erase(it, temp.end());
 
   // Step through each character in lexicographic order
-  for (int i = 0; i < temp.size(); i++) {
+  for (size_t i = 0; i < temp.size(); i++) {
     // Check each character in the keyWord for the current lexicographic char
-    for (int j = 0; j < keyWord_.size(); j++) {
+    for (size_t j = 0; j < keyWord_.size(); j++) {
       // If they are equal, push the index of the char in keyWord to orderVect
       if (keyWord_[j] == temp[i]) {
         orderVect_.push_back(j);
@@ -109,7 +109,7 @@ std::string Columnar::Decrypt(std::string message)
   rows.resize(orderVect_.size());
   // Track the ending position after each substring is taken
   int lastPos = 0;
-  for (int i = 0; i < orderVect_.size(); i++) {
+  for (size_t i = 0; i < orderVect_.size(); i++) {
     // If we are assigning to any row < fullRows, it should have + 1 character
     if (orderVect_[i] < fullRows) {
       rows[orderVect_[i]] = message.substr(lastPos, rowLength + 1);

cpp/datastructs/CMakeLists.txt

@@ -1,11 +1,11 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A root project for practicing C++ data structure implementations   ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A root project for practicing C++ data structure implementations    ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
 project (
@@ -14,6 +14,7 @@ project (
     DESCRIPTION "A project for practicing various data structures in C++"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 

cpp/datastructs/binarysearchtree/CMakeLists.txt

@@ -1,11 +1,11 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: A basic CMakeLists configuration to test BST implementation        ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: A basic CMakeLists configuration to test BST implementation         ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
 project (
@@ -14,8 +14,9 @@ project (
     DESCRIPTION "A project for testing a basic implementation of a BST"
     LANGUAGES   CXX
 )
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
 
-add_library(lib-bst "bst.cpp")
-
-add_executable(test-bst "driver.cpp")
-target_link_libraries(test-bst lib-bst)
+add_executable(
+    data-bst driver.cpp
+    bst.cpp bst.h
+)

cpp/datastructs/binarysearchtree/bst.cpp

@@ -10,10 +10,11 @@
 
 #include "bst.h"
 
+#include <cstdint>
 
 /********************************************************************************
-* Constructors, Destructors, Operators
-*********************************************************************************/
+ * Constructors, Destructors, Operators
+ *********************************************************************************/
 
 /** Copy Assignment Operator
  * @brief Empty the calling object's root BinaryNode, and copy the rhs data

cpp/datastructs/circledoublelist/CMakeLists.txt

@@ -1,16 +1,22 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: An example of a circular doubly linked list implementation         ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of a circular doubly linked list implementation          ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
-# Define the project name
-project(CircleDouble)
-# Define source files
-set(SRC driver.cpp circledoublelist.cpp)
-# Build an executable
-add_executable(CircleDoubleDriver ${SRC})
+project (
+    #[[NAME]]   CircleDoubleList
+    VERSION     1.0
+    DESCRIPTION "Project for testing circular doubly linked list implementation"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+
+add_executable(
+    data-circular-doubly-linked-list driver.cpp
+    circledoublelist.cpp circledoublelist.h
+)

cpp/datastructs/circledoublelist/circledoublelist.cpp

@@ -10,6 +10,7 @@
 
 #include "circledoublelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/circlesinglelist/CMakeLists.txt

@@ -1,16 +1,22 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: An example of a circular singly linked list implementation         ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of a circular singly linked list implementation          ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
-# Define the project name
-project(CircleSingle)
-# Define source files
-set(SRC driver.cpp circlesinglelist.cpp)
-# Build an executable
-add_executable(CircleSingleDriver ${SRC})
+project (
+    #[[NAME]]   CircleSingleList
+    VERSION     1.0
+    DESCRIPTION "Project for testing circular singly linked list implementation"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+
+add_executable(
+    data-circular-singly-linked-list driver.cpp
+    circlesinglelist.cpp circlesinglelist.h
+)

cpp/datastructs/circlesinglelist/circlesinglelist.cpp

@@ -10,6 +10,7 @@
 
 #include "circlesinglelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/doublelist/CMakeLists.txt

@@ -1,16 +1,22 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: An example of a doubly linked list implementation                  ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of a doubly linked list implementation                   ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
-# Define the project name
-project(DoubleList)
-# Define source files
-set(SRC driver.cpp doublelist.cpp)
-# Build an executable
-add_executable(DoubleListDriver ${SRC})
+project (
+    #[[NAME]]   DoubleList
+    VERSION     1.0
+    DESCRIPTION "A project for testing a doubly linked list implementation"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+
+add_executable(
+    data-doubly-linked-list driver.cpp
+    doublelist.cpp doublelist.h
+)

cpp/datastructs/doublelist/doublelist.cpp

@@ -10,6 +10,7 @@
 
 #include "doublelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/maxheap/CMakeLists.txt

@@ -1,16 +1,22 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: An example of a max heap implementation                            ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of a max heap implementation                             ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
-# Define the project name
-project(MaxHeap)
-# Define source files
-set(SRC driver.cpp maxheap.cpp)
-# Build an executable
-add_executable(HeapDriver ${SRC})
+project (
+    #[[NAME]]   MaxHeap
+    VERSION     1.0
+    DESCRIPTION "A project for testing a max heap implementation"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+
+add_executable(
+    data-max-heap driver.cpp
+    maxheap.cpp maxheap.h
+)

cpp/datastructs/maxheap/maxheap.cpp

@@ -10,10 +10,11 @@
 
 #include "maxheap.h"
 
+#include <cstdint>
 
 /********************************************************************************
-* Constructors, Destructors, Operators
-*********************************************************************************/
+ * Constructors, Destructors, Operators
+ *********************************************************************************/
 
 /** default constructor
  *  Constructs a heap with the given default values

cpp/datastructs/queuelist/CMakeLists.txt

@@ -1,16 +1,22 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: An example of a queue implementation                               ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of a queue implementation                                ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
-# Define the project name
-project(Queue)
-# Define source files
-set(SRC driver.cpp queuelist.cpp)
-# Build an executable
-add_executable(QueueDriver ${SRC})
+project (
+    #[[NAME]]   Queue
+    VERSION     1.0
+    DESCRIPTION "Project for testing queue implementation"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+
+add_executable(
+    data-queue driver.cpp
+    queuelist.cpp queuelist.h
+)

cpp/datastructs/queuelist/queuelist.cpp

@@ -10,6 +10,7 @@
 
 #include "queuelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators

cpp/datastructs/singlelist/CMakeLists.txt

@@ -1,16 +1,22 @@
-###############################################################################
-## Author: Shaun Reed                                                        ##
-## Legal: All Content (c) 2021 Shaun Reed, all rights reserved               ##
-## About: An example of a singly linked list implementation                  ##
-##                                                                           ##
-## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0  ##
-##############################################################################
-#
+################################################################################
+## Author: Shaun Reed                                                         ##
+## Legal: All Content (c) 2022 Shaun Reed, all rights reserved                ##
+## About: An example of a singly linked list implementation                   ##
+##                                                                            ##
+## Contact: shaunrd0@gmail.com  | URL: www.shaunreed.com | GitHub: shaunrd0   ##
+################################################################################
+
 cmake_minimum_required(VERSION 3.15)
 
-# Define the project name
-project(SingleList)
-# Define source files
-set(SRC driver.cpp singlelist.cpp)
-# Build an executable
-add_executable(SingleListDriver ${SRC})
+project (
+    #[[NAME]]   SingleList
+    VERSION     1.0
+    DESCRIPTION "A project for testing a singly linked list implementation"
+    LANGUAGES   CXX
+)
+message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
+
+add_executable(
+    data-singly-linked-list driver.cpp
+    singlelist.cpp singlelist.h
+)

cpp/datastructs/singlelist/singlelist.cpp

@@ -10,6 +10,7 @@
 
 #include "singlelist.h"
 
+#include <cstdint>
 
 /******************************************************************************
  * Constructors, Destructors, Operators