Compare commits
28 Commits
a97dfbe34b
...
aht20
| Author | SHA1 | Date | |
|---|---|---|---|
| dce3e3600d | |||
| c087c2446a | |||
| 08639679fb | |||
| 9eeabf0683 | |||
| 1eb00aea6e | |||
| 945e6ba2ff | |||
| a5ee28596a | |||
| 85f588fcb3 | |||
| bb28b1e2ef | |||
| 20efb62615 | |||
| edde77b9c3 | |||
| 5565ad5170 | |||
| 6cd7d7db29 | |||
| 17c559a31f | |||
| e6ba60da89 | |||
| 8bf174d256 | |||
| 5f9f508581 | |||
| 3b6ecaa5e9 | |||
| de652bad32 | |||
| d1fb33c58e | |||
| 6dbac7559a | |||
| 34f12250ab | |||
| 4b47630548 | |||
| 6986c73651 | |||
| 92b3af7813 | |||
| 6c0018c469 | |||
| d81c65b1d2 | |||
| fc1f247987 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -10,3 +10,5 @@
|
|||||||
**/Makefile
|
**/Makefile
|
||||||
**/*.cbp
|
**/*.cbp
|
||||||
**/node-modules/
|
**/node-modules/
|
||||||
|
**/CMakeLists.txt.user
|
||||||
|
**/catch2/bin/
|
||||||
|
|||||||
12
README.md
12
README.md
@@ -2,14 +2,16 @@
|
|||||||
|
|
||||||
This repository is a collection of useful code snippets and configurations.
|
This repository is a collection of useful code snippets and configurations.
|
||||||
|
|
||||||
```
|
```bash
|
||||||
github.com/shaunrd0/klips/
|
shaunrd0/klips/
|
||||||
├── ansible # Ansible roles, playbooks, and examples
|
├── ansible # Ansible roles, playbooks, and examples
|
||||||
├── blockchain # Blockchain related project templates and examples
|
├── blockchain # Blockchain related project templates and examples
|
||||||
├── cpp # C++ programs, datastructures, and other examples
|
├── cpp # C++ programs, datastructures, and other examples
|
||||||
|
├── dotnet # .NET projects and examples
|
||||||
|
├── esp # ESP32 projects and examples
|
||||||
├── figlet # Figlet fonts I like :)
|
├── figlet # Figlet fonts I like :)
|
||||||
├── javascript # Javascript projects and examples
|
├── javascript # Javascript projects and examples
|
||||||
├── python # Python scripts or tools I've made
|
├── python # Python scripts and tools I've made
|
||||||
├── README.md
|
├── scripts # Bash scripts
|
||||||
└── scripts # Bash scripts
|
└── 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.
|
A few simple roles / plays I've put together in learning how to use Ansible can be found under their corresponding directories.
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
# blockchain
|
||||||
|
|
||||||
A template project for getting started working on the Ethereum 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.
|
This project comes with basic packages for compiling and deploying Solidity contracts with Truffle.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
################################################################################
|
################################################################################
|
||||||
## Author: Shaun Reed ##
|
## Author: Shaun Reed ##
|
||||||
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
## About: A root project for practicing C++ ##
|
## About: A root project for practicing C++ ##
|
||||||
## This project can be built to debug and run all nested projects ##
|
## This project can be built to debug and run all nested projects ##
|
||||||
## Or, any subdirectory with a project() statement can be selected ##
|
## Or, any subdirectory with a project() statement can be selected ##
|
||||||
@@ -16,12 +16,49 @@ project(
|
|||||||
DESCRIPTION "A root project for several small cpp practice projects"
|
DESCRIPTION "A root project for several small cpp practice projects"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
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(algorithms)
|
||||||
|
add_subdirectory(catch2)
|
||||||
add_subdirectory(cmake-example)
|
add_subdirectory(cmake-example)
|
||||||
add_subdirectory(cryptography)
|
add_subdirectory(cryptography)
|
||||||
add_subdirectory(datastructs)
|
add_subdirectory(datastructs)
|
||||||
add_subdirectory(graphics)
|
add_subdirectory(graphics)
|
||||||
|
add_subdirectory(multithreading)
|
||||||
add_subdirectory(patterns)
|
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()
|
||||||
|
|||||||
@@ -1,13 +1,15 @@
|
|||||||
# Cpp
|
# cpp
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
shaunrd0/klips/cpp/
|
shaunrd0/klips/cpp/
|
||||||
├── algorithms # Examples of various algorithms written in C++
|
├── algorithms # Examples of various algorithms written in C++
|
||||||
├── cmake # Example of using cmake to build and organize larger projects
|
├── cmake # Example of using cmake to build and organize larger projects
|
||||||
├── cryptography # Examples of encrypting / decrypting using ciphers in C++
|
├── cryptography # Examples of encrypting / decrypting using ciphers in C++
|
||||||
├── datastructs # Collection of useful datastructures written in C++
|
├── datastructs # Collection of useful datastructures written in C++
|
||||||
├── graphics # Examples of graphics projects written in C++
|
├── graphics # Examples of graphics projects written in C++
|
||||||
├── patterns # Examples of various design patterns 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
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing various algorithms in C++"
|
DESCRIPTION "A project for practicing various algorithms in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing algorithms using graphs in C++"
|
DESCRIPTION "A project for practicing algorithms using graphs in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "Practice implementing and using object graphs in C++"
|
DESCRIPTION "Practice implementing and using object graphs in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-graphs-object graph.cpp
|
algo-graphs-object graph.cpp
|
||||||
|
|||||||
@@ -1,8 +1,7 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 ##
|
## About: Driver program to test object graph implementation ##
|
||||||
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
|
||||||
## ##
|
## ##
|
||||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
################################################################################
|
################################################################################
|
||||||
|
|||||||
@@ -1,7 +1,8 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 object graph implementation ##
|
## 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 ##
|
## 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
|
// + Output is handled in main as FILO, similar to a stack
|
||||||
return order;
|
return order;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 ##
|
## About: An example of an object graph implementation ##
|
||||||
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
||||||
## ##
|
## ##
|
||||||
@@ -10,51 +10,14 @@
|
|||||||
#ifndef LIB_GRAPH_HPP
|
#ifndef LIB_GRAPH_HPP
|
||||||
#define LIB_GRAPH_HPP
|
#define LIB_GRAPH_HPP
|
||||||
|
|
||||||
#include <iostream>
|
|
||||||
#include <algorithm>
|
#include <algorithm>
|
||||||
|
#include <iostream>
|
||||||
#include <map>
|
#include <map>
|
||||||
|
#include <queue>
|
||||||
|
#include <unordered_map>
|
||||||
|
#include <unordered_set>
|
||||||
#include <utility>
|
#include <utility>
|
||||||
#include <vector>
|
#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:
|
public:
|
||||||
// Constructors
|
// Constructors
|
||||||
Node(const Node &rhs) = default;
|
Node(const Node &rhs) = default;
|
||||||
Node & operator=(Node rhs) {
|
Node & operator=(Node rhs)
|
||||||
|
{
|
||||||
if (this == &rhs) return *this;
|
if (this == &rhs) return *this;
|
||||||
swap(*this, rhs);
|
swap(*this, rhs);
|
||||||
return *this;
|
return *this;
|
||||||
}
|
}
|
||||||
Node(int num, std::vector<int> adj) : number(num), adjacent(std::move(adj)) {}
|
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.number, b.number);
|
||||||
std::swap(a.adjacent, b.adjacent);
|
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
|
// Graph class declaration
|
||||||
|
|
||||||
class Graph {
|
class Graph {
|
||||||
public:
|
public:
|
||||||
// Constructor
|
// Constructor
|
||||||
@@ -101,7 +119,7 @@ public:
|
|||||||
// An alternate DFS that checks each node of the graph beginning at startNode
|
// An alternate DFS that checks each node of the graph beginning at startNode
|
||||||
InfoDFS DFS(const Node &startNode) const;
|
InfoDFS DFS(const Node &startNode) const;
|
||||||
// Visit function is used in both versions of DFS
|
// 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
|
// Topological sort, using DFS
|
||||||
std::vector<Node> TopologicalSort(const Node &startNode) const;
|
std::vector<Node> TopologicalSort(const Node &startNode) const;
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "Practice implementing and using simple graphs in C++"
|
DESCRIPTION "Practice implementing and using simple graphs in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-graphs-simple graph.cpp
|
algo-graphs-simple graph.cpp
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 ##
|
## About: Driver program to test a simple graph implementation ##
|
||||||
## ##
|
## ##
|
||||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 ##
|
## About: An example of a simple graph implementation ##
|
||||||
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
||||||
## ##
|
## ##
|
||||||
@@ -8,9 +8,8 @@
|
|||||||
################################################################################
|
################################################################################
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <algorithm>
|
|
||||||
#include "lib-graph.hpp"
|
#include "lib-graph.hpp"
|
||||||
|
#include <algorithm>
|
||||||
|
|
||||||
void Graph::BFS(int startNode)
|
void Graph::BFS(int startNode)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*#############################################################################
|
/*#############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 ##
|
## About: An example of a simple graph implementation ##
|
||||||
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
||||||
## ##
|
## ##
|
||||||
@@ -12,9 +12,10 @@
|
|||||||
|
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
#include <queue>
|
#include <queue>
|
||||||
#include <vector>
|
|
||||||
#include <unordered_map>
|
#include <unordered_map>
|
||||||
#include <unordered_set>
|
#include <unordered_set>
|
||||||
|
#include <vector>
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
|
|
||||||
class Graph {
|
class Graph {
|
||||||
|
|||||||
@@ -14,5 +14,6 @@ project(
|
|||||||
DESCRIPTION "Practice implementing and using templated graphs in C++"
|
DESCRIPTION "Practice implementing and using templated graphs in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(algo-graphs-templated graph.cpp)
|
add_executable(algo-graphs-templated graph.cpp)
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 weighted graph implementation ##
|
## About: Driver program to test templated object graph implementation ##
|
||||||
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
||||||
## ##
|
## ##
|
||||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 ##
|
## About: An example of a templated object graph implementation ##
|
||||||
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
||||||
## ##
|
## ##
|
||||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
@@ -10,38 +10,89 @@
|
|||||||
#ifndef LIB_GRAPH_HPP
|
#ifndef LIB_GRAPH_HPP
|
||||||
#define LIB_GRAPH_HPP
|
#define LIB_GRAPH_HPP
|
||||||
|
|
||||||
#include <iostream>
|
|
||||||
#include <algorithm>
|
#include <algorithm>
|
||||||
|
#include <iostream>
|
||||||
#include <map>
|
#include <map>
|
||||||
|
#include <queue>
|
||||||
|
#include <unordered_map>
|
||||||
|
#include <unordered_set>
|
||||||
#include <utility>
|
#include <utility>
|
||||||
#include <vector>
|
#include <vector>
|
||||||
#include <queue>
|
#include <cstdint>
|
||||||
#include <unordered_set>
|
|
||||||
#include <unordered_map>
|
|
||||||
|
/******************************************************************************/
|
||||||
|
// 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
|
// Base struct for storing traversal information on all nodes
|
||||||
|
|
||||||
template <typename T> struct Node;
|
|
||||||
|
|
||||||
// Color represents the discovery status of any given node
|
// Color represents the discovery status of any given node
|
||||||
// + White is undiscovered, Gray is in progress, Black is fully discovered
|
enum Color {
|
||||||
enum Color {White, Gray, Black};
|
// 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
|
// Information used in all searches tracked for each node
|
||||||
struct SearchInfo {
|
struct NodeInfo {
|
||||||
// Coloring of the nodes is used in both DFS and BFS
|
// Coloring of the nodes is used in both DFS and BFS
|
||||||
Color discovered = White;
|
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>
|
template <typename T>
|
||||||
struct BFS : SearchInfo {
|
struct BFS : NodeInfo {
|
||||||
// Used to represent distance from start node
|
// Used to represent distance from start node
|
||||||
int distance = 0;
|
int distance = 0;
|
||||||
// Used to represent the parent node that discovered this node
|
// Used to represent the parent node that discovered this node
|
||||||
@@ -49,12 +100,16 @@ struct BFS : SearchInfo {
|
|||||||
const Node<T> *predecessor = nullptr;
|
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
|
// Node information that is only used in DFS
|
||||||
struct DFS : SearchInfo {
|
struct DFS : NodeInfo {
|
||||||
// Create a pair to track discovery / finish time
|
// Create a pair to track discovery / finish time
|
||||||
// + Discovery time is the iteration the node is first discovered
|
// + Discovery time is the iteration the node is first discovered
|
||||||
// + Finish time is the iteration the node has been checked completely
|
// + Finish time is the iteration the node has been checked completely
|
||||||
@@ -62,22 +117,16 @@ struct DFS : SearchInfo {
|
|||||||
std::pair<int, int> discoveryFinish;
|
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_>>
|
// Edges stored as multimap<weight, pair<nodeA.data_, nodeB.data_>>
|
||||||
template <typename T> using Edges = std::multimap<int, std::pair<T, T>>;
|
template <typename T> using Edges = std::multimap<int, std::pair<T, T>>;
|
||||||
|
|
||||||
|
struct MST : NodeInfo {
|
||||||
/******************************************************************************/
|
|
||||||
// MST search information structs
|
|
||||||
|
|
||||||
struct MST : SearchInfo {
|
|
||||||
int32_t parent = INT32_MIN;
|
int32_t parent = INT32_MIN;
|
||||||
int rank = 0;
|
int rank = 0;
|
||||||
};
|
};
|
||||||
@@ -86,8 +135,9 @@ template <typename T>
|
|||||||
struct InfoMST {
|
struct InfoMST {
|
||||||
template <typename> friend class Graph;
|
template <typename> friend class Graph;
|
||||||
|
|
||||||
explicit InfoMST(const std::vector<Node<T>> &nodes) {
|
explicit InfoMST(const std::vector<Node<T>> &nodes)
|
||||||
for (const auto &node : nodes){
|
{
|
||||||
|
for (const auto &node : nodes) {
|
||||||
// Initialize the default values for forest tracked by this struct
|
// Initialize the default values for forest tracked by this struct
|
||||||
// + This data is used in KruskalMST() to find the MST
|
// + This data is used in KruskalMST() to find the MST
|
||||||
MakeSet(node.data_);
|
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
|
// Templated graph class
|
||||||
|
|
||||||
@@ -209,7 +214,7 @@ template <class T>
|
|||||||
class Graph {
|
class Graph {
|
||||||
public:
|
public:
|
||||||
// Constructor
|
// 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
|
// Breadth First Search
|
||||||
InfoBFS<T> BFS(const Node<T>& startNode) const;
|
InfoBFS<T> BFS(const Node<T>& startNode) const;
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "Practice implementing and using weighted graphs in C++"
|
DESCRIPTION "Practice implementing and using weighted graphs in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-graphs-weighted graph.cpp
|
algo-graphs-weighted graph.cpp
|
||||||
|
|||||||
@@ -1,8 +1,7 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 weighted graph implementation ##
|
## About: Driver program to test weighted graph implementation ##
|
||||||
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
|
||||||
## ##
|
## ##
|
||||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
## 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
|
// + Chapter 22, Figure 22.4 on DFS
|
||||||
// Unlike the simple-graph example, this final result matches MIT Algorithms
|
// Unlike the simple-graph example, this final result matches MIT Algorithms
|
||||||
// + Aside from the placement of the watch node, which is not connected
|
// + 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 =
|
std::vector<Node> order =
|
||||||
topologicalGraph.TopologicalSort(topologicalGraph.GetNodeCopy(6));
|
topologicalGraph.TopologicalSort(topologicalGraph.GetNodeCopy(6));
|
||||||
std::cout << "\nTopological order: ";
|
std::cout << "\nTopological order: ";
|
||||||
@@ -157,11 +156,19 @@ int main (const int argc, const char * argv[])
|
|||||||
{9, {{3, 2}, {7, 6}}}
|
{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();
|
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) {
|
for (const auto &edge : resultMST.edgesMST) {
|
||||||
std::cout << "Connected nodes: " << edge.second.first << "->"
|
std::cout << "Connected nodes: " << edge.second.first << "->"
|
||||||
<< edge.second.second << " with weight of " << edge.first << "\n";
|
<< 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;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,8 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 object graph implementation ##
|
## 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 ##
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
################################################################################
|
################################################################################
|
||||||
@@ -13,13 +14,13 @@
|
|||||||
InfoBFS Graph::BFS(const Node& startNode) const
|
InfoBFS Graph::BFS(const Node& startNode) const
|
||||||
{
|
{
|
||||||
// Create local object to track the information gathered during traversal
|
// Create local object to track the information gathered during traversal
|
||||||
InfoBFS searchInfo;
|
InfoBFS bfs;
|
||||||
|
|
||||||
// Create a queue to visit discovered nodes in FIFO order
|
// Create a queue to visit discovered nodes in FIFO order
|
||||||
std::queue<const Node *> visitQueue;
|
std::queue<const Node *> visitQueue;
|
||||||
|
|
||||||
// Mark the startNode as in progress until we finish checking adjacent nodes
|
// 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
|
// Visit the startNode
|
||||||
visitQueue.push(&startNode);
|
visitQueue.push(&startNode);
|
||||||
@@ -30,17 +31,17 @@ InfoBFS Graph::BFS(const Node& startNode) const
|
|||||||
const Node * thisNode = visitQueue.front();
|
const Node * thisNode = visitQueue.front();
|
||||||
visitQueue.pop();
|
visitQueue.pop();
|
||||||
std::cout << "Visiting node " << thisNode->number << std::endl;
|
std::cout << "Visiting node " << thisNode->number << std::endl;
|
||||||
|
|
||||||
// Check if we have already discovered all the adjacentNodes to thisNode
|
// Check if we have already discovered all the adjacentNodes to thisNode
|
||||||
for (const auto &adjacent : thisNode->adjacent) {
|
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
|
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
|
// Mark the adjacent node as in progress
|
||||||
searchInfo[adjacent.first].discovered = Gray;
|
bfs.nodeInfo[adjacent.first].discovered = Gray;
|
||||||
searchInfo[adjacent.first].distance =
|
bfs.nodeInfo[adjacent.first].distance =
|
||||||
searchInfo[thisNode->number].distance + 1;
|
bfs.nodeInfo[thisNode->number].distance + 1;
|
||||||
searchInfo[adjacent.first].predecessor =
|
bfs.nodeInfo[adjacent.first].predecessor =
|
||||||
&GetNode(thisNode->number);
|
&GetNode(thisNode->number);
|
||||||
|
|
||||||
// Add the discovered node the the visitQueue
|
// 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
|
// 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 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
|
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
|
// + If the caller modifies these, it will not impact the graph's data
|
||||||
std::deque<Node> path;
|
std::deque<Node> path;
|
||||||
|
|
||||||
InfoBFS searchInfo = BFS(start);
|
InfoBFS bfs = BFS(start);
|
||||||
const Node * next = searchInfo[finish.number].predecessor;
|
const Node * next = bfs.nodeInfo[finish.number].predecessor;
|
||||||
bool isValid = false;
|
bool isValid = false;
|
||||||
do {
|
do {
|
||||||
// If we have reached the start node, we have found a valid path
|
// 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);
|
path.emplace_front(*next);
|
||||||
|
|
||||||
// Move to the next node
|
// Move to the next node
|
||||||
next = searchInfo[next->number].predecessor;
|
next = bfs.nodeInfo[next->number].predecessor;
|
||||||
} while (next != nullptr);
|
} while (next != nullptr);
|
||||||
// Use emplace_back to call Node copy constructor
|
// Use emplace_back to call Node copy constructor
|
||||||
path.emplace_back(finish);
|
path.emplace_back(finish);
|
||||||
@@ -88,85 +89,83 @@ std::deque<Node> Graph::PathBFS(const Node &start, const Node &finish) const
|
|||||||
InfoDFS Graph::DFS() const
|
InfoDFS Graph::DFS() const
|
||||||
{
|
{
|
||||||
// Track the nodes we have discovered
|
// Track the nodes we have discovered
|
||||||
InfoDFS searchInfo;
|
InfoDFS dfs;
|
||||||
int time = 0;
|
int time = 0;
|
||||||
|
|
||||||
// Visit each node in the graph
|
// Visit each node in the graph
|
||||||
for (const auto& node : nodes_) {
|
for (const auto & node : nodes_) {
|
||||||
std::cout << "Visiting node " << node.number << std::endl;
|
std::cout << "Visiting node " << node.number << std::endl;
|
||||||
// If the node is undiscovered, visit it
|
// 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;
|
std::cout << "Found undiscovered node: " << node.number << std::endl;
|
||||||
// Visiting the undiscovered node will check it's adjacent nodes
|
// 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
|
InfoDFS Graph::DFS(const Node &startNode) const
|
||||||
{
|
{
|
||||||
// Track the nodes we have discovered
|
// Track the nodes we have discovered
|
||||||
InfoDFS searchInfo;
|
InfoDFS dfs;
|
||||||
int time = 0;
|
int time = 0;
|
||||||
|
|
||||||
auto startIter = std::find(nodes_.begin(), nodes_.end(),
|
auto startIter =
|
||||||
Node(startNode.number, {})
|
std::find(nodes_.begin(), nodes_.end(), Node(startNode.number, { }));
|
||||||
);
|
|
||||||
|
|
||||||
// beginning at startNode, visit each node in the graph until we reach the end
|
// beginning at startNode, visit each node in the graph until we reach the end
|
||||||
while (startIter != nodes_.end()) {
|
while (startIter != nodes_.end()) {
|
||||||
std::cout << "Visiting node " << startIter->number << std::endl;
|
std::cout << "Visiting node " << startIter->number << std::endl;
|
||||||
// If the startIter is undiscovered, visit it
|
// 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;
|
std::cout << "Found undiscovered node: " << startIter->number
|
||||||
|
<< std::endl;
|
||||||
// Visiting the undiscovered node will check it's adjacent nodes
|
// Visiting the undiscovered node will check it's adjacent nodes
|
||||||
DFSVisit(time, *startIter, searchInfo);
|
DFSVisit(time, *startIter, dfs);
|
||||||
}
|
}
|
||||||
startIter++;
|
startIter++;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Once we reach the last node, check the beginning for unchecked nodes
|
// Once we reach the last node, check the beginning for unchecked nodes
|
||||||
startIter = nodes_.begin();
|
startIter = nodes_.begin();
|
||||||
|
|
||||||
// Once we reach the initial startNode, we have checked all nodes
|
// Once we reach the initial startNode, we have checked all nodes
|
||||||
while (*startIter != startNode) {
|
while (*startIter != startNode) {
|
||||||
std::cout << "Visiting node " << startIter->number << std::endl;
|
std::cout << "Visiting node " << startIter->number << std::endl;
|
||||||
// If the startIter is undiscovered, visit it
|
// 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;
|
std::cout << "Found undiscovered node: " << startIter->number << std::endl;
|
||||||
// Visiting the undiscovered node will check it's adjacent nodes
|
// Visiting the undiscovered node will check it's adjacent nodes
|
||||||
DFSVisit(time, *startIter, searchInfo);
|
DFSVisit(time, *startIter, dfs);
|
||||||
}
|
}
|
||||||
startIter++;
|
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++;
|
time++;
|
||||||
searchInfo[startNode.number].discoveryFinish.first = time;
|
dfs.nodeInfo[startNode.number].discoveryFinish.first = time;
|
||||||
|
|
||||||
// Check the adjacent nodes of the startNode
|
// Check the adjacent nodes of the startNode
|
||||||
for (const auto &adjacent : startNode.adjacent) {
|
for (const auto & adjacent : startNode.adjacent) {
|
||||||
auto iter = std::find(nodes_.begin(), nodes_.end(),
|
const auto node = GetNode(adjacent.first);
|
||||||
Node(adjacent.first, {}));
|
|
||||||
// If the adjacentNode is undiscovered, visit it
|
// If the adjacentNode is undiscovered, visit it
|
||||||
// + Offset by 1 to account for 0 index of discovered vector
|
// + Offset by 1 to account for 0 index of discovered vector
|
||||||
if (searchInfo[iter->number].discovered == White) {
|
if (dfs.nodeInfo[node.number].discovered == White) {
|
||||||
std::cout << "Found undiscovered adjacentNode: "
|
std::cout << "Found undiscovered adjacentNode: " << adjacent.first
|
||||||
<< GetNode(adjacent.first).number << std::endl;
|
<< " with weight of " << adjacent.second << std::endl;
|
||||||
// Visiting the undiscovered node will check it's adjacent nodes
|
// 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++;
|
time++;
|
||||||
searchInfo[startNode.number].discoveryFinish.second = time;
|
dfs.nodeInfo[startNode.number].discoveryFinish.second = time;
|
||||||
}
|
}
|
||||||
|
|
||||||
std::vector<Node> Graph::TopologicalSort(const Node &startNode) const
|
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_);
|
std::vector<Node> order(nodes_);
|
||||||
|
|
||||||
auto comp = [&topological](const Node &a, const Node &b) {
|
auto comp = [&topological](const Node &a, const Node &b) {
|
||||||
return (topological[a.number].discoveryFinish.second <
|
return (topological.nodeInfo[a.number].discoveryFinish.second <
|
||||||
topological[b.number].discoveryFinish.second);
|
topological.nodeInfo[b.number].discoveryFinish.second);
|
||||||
};
|
};
|
||||||
|
|
||||||
std::sort(order.begin(), order.end(), comp);
|
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 Graph::KruskalMST() const
|
||||||
{
|
{
|
||||||
InfoMST searchInfo(nodes_);
|
InfoMST mst(nodes_);
|
||||||
// The ctor for InfoMST initializes all edges within the graph into a multimap
|
// 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
|
// + 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
|
// 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 -
|
// + 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
|
// + 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
|
// Two integers representing the node.number for the connected nodes
|
||||||
const int u = edge.second.first;
|
const int u = edge.second.first;
|
||||||
const int v = edge.second.second;
|
const int v = edge.second.second;
|
||||||
// Check if the nodes are of the same tree
|
// 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
|
// If they are not, add the edge to our MST
|
||||||
searchInfo.edgesMST.emplace(edge);
|
mst.edgesMST.emplace(edge);
|
||||||
searchInfo.weightMST += edge.first;
|
mst.totalWeight += edge.first;
|
||||||
// Update the forest to reflect this change
|
// Update the forest to reflect this change
|
||||||
searchInfo.Union(u, v);
|
mst.Union(u, v);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return searchInfo;
|
return mst;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
/*##############################################################################
|
/*##############################################################################
|
||||||
## Author: Shaun Reed ##
|
## 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 ##
|
## About: An example of a weighted graph implementation ##
|
||||||
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
## Algorithms in this example are found in MIT Intro to Algorithms ##
|
||||||
## ##
|
## ##
|
||||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
@@ -10,56 +10,15 @@
|
|||||||
#ifndef LIB_GRAPH_HPP
|
#ifndef LIB_GRAPH_HPP
|
||||||
#define LIB_GRAPH_HPP
|
#define LIB_GRAPH_HPP
|
||||||
|
|
||||||
#include <iostream>
|
|
||||||
#include <algorithm>
|
#include <algorithm>
|
||||||
|
#include <iostream>
|
||||||
#include <map>
|
#include <map>
|
||||||
|
#include <queue>
|
||||||
|
#include <unordered_map>
|
||||||
|
#include <unordered_set>
|
||||||
#include <utility>
|
#include <utility>
|
||||||
#include <vector>
|
#include <vector>
|
||||||
#include <queue>
|
#include <cstdint>
|
||||||
#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>;
|
|
||||||
|
|
||||||
|
|
||||||
/******************************************************************************/
|
/******************************************************************************/
|
||||||
@@ -69,7 +28,8 @@ struct Node {
|
|||||||
public:
|
public:
|
||||||
// Constructors
|
// Constructors
|
||||||
Node(const Node &rhs) = default;
|
Node(const Node &rhs) = default;
|
||||||
Node & operator=(Node rhs) {
|
Node & operator=(Node rhs)
|
||||||
|
{
|
||||||
if (this == &rhs) return *this;
|
if (this == &rhs) return *this;
|
||||||
swap(*this, rhs);
|
swap(*this, rhs);
|
||||||
return *this;
|
return *this;
|
||||||
@@ -80,7 +40,8 @@ public:
|
|||||||
for (const auto &i : adj) adjacent.emplace(i.first, i.second);
|
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.number, b.number);
|
||||||
std::swap(a.adjacent, b.adjacent);
|
std::swap(a.adjacent, b.adjacent);
|
||||||
}
|
}
|
||||||
@@ -95,10 +56,81 @@ public:
|
|||||||
bool operator!=(const Node &b) const { return this->number != b.number;}
|
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>>;
|
using Edges = std::multimap<int, std::pair<int, int>>;
|
||||||
struct InfoMST {
|
struct InfoMST : GraphInfo<MST>{
|
||||||
explicit InfoMST(const std::vector<Node> &nodes) {
|
explicit InfoMST(const std::vector<Node> &nodes)
|
||||||
for (const auto &node : nodes){
|
{
|
||||||
|
for (const auto &node : nodes) {
|
||||||
// Initialize the default values for forest tracked by this struct
|
// Initialize the default values for forest tracked by this struct
|
||||||
// + This data is used in KruskalMST() to find the MST
|
// + This data is used in KruskalMST() to find the MST
|
||||||
MakeSet(node.number);
|
MakeSet(node.number);
|
||||||
@@ -113,20 +145,17 @@ struct InfoMST {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
std::unordered_map<int, struct MST> searchInfo;
|
|
||||||
// All of the edges within our graph
|
// All of the edges within our graph
|
||||||
// + Since each node stores its own edges, this is initialized in InfoMST ctor
|
// + Since each node stores its own edges, this is initialized in InfoMST ctor
|
||||||
Edges edges;
|
Edges edges;
|
||||||
|
|
||||||
// A multimap of the edges found for our MST
|
// A multimap of the edges found for our MST
|
||||||
Edges edgesMST;
|
Edges edgesMST;
|
||||||
// The total weight of our resulting MST
|
|
||||||
int weightMST = 0;
|
|
||||||
|
|
||||||
void MakeSet(int x)
|
void MakeSet(int x)
|
||||||
{
|
{
|
||||||
searchInfo[x].parent = x;
|
nodeInfo[x].parent = x;
|
||||||
searchInfo[x].rank = 0;
|
nodeInfo[x].rank = 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
void Union(int x, int y)
|
void Union(int x, int y)
|
||||||
@@ -136,29 +165,30 @@ struct InfoMST {
|
|||||||
|
|
||||||
void Link(int x, int y)
|
void Link(int x, int y)
|
||||||
{
|
{
|
||||||
if (searchInfo[x].rank > searchInfo[y].rank) {
|
if (nodeInfo[x].rank > nodeInfo[y].rank) {
|
||||||
searchInfo[y].parent = x;
|
nodeInfo[y].parent = x;
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
searchInfo[x].parent = y;
|
nodeInfo[x].parent = y;
|
||||||
if (searchInfo[x].rank == searchInfo[y].rank) {
|
if (nodeInfo[x].rank == nodeInfo[y].rank) {
|
||||||
searchInfo[y].rank += 1;
|
nodeInfo[y].rank += 1;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
int FindSet(int x)
|
int FindSet(int x)
|
||||||
{
|
{
|
||||||
if (x != searchInfo[x].parent) {
|
if (x != nodeInfo[x].parent) {
|
||||||
searchInfo[x].parent = FindSet(searchInfo[x].parent);
|
nodeInfo[x].parent = FindSet(nodeInfo[x].parent);
|
||||||
}
|
}
|
||||||
return searchInfo[x].parent;
|
return nodeInfo[x].parent;
|
||||||
}
|
}
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
/******************************************************************************/
|
/******************************************************************************/
|
||||||
// Graph class declaration
|
// Graph class declaration
|
||||||
|
|
||||||
class Graph {
|
class Graph {
|
||||||
public:
|
public:
|
||||||
// Constructor
|
// Constructor
|
||||||
@@ -173,7 +203,7 @@ public:
|
|||||||
// An alternate DFS that checks each node of the graph beginning at startNode
|
// An alternate DFS that checks each node of the graph beginning at startNode
|
||||||
InfoDFS DFS(const Node &startNode) const;
|
InfoDFS DFS(const Node &startNode) const;
|
||||||
// Visit function is used in both versions of DFS
|
// 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
|
// Topological sort, using DFS
|
||||||
std::vector<Node> TopologicalSort(const Node &startNode) const;
|
std::vector<Node> TopologicalSort(const Node &startNode) const;
|
||||||
// Kruskal's MST
|
// Kruskal's MST
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing various sorting algorithms in C++"
|
DESCRIPTION "A project for practicing various sorting algorithms in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
|
||||||
|
|||||||
@@ -15,9 +15,9 @@
|
|||||||
void BubbleSort(std::vector<int> &array)
|
void BubbleSort(std::vector<int> &array)
|
||||||
{
|
{
|
||||||
// For each value within the set, starting at 0
|
// 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
|
// 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
|
// Swap if the value at j is less than the value before it
|
||||||
if (array[j] < array[j - 1]) {
|
if (array[j] < array[j - 1]) {
|
||||||
std::swap(array[j], array[j - 1]);
|
std::swap(array[j], array[j - 1]);
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ void CountingSort(std::vector<int> &array)
|
|||||||
|
|
||||||
// Count the values less than or equal to each element of tempArray
|
// 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
|
// + 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] += tempArray[i - 1];
|
||||||
// tempArray[i] - 1 now represents the sorted 0-index pos for each value i
|
// tempArray[i] - 1 now represents the sorted 0-index pos for each value i
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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 Left(const size_t &index) { return 2 * index + 1;}
|
||||||
size_t Right(const size_t &index) { return (2 * index) + 2;}
|
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
|
// Get an index for the left and right nodes attached to thisIndex
|
||||||
size_t l = Left(thisIndex);
|
size_t l = Left(thisIndex);
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ size_t Parent(const size_t &index);
|
|||||||
size_t Left(const size_t &index);
|
size_t Left(const size_t &index);
|
||||||
size_t Right(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);
|
void BuildMaxHeap(std::vector<int> &array);
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing insertion sort in C++"
|
DESCRIPTION "A project for practicing insertion sort in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-sort-insertion insertion-sort.cpp
|
algo-sort-insertion insertion-sort.cpp
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ void InsertionSort(std::vector<int> &array)
|
|||||||
{
|
{
|
||||||
// For each value, move left until we find sortedPosition for keyValue
|
// For each value, move left until we find sortedPosition for keyValue
|
||||||
// + Starting with keyValue at array[1], to check sortedPosition at array[0]
|
// + 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
|
// Save the current key value
|
||||||
// + We will look for the sorted position of this value
|
// + We will look for the sorted position of this value
|
||||||
const int keyValue = array[keyIndex];
|
const int keyValue = array[keyIndex];
|
||||||
|
|||||||
@@ -14,6 +14,8 @@ project (
|
|||||||
DESCRIPTION "A project for practicing merge sort in C++"
|
DESCRIPTION "A project for practicing merge sort in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-sort-merge merge-sort.cpp
|
algo-sort-merge merge-sort.cpp
|
||||||
lib-merge.cpp lib-merge.h
|
lib-merge.cpp lib-merge.h
|
||||||
|
|||||||
@@ -12,6 +12,7 @@
|
|||||||
#include <algorithm>
|
#include <algorithm>
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
#include <vector>
|
#include <vector>
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
void MergeSort(std::vector<int> &array, size_t lhs, size_t rhs)
|
void MergeSort(std::vector<int> &array, size_t lhs, size_t rhs)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing quick sort in C++"
|
DESCRIPTION "A project for practicing quick sort in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-sort-quick quick-sort.cpp
|
algo-sort-quick quick-sort.cpp
|
||||||
|
|||||||
@@ -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
|
// + Return this value when done, so we know where the lhs partition ends
|
||||||
ssize_t lhsIndex = begin - 1;
|
ssize_t lhsIndex = begin - 1;
|
||||||
// For each value within this partition, check for values < keyValue
|
// 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) {
|
if (array[j] <= keyValue) {
|
||||||
// Swap all values < keyValue into the lhs portion of array
|
// Swap all values < keyValue into the lhs portion of array
|
||||||
std::swap(array[++lhsIndex], array[j]);
|
std::swap(array[++lhsIndex], array[j]);
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing radix sort in C++"
|
DESCRIPTION "A project for practicing radix sort in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-sort-radix radix-sort.cpp
|
algo-sort-radix radix-sort.cpp
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ void CountingSort(std::vector<int> &array, int placeValue)
|
|||||||
|
|
||||||
// Count the values less than or equal to each element of tempArray
|
// 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
|
// + 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];
|
tempArray[i] = tempArray[i] + tempArray[i - 1];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing selection sort in C++"
|
DESCRIPTION "A project for practicing selection sort in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-sort-select select-sort.cpp
|
algo-sort-select select-sort.cpp
|
||||||
|
|||||||
@@ -12,10 +12,10 @@
|
|||||||
#include <vector>
|
#include <vector>
|
||||||
|
|
||||||
void SelectionSort(std::vector<int> &arr) {
|
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
|
// Get the index for the minimum number in the unsorted set
|
||||||
int min = leftIndex;
|
size_t min = leftIndex;
|
||||||
for (int i = leftIndex; i < arr.size(); i++) {
|
for (size_t i = leftIndex; i < arr.size(); i++) {
|
||||||
// Check if value at i is smaller than value at min index
|
// 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
|
min = (arr[min] > arr[i]) ? i : min; // Update min value to i if true
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing algorithms using trees in C++"
|
DESCRIPTION "A project for practicing algorithms using trees in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for testing BST algorithms"
|
DESCRIPTION "A project for testing BST algorithms"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-trees-bst driver.cpp
|
algo-trees-bst driver.cpp
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for testing red-black tree algorithms"
|
DESCRIPTION "A project for testing red-black tree algorithms"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
algo-trees-redblack driver.cpp
|
algo-trees-redblack driver.cpp
|
||||||
|
|||||||
@@ -12,6 +12,7 @@
|
|||||||
#define REDBLACK_H
|
#define REDBLACK_H
|
||||||
|
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
enum Color {Black, Red};
|
enum Color {Black, Red};
|
||||||
|
|
||||||
|
|||||||
35
cpp/catch2/CMakeLists.txt
Normal file
35
cpp/catch2/CMakeLists.txt
Normal file
@@ -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)
|
||||||
10
cpp/catch2/include/klips.hpp
Normal file
10
cpp/catch2/include/klips.hpp
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
|
||||||
|
#ifndef KLIPS_KLIPS_H
|
||||||
|
#define KLIPS_KLIPS_H
|
||||||
|
|
||||||
|
|
||||||
|
class klips { };
|
||||||
|
|
||||||
|
unsigned int factorial(unsigned int);
|
||||||
|
|
||||||
|
#endif // KLIPS_KLIPS_H
|
||||||
29
cpp/catch2/include/type_name.hpp
Normal file
29
cpp/catch2/include/type_name.hpp
Normal file
@@ -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
|
||||||
4
cpp/catch2/src/klips.cpp
Normal file
4
cpp/catch2/src/klips.cpp
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
|
||||||
|
unsigned int factorial( unsigned int number ) {
|
||||||
|
return number <= 1 ? number : factorial(number-1)*number;
|
||||||
|
}
|
||||||
148
cpp/catch2/src/test_klips.cpp
Normal file
148
cpp/catch2/src/test_klips.cpp
Normal file
@@ -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>();
|
||||||
|
}
|
||||||
@@ -22,6 +22,7 @@ project (
|
|||||||
DESCRIPTION "A basic CMake template for C++ projects"
|
DESCRIPTION "A basic CMake template for C++ projects"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
# Include any directories the compiler may need
|
# Include any directories the compiler may need
|
||||||
include_directories(./include)
|
include_directories(./include)
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing cryptography in C++"
|
DESCRIPTION "A project for practicing cryptography in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "Practice implementing columnar transposition in C++"
|
DESCRIPTION "Practice implementing columnar transposition in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
crypto-columnar-transposition driver.cpp
|
crypto-columnar-transposition driver.cpp
|
||||||
|
|||||||
@@ -21,9 +21,9 @@ void Columnar::InitOrder(std::string temp)
|
|||||||
temp.erase(it, temp.end());
|
temp.erase(it, temp.end());
|
||||||
|
|
||||||
// Step through each character in lexicographic order
|
// 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
|
// 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 they are equal, push the index of the char in keyWord to orderVect
|
||||||
if (keyWord_[j] == temp[i]) {
|
if (keyWord_[j] == temp[i]) {
|
||||||
orderVect_.push_back(j);
|
orderVect_.push_back(j);
|
||||||
@@ -109,7 +109,7 @@ std::string Columnar::Decrypt(std::string message)
|
|||||||
rows.resize(orderVect_.size());
|
rows.resize(orderVect_.size());
|
||||||
// Track the ending position after each substring is taken
|
// Track the ending position after each substring is taken
|
||||||
int lastPos = 0;
|
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 we are assigning to any row < fullRows, it should have + 1 character
|
||||||
if (orderVect_[i] < fullRows) {
|
if (orderVect_[i] < fullRows) {
|
||||||
rows[orderVect_[i]] = message.substr(lastPos, rowLength + 1);
|
rows[orderVect_[i]] = message.substr(lastPos, rowLength + 1);
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing various data structures in C++"
|
DESCRIPTION "A project for practicing various data structures in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for testing a basic implementation of a BST"
|
DESCRIPTION "A project for testing a basic implementation of a BST"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
data-bst driver.cpp
|
data-bst driver.cpp
|
||||||
|
|||||||
@@ -10,10 +10,11 @@
|
|||||||
|
|
||||||
#include "bst.h"
|
#include "bst.h"
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
/********************************************************************************
|
/********************************************************************************
|
||||||
* Constructors, Destructors, Operators
|
* Constructors, Destructors, Operators
|
||||||
*********************************************************************************/
|
*********************************************************************************/
|
||||||
|
|
||||||
/** Copy Assignment Operator
|
/** Copy Assignment Operator
|
||||||
* @brief Empty the calling object's root BinaryNode, and copy the rhs data
|
* @brief Empty the calling object's root BinaryNode, and copy the rhs data
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "Project for testing circular doubly linked list implementation"
|
DESCRIPTION "Project for testing circular doubly linked list implementation"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
data-circular-doubly-linked-list driver.cpp
|
data-circular-doubly-linked-list driver.cpp
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
#include "circledoublelist.h"
|
#include "circledoublelist.h"
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
/******************************************************************************
|
/******************************************************************************
|
||||||
* Constructors, Destructors, Operators
|
* Constructors, Destructors, Operators
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "Project for testing circular singly linked list implementation"
|
DESCRIPTION "Project for testing circular singly linked list implementation"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
data-circular-singly-linked-list driver.cpp
|
data-circular-singly-linked-list driver.cpp
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
#include "circlesinglelist.h"
|
#include "circlesinglelist.h"
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
/******************************************************************************
|
/******************************************************************************
|
||||||
* Constructors, Destructors, Operators
|
* Constructors, Destructors, Operators
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for testing a doubly linked list implementation"
|
DESCRIPTION "A project for testing a doubly linked list implementation"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
data-doubly-linked-list driver.cpp
|
data-doubly-linked-list driver.cpp
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
#include "doublelist.h"
|
#include "doublelist.h"
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
/******************************************************************************
|
/******************************************************************************
|
||||||
* Constructors, Destructors, Operators
|
* Constructors, Destructors, Operators
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for testing a max heap implementation"
|
DESCRIPTION "A project for testing a max heap implementation"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
data-max-heap driver.cpp
|
data-max-heap driver.cpp
|
||||||
|
|||||||
@@ -10,10 +10,11 @@
|
|||||||
|
|
||||||
#include "maxheap.h"
|
#include "maxheap.h"
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
/********************************************************************************
|
/********************************************************************************
|
||||||
* Constructors, Destructors, Operators
|
* Constructors, Destructors, Operators
|
||||||
*********************************************************************************/
|
*********************************************************************************/
|
||||||
|
|
||||||
/** default constructor
|
/** default constructor
|
||||||
* Constructs a heap with the given default values
|
* Constructs a heap with the given default values
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "Project for testing queue implementation"
|
DESCRIPTION "Project for testing queue implementation"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
data-queue driver.cpp
|
data-queue driver.cpp
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
#include "queuelist.h"
|
#include "queuelist.h"
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
/******************************************************************************
|
/******************************************************************************
|
||||||
* Constructors, Destructors, Operators
|
* Constructors, Destructors, Operators
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for testing a singly linked list implementation"
|
DESCRIPTION "A project for testing a singly linked list implementation"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
data-singly-linked-list driver.cpp
|
data-singly-linked-list driver.cpp
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
#include "singlelist.h"
|
#include "singlelist.h"
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
/******************************************************************************
|
/******************************************************************************
|
||||||
* Constructors, Destructors, Operators
|
* Constructors, Destructors, Operators
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for testing a Stack implementation"
|
DESCRIPTION "A project for testing a Stack implementation"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
data-stack driver.cpp
|
data-stack driver.cpp
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
#include "stacklist.h"
|
#include "stacklist.h"
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
/******************************************************************************
|
/******************************************************************************
|
||||||
* Constructors, Destructors, Operators
|
* Constructors, Destructors, Operators
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for practicing templated data structures in C++"
|
DESCRIPTION "A project for practicing templated data structures in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_subdirectory(doublelist)
|
add_subdirectory(doublelist)
|
||||||
add_subdirectory(queuelist)
|
add_subdirectory(queuelist)
|
||||||
|
|||||||
@@ -14,5 +14,6 @@ project (
|
|||||||
DESCRIPTION "A project for practicing templated doubly linked list implementations"
|
DESCRIPTION "A project for practicing templated doubly linked list implementations"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(data-templates-doubly-linked-list driver.cpp)
|
add_executable(data-templates-doubly-linked-list driver.cpp)
|
||||||
|
|||||||
@@ -14,5 +14,6 @@ project (
|
|||||||
DESCRIPTION "A project for practicing templated queue implementations"
|
DESCRIPTION "A project for practicing templated queue implementations"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(data-templates-queue driver.cpp)
|
add_executable(data-templates-queue driver.cpp)
|
||||||
|
|||||||
@@ -14,5 +14,6 @@ project (
|
|||||||
DESCRIPTION "A project for practicing templated Stack implementations"
|
DESCRIPTION "A project for practicing templated Stack implementations"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(data-templates-stack driver.cpp)
|
add_executable(data-templates-stack driver.cpp)
|
||||||
|
|||||||
@@ -14,5 +14,6 @@ project (
|
|||||||
DESCRIPTION "A project for practicing templated Vector implementations"
|
DESCRIPTION "A project for practicing templated Vector implementations"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(data-templates-vectors driver.cpp)
|
add_executable(data-templates-vectors driver.cpp)
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project (
|
|||||||
DESCRIPTION "A project for testing a basic Vector implementation"
|
DESCRIPTION "A project for testing a basic Vector implementation"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
data-vectors driver.cpp
|
data-vectors driver.cpp
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
#include "vector.h"
|
#include "vector.h"
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
/******************************************************************************
|
/******************************************************************************
|
||||||
* Constructors, Destructors, Operators
|
* Constructors, Destructors, Operators
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
################################################################################
|
################################################################################
|
||||||
## Author: Shaun Reed ##
|
## Author: Shaun Reed ##
|
||||||
## Legal: All Content (c) 2021 Shaun Reed, all rights reserved ##
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
## About: A root project for practicing C++ ##
|
## About: A root project for practicing C++ ##
|
||||||
## This project can be built to debug and run all nested projects ##
|
## This project can be built to debug and run all nested projects ##
|
||||||
## Or, any subdirectory with a project() statement can be selected ##
|
## Or, any subdirectory with a project() statement can be selected ##
|
||||||
@@ -16,6 +16,7 @@ project(
|
|||||||
DESCRIPTION "A root project for practicing graphics programming in C++"
|
DESCRIPTION "A root project for practicing graphics programming in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
################################################################################
|
################################################################################
|
||||||
## Author: Shaun Reed ##
|
## Author: Shaun Reed ##
|
||||||
## Legal: All Content (c) 2021 Shaun Reed, all rights reserved ##
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
## ##
|
## ##
|
||||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
################################################################################
|
################################################################################
|
||||||
@@ -8,40 +8,46 @@
|
|||||||
# Define CMake version
|
# Define CMake version
|
||||||
cmake_minimum_required(VERSION 3.15)
|
cmake_minimum_required(VERSION 3.15)
|
||||||
|
|
||||||
|
include(FetchContent)
|
||||||
project(
|
project(
|
||||||
#[[NAME]] OpenGL-Cmake
|
#[[NAME]] OpenGL-Cmake
|
||||||
DESCRIPTION "Example project for building OpenGL projects with CMake"
|
DESCRIPTION "Example project for building OpenGL projects with CMake"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_library(graphics-lib-opengl src/lib-opengl-test.cpp)
|
add_library(graphics-lib-opengl src/lib-opengl-test.cpp)
|
||||||
target_include_directories(graphics-lib-opengl PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src)
|
target_include_directories(graphics-lib-opengl PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src)
|
||||||
|
|
||||||
# Find OpenGL package
|
# Find OpenGL package
|
||||||
find_package(OpenGL REQUIRED)
|
find_package(OpenGL)
|
||||||
if (OPENGL_FOUND)
|
if (NOT OPENGL_FOUND)
|
||||||
# Link opengl-test executable to OpenGL
|
|
||||||
target_include_directories(graphics-lib-opengl PUBLIC ${OPENGL_INCLUDE_DIR})
|
|
||||||
target_link_libraries(graphics-lib-opengl PUBLIC ${OPENGL_LIBRARIES})
|
|
||||||
else()
|
|
||||||
message(
|
message(
|
||||||
"Error: CMake was unable to find the OpenGL package\n"
|
"[Klips] Error: CMake was unable to find OpenGL.\n"
|
||||||
"Please install OpenGL and try again\n"
|
"On Ubuntu 24.04 OpenGL can be installed using apt:\n"
|
||||||
|
" sudo apt install libopengl-dev libgl1-mesa-dev mesa-common-dev libglu1-mesa-dev\n"
|
||||||
)
|
)
|
||||||
endif()
|
endif()
|
||||||
|
# Link opengl-test executable to OpenGL
|
||||||
|
message(STATUS "[Klips] Found OpenGL: ${OPENGL_INCLUDE_DIR}")
|
||||||
|
target_include_directories(graphics-lib-opengl PUBLIC ${OPENGL_INCLUDE_DIR})
|
||||||
|
target_link_libraries(graphics-lib-opengl PUBLIC ${OPENGL_LIBRARIES})
|
||||||
|
|
||||||
# Find GLUT package
|
find_package(GLUT QUIET)
|
||||||
find_package(GLUT REQUIRED)
|
if(NOT GLUT_FOUND)
|
||||||
if (GLUT_FOUND)
|
|
||||||
# Link lib-opengl-test executable to GLUT
|
|
||||||
target_include_directories(graphics-lib-opengl PUBLIC ${GLUT_INCLUDE_DIR})
|
|
||||||
target_link_libraries(graphics-lib-opengl PUBLIC ${GLUT_LIBRARIES})
|
|
||||||
else()
|
|
||||||
message(
|
message(
|
||||||
"Error: CMake was unable to find the GLUT package\n"
|
FATAL_ERROR
|
||||||
"Please install GLUT (freeglut3-dev) and try again\n"
|
"[Klips] Failed to fetch GLUT. Could not find dependency X11 input libraries.\n"
|
||||||
|
"On Ubuntu 24.04 Xi can be installed using apt:\n"
|
||||||
|
" sudo apt install libxi-dev\n"
|
||||||
|
"Alternatively, on Ubuntu 24.04 GLUT can be installed with apt:\n"
|
||||||
|
" sudo apt install freeglut3-dev\n"
|
||||||
)
|
)
|
||||||
endif()
|
endif()
|
||||||
|
message(STATUS "[Klips] Found GLUT: ${GLUT_INCLUDE_DIR}")
|
||||||
|
# Link lib-opengl-test executable to GLUT
|
||||||
|
target_include_directories(graphics-lib-opengl PUBLIC ${GLUT_INCLUDE_DIR})
|
||||||
|
target_link_libraries(graphics-lib-opengl PUBLIC ${GLUT_LIBRARIES})
|
||||||
|
|
||||||
# Add test executable
|
# Add test executable
|
||||||
add_executable(graphics-cmake-opengl apps/test-gl.cpp)
|
add_executable(graphics-cmake-opengl apps/test-gl.cpp)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
################################################################################
|
################################################################################
|
||||||
## Author: Shaun Reed ##
|
## Author: Shaun Reed ##
|
||||||
## Legal: All Content (c) 2021 Shaun Reed, all rights reserved ##
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
## ##
|
## ##
|
||||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
################################################################################
|
################################################################################
|
||||||
@@ -13,6 +13,7 @@ project(
|
|||||||
DESCRIPTION "Example project for building SDL projects with CMake"
|
DESCRIPTION "Example project for building SDL projects with CMake"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
# Add Library
|
# Add Library
|
||||||
add_library(
|
add_library(
|
||||||
@@ -27,31 +28,30 @@ target_include_directories( # When calling library, include a directo
|
|||||||
)
|
)
|
||||||
|
|
||||||
# Search for SDL2 package
|
# Search for SDL2 package
|
||||||
find_package(SDL2 REQUIRED sdl2)
|
find_package(SDL2 QUIET)
|
||||||
|
if (NOT SDL2_FOUND)
|
||||||
# If SDL2 was found successfully, link to lib-sdl-test
|
message(FATAL_ERROR
|
||||||
if (SDL2_FOUND)
|
"[Klips] Failed to find SDL2.\n"
|
||||||
# Any target that links with this library will also link to SDL2
|
"On Ubuntu 24.04 SDL2 can be installed using apt:\n"
|
||||||
# + Because we choose PUBLIC visibility
|
" sudo apt install libsdl2-dev\n"
|
||||||
target_include_directories(graphics-lib-sdl PUBLIC ${SDL2_INCLUDE_DIRS})
|
|
||||||
target_link_libraries(graphics-lib-sdl PUBLIC "${SDL2_LIBRARIES}")
|
|
||||||
|
|
||||||
# Creating executable
|
|
||||||
add_executable(
|
|
||||||
graphics-cmake-sdl # Exe name
|
|
||||||
apps/sdl-test.cpp # Exe Source(s)
|
|
||||||
)
|
|
||||||
|
|
||||||
# Linking the exe to library
|
|
||||||
target_link_libraries(
|
|
||||||
graphics-cmake-sdl # Executable to link
|
|
||||||
PRIVATE # Visibility
|
|
||||||
graphics-lib-sdl # Library to link
|
|
||||||
)
|
|
||||||
|
|
||||||
else()
|
|
||||||
message(
|
|
||||||
"Error: CMake was unable to find SDL2 package.\n"
|
|
||||||
"Please install the libsdl2-dev package and try again.\n"
|
|
||||||
)
|
)
|
||||||
endif()
|
endif()
|
||||||
|
message(STATUS "[Klips] Found SDL2: ${SDL2_INCLUDE_DIRS}")
|
||||||
|
|
||||||
|
# Any target that links with this library will also link to SDL2
|
||||||
|
# + Because we choose PUBLIC visibility
|
||||||
|
target_include_directories(graphics-lib-sdl PUBLIC ${SDL2_INCLUDE_DIRS})
|
||||||
|
target_link_libraries(graphics-lib-sdl PUBLIC "${SDL2_LIBRARIES}")
|
||||||
|
|
||||||
|
# Creating executable
|
||||||
|
add_executable(
|
||||||
|
graphics-cmake-sdl # Exe name
|
||||||
|
apps/sdl-test.cpp # Exe Source(s)
|
||||||
|
)
|
||||||
|
|
||||||
|
# Linking the exe to library
|
||||||
|
target_link_libraries(
|
||||||
|
graphics-cmake-sdl # Executable to link
|
||||||
|
PRIVATE # Visibility
|
||||||
|
graphics-lib-sdl # Library to link
|
||||||
|
)
|
||||||
25
cpp/multithreading/CMakeLists.txt
Normal file
25
cpp/multithreading/CMakeLists.txt
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
################################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: A root project for practicing C++ multithreading ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
cmake_minimum_required(VERSION 3.16)
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] Multithreading
|
||||||
|
VERSION 1.0
|
||||||
|
DESCRIPTION "Practice with multithreaded programming in C++"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
|
add_subdirectory(conditions)
|
||||||
|
add_subdirectory(deadlock)
|
||||||
|
add_subdirectory(livelock)
|
||||||
|
add_subdirectory(race-condition)
|
||||||
25
cpp/multithreading/README.md
Normal file
25
cpp/multithreading/README.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# Multithreading
|
||||||
|
|
||||||
|
A few basic multithreading programs written in C++ while learning about
|
||||||
|
the [concurrency support library](https://en.cppreference.com/w/cpp/thread)
|
||||||
|
|
||||||
|
```
|
||||||
|
klips/cpp/multithreading
|
||||||
|
.
|
||||||
|
├── conditions # Using condition_variable to control job execution flow
|
||||||
|
├── deadlock # Example of problem and solution for deadlocks
|
||||||
|
├── livelock # Example of problem and solution for livelocks
|
||||||
|
├── race-condition # Example of problem and solution for race conditions
|
||||||
|
└── README.md
|
||||||
|
```
|
||||||
|
|
||||||
|
We can build the examples with the following commands.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /path/to/klips/cpp/multithreading/
|
||||||
|
mkdir build && cd build
|
||||||
|
cmake .. && cmake --build .
|
||||||
|
ls bin/
|
||||||
|
|
||||||
|
multithread-conditions multithread-deadlock multithread-livelock multithread-race-condition
|
||||||
|
```
|
||||||
27
cpp/multithreading/conditions/CMakeLists.txt
Normal file
27
cpp/multithreading/conditions/CMakeLists.txt
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
################################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: An example of condition_variables in multithreaded C++ ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
cmake_minimum_required(VERSION 3.16)
|
||||||
|
|
||||||
|
# std::scoped_lock requires C++17
|
||||||
|
set(CMAKE_CXX_STANDARD 17)
|
||||||
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] ConditionVariables
|
||||||
|
VERSION 1.0
|
||||||
|
DESCRIPTION "Example of condition_variables in multithreaded C++"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
|
add_executable(
|
||||||
|
multithread-conditions driver.cpp
|
||||||
|
)
|
||||||
|
|
||||||
|
target_link_libraries(multithread-conditions pthread)
|
||||||
62
cpp/multithreading/conditions/driver.cpp
Normal file
62
cpp/multithreading/conditions/driver.cpp
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
/*##############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: An example of condition_variables in multithreaded C++ ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <chrono>
|
||||||
|
#include <condition_variable>
|
||||||
|
#include <iostream>
|
||||||
|
#include <mutex>
|
||||||
|
#include <thread>
|
||||||
|
|
||||||
|
static std::mutex mtx;
|
||||||
|
std::condition_variable cv;
|
||||||
|
bool processing = false;
|
||||||
|
|
||||||
|
// Starts a job that waits for kick-off from main
|
||||||
|
// + When job finishes, handoff result back to main via processing bool
|
||||||
|
void job(int32_t & shared) {
|
||||||
|
std::unique_lock uniqueLock(mtx);
|
||||||
|
cv.wait(uniqueLock, []()->bool {return processing;});
|
||||||
|
std::cout << std::this_thread::get_id()
|
||||||
|
<< " thread_A: Initial value of shared = " << shared << std::endl;
|
||||||
|
while (shared < INT32_MAX) {
|
||||||
|
shared++;
|
||||||
|
}
|
||||||
|
// We're no longer processing data
|
||||||
|
processing = false;
|
||||||
|
std::cout << std::this_thread::get_id()
|
||||||
|
<< " thread_A: Done working." << std::endl;
|
||||||
|
uniqueLock.unlock(); // Important! Unlock uniqueLock before we notify
|
||||||
|
// Notify main that we've finished, so it can proceed
|
||||||
|
cv.notify_one();
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(const int argc, const char * argv[]) {
|
||||||
|
std::cout << "main() thread id: " << std::this_thread::get_id() << std::endl;
|
||||||
|
|
||||||
|
int32_t share = 0;
|
||||||
|
std::thread thread_A(job, std::ref(share));
|
||||||
|
|
||||||
|
mtx.lock();
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(3));
|
||||||
|
share = INT32_MAX / 2;
|
||||||
|
processing = true;
|
||||||
|
mtx.unlock();
|
||||||
|
// Notify thread_A that its work can begin
|
||||||
|
cv.notify_one();
|
||||||
|
|
||||||
|
// Wait until thread_A finishes its work
|
||||||
|
std::unique_lock uniqueLock(mtx);
|
||||||
|
// Block execution until we are not processing
|
||||||
|
cv.wait(uniqueLock, []()->bool { return !processing;});
|
||||||
|
std::cout << std::this_thread::get_id() << " main(): final value of shared = "
|
||||||
|
<< share << std::endl;
|
||||||
|
thread_A.join();
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
27
cpp/multithreading/deadlock/CMakeLists.txt
Normal file
27
cpp/multithreading/deadlock/CMakeLists.txt
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
################################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: An example and solution for deadlocks in C++ ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
cmake_minimum_required(VERSION 3.16)
|
||||||
|
|
||||||
|
# std::scoped_lock requires C++17
|
||||||
|
set(CMAKE_CXX_STANDARD 17)
|
||||||
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] Deadlock
|
||||||
|
VERSION 1.0
|
||||||
|
DESCRIPTION "Example and solution for deadlocks in C++"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
|
add_executable(
|
||||||
|
multithread-deadlock driver.cpp
|
||||||
|
)
|
||||||
|
|
||||||
|
target_link_libraries(multithread-deadlock pthread)
|
||||||
189
cpp/multithreading/deadlock/driver.cpp
Normal file
189
cpp/multithreading/deadlock/driver.cpp
Normal file
@@ -0,0 +1,189 @@
|
|||||||
|
/*##############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: An example and solution for deadlocks in C++ ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <chrono>
|
||||||
|
#include <iostream>
|
||||||
|
#include <mutex>
|
||||||
|
#include <sstream>
|
||||||
|
#include <thread>
|
||||||
|
|
||||||
|
static std::mutex mtx_A, mtx_B, output;
|
||||||
|
|
||||||
|
// Helper function to output thread ID and string associated with mutex name
|
||||||
|
// + This must also be thread-safe, since we want threads to produce output
|
||||||
|
// + There is no bug or issue here; This is just in support of example output
|
||||||
|
void print_safe(const std::string & s) {
|
||||||
|
std::scoped_lock<std::mutex> scopedLock(output);
|
||||||
|
std::cout << s << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper function to convert std::thread::id to string
|
||||||
|
std::string id_string(const std::thread::id & id) {
|
||||||
|
std::stringstream stream;
|
||||||
|
stream << id;
|
||||||
|
return stream.str();
|
||||||
|
}
|
||||||
|
|
||||||
|
// In the two threads within this function, we have a problem
|
||||||
|
// + The mutex locks are acquired in reverse order, so they collide
|
||||||
|
// + This is called a deadlock; The program will *never* finish
|
||||||
|
void problem() {
|
||||||
|
std::thread thread_A([]()->void {
|
||||||
|
mtx_A.lock();
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + " thread_A: Locked A");
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
mtx_B.lock(); // We can't lock B! thread_B is using it
|
||||||
|
// The program will never reach this point in execution; We are in deadlock
|
||||||
|
print_safe(id_string(std::this_thread::get_id())
|
||||||
|
+ " thread_A: B has been unlocked, we can proceed!\n Locked B"
|
||||||
|
);
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
|
||||||
|
print_safe(id_string(std::this_thread::get_id())
|
||||||
|
+ " thread_A: Unlocking A, B..."
|
||||||
|
);
|
||||||
|
mtx_A.unlock();
|
||||||
|
mtx_B.unlock();
|
||||||
|
});
|
||||||
|
|
||||||
|
std::thread thread_B([]()->void {
|
||||||
|
mtx_B.lock();
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + " thread_B: Locked B");
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
mtx_A.lock(); // We can't lock A! thread_A is using it
|
||||||
|
// The program will never reach this point in execution; We are in deadlock
|
||||||
|
print_safe(id_string(std::this_thread::get_id())
|
||||||
|
+ " thread_B: A has been unlocked, we can proceed!\n Locked A"
|
||||||
|
);
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
|
||||||
|
print_safe(id_string(std::this_thread::get_id())
|
||||||
|
+ " thread_B: Unlocking B, A..."
|
||||||
|
);
|
||||||
|
mtx_B.unlock();
|
||||||
|
mtx_A.unlock();
|
||||||
|
});
|
||||||
|
|
||||||
|
// This offers a way out of the deadlock, so we can proceed to the solution
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(2));
|
||||||
|
char input;
|
||||||
|
print_safe("\n"
|
||||||
|
+ id_string(std::this_thread::get_id())
|
||||||
|
+ " problem(): We are in a deadlock. \n"
|
||||||
|
+ " Enter y/Y to continue to the solution...\n"
|
||||||
|
);
|
||||||
|
while (std::cin >> input) {
|
||||||
|
if (input != 'Y' && input != 'y') continue;
|
||||||
|
else break;
|
||||||
|
}
|
||||||
|
print_safe(id_string(std::this_thread::get_id())
|
||||||
|
+ " problem(): Unlocking A, B..."
|
||||||
|
);
|
||||||
|
mtx_A.unlock();
|
||||||
|
mtx_B.unlock();
|
||||||
|
|
||||||
|
thread_A.join();
|
||||||
|
thread_B.join();
|
||||||
|
}
|
||||||
|
|
||||||
|
// std::lock will lock N mutex locks
|
||||||
|
// + If either is in use, execution will block until both are available to lock
|
||||||
|
void solution_A() {
|
||||||
|
std::thread thread_A([]()->void {
|
||||||
|
std::lock(mtx_A, mtx_B);
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Locked A, B");
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Unlocking A, B...");
|
||||||
|
mtx_A.unlock();
|
||||||
|
mtx_B.unlock();
|
||||||
|
});
|
||||||
|
|
||||||
|
std::thread thread_B([]()->void {
|
||||||
|
std::lock(mtx_B, mtx_A);
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Locked B, A");
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Unlocking B, A...");
|
||||||
|
mtx_B.unlock();
|
||||||
|
mtx_A.unlock();
|
||||||
|
});
|
||||||
|
|
||||||
|
thread_A.join();
|
||||||
|
thread_B.join();
|
||||||
|
}
|
||||||
|
|
||||||
|
// std::lock_guard is a C++11 object which can be constructed with 1 mutex
|
||||||
|
// + When the program leaves the scope of the guard, the mutex is unlocked
|
||||||
|
void solution_B() {
|
||||||
|
std::thread thread_A([]()->void {
|
||||||
|
// lock_guard will handle unlocking when program leaves this scope
|
||||||
|
std::lock_guard<std::mutex> guard_A(mtx_A), guard_B(mtx_B);
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Locked A, B");
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Unlocking A, B...");
|
||||||
|
// We don't need to explicitly unlock either mutex
|
||||||
|
});
|
||||||
|
|
||||||
|
std::thread thread_B([]()->void {
|
||||||
|
std::lock_guard<std::mutex> guard_B(mtx_B), guard_A(mtx_A);
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Locked B, A");
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Unlocking B, A...");
|
||||||
|
// We don't need to explicitly unlock either mutex
|
||||||
|
});
|
||||||
|
|
||||||
|
thread_A.join();
|
||||||
|
thread_B.join();
|
||||||
|
}
|
||||||
|
|
||||||
|
// std::scoped_lock is a C++17 object that can be constructed with N mutex
|
||||||
|
// + When the program leaves this scope, all N mutex will be unlocked
|
||||||
|
void solution_C() {
|
||||||
|
std::thread thread_A([]()->void {
|
||||||
|
// scoped_lock will handle unlocking when program leaves this scope
|
||||||
|
std::scoped_lock scopedLock(mtx_A, mtx_B);
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Locked A, B");
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Unlocking A, B...");
|
||||||
|
// We don't need to explicitly unlock either mutex
|
||||||
|
});
|
||||||
|
|
||||||
|
std::thread thread_B([]()->void {
|
||||||
|
std::scoped_lock scopedLock(mtx_B, mtx_A);
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Locked B, A");
|
||||||
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
||||||
|
|
||||||
|
print_safe(id_string(std::this_thread::get_id()) + ": Unlocking B, A...");
|
||||||
|
// We don't need to explicitly unlock either mutex
|
||||||
|
});
|
||||||
|
|
||||||
|
thread_A.join();
|
||||||
|
thread_B.join();
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(const int argc, const char * argv[]) {
|
||||||
|
std::cout << "main() thread id: " << std::this_thread::get_id() << std::endl;
|
||||||
|
|
||||||
|
problem();
|
||||||
|
|
||||||
|
print_safe("\nsolution_A, using std::lock\n");
|
||||||
|
solution_A();
|
||||||
|
|
||||||
|
print_safe("\nsolution_B, using std::lock_guard\n");
|
||||||
|
solution_B();
|
||||||
|
|
||||||
|
print_safe("\nsolution_C, using std::scoped_lock\n");
|
||||||
|
solution_C();
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
27
cpp/multithreading/livelock/CMakeLists.txt
Normal file
27
cpp/multithreading/livelock/CMakeLists.txt
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
################################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: An example and solution for livelocks in C++ ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
cmake_minimum_required(VERSION 3.16)
|
||||||
|
|
||||||
|
# std::scoped_lock requires C++17
|
||||||
|
set(CMAKE_CXX_STANDARD 17)
|
||||||
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] LiveLock
|
||||||
|
VERSION 1.0
|
||||||
|
DESCRIPTION "Example and solution for livelocks in C++"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
|
add_executable(
|
||||||
|
multithread-livelock driver.cpp
|
||||||
|
)
|
||||||
|
|
||||||
|
target_link_libraries(multithread-livelock pthread)
|
||||||
117
cpp/multithreading/livelock/driver.cpp
Normal file
117
cpp/multithreading/livelock/driver.cpp
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
/*##############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: An example and solution for livelocks in C++ ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <chrono>
|
||||||
|
#include <iostream>
|
||||||
|
#include <mutex>
|
||||||
|
#include <thread>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
static std::mutex mtx_A, mtx_B, output;
|
||||||
|
|
||||||
|
// Helper function to output thread ID and string associated with mutex name
|
||||||
|
// + This must also be thread-safe, since we want threads to produce output
|
||||||
|
// + There is no bug or issue here; This is just in support of example output
|
||||||
|
void print_safe(const std::string & s) {
|
||||||
|
std::scoped_lock<std::mutex> scopedLock(output);
|
||||||
|
std::cout << s << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
void problem() {
|
||||||
|
// Construct a vector with 5 agreed-upon times to synchronize loops in threads
|
||||||
|
typedef std::chrono::time_point<std::chrono::steady_clock,
|
||||||
|
std::chrono::steady_clock::duration> time_point;
|
||||||
|
std::vector<time_point> waitTime(6);
|
||||||
|
for (uint8_t i = 0; i < 6; i++) {
|
||||||
|
waitTime[i] = std::chrono::steady_clock::now()+std::chrono::seconds(1+i);
|
||||||
|
}
|
||||||
|
|
||||||
|
std::thread thread_A([waitTime]()->void {
|
||||||
|
uint8_t count = 0; // Used to select time slot from waitTime vector
|
||||||
|
bool done = false;
|
||||||
|
while (!done) {
|
||||||
|
count++;
|
||||||
|
std::lock_guard l(mtx_A);
|
||||||
|
std::cout << std::this_thread::get_id() << " thread_A: Lock A\n";
|
||||||
|
// Wait until the next time slot to continue
|
||||||
|
// + Helps to show example of livelock by ensuring B is not available
|
||||||
|
std::this_thread::sleep_until(waitTime[count]);
|
||||||
|
std::cout << std::this_thread::get_id() << " thread_A: Requesting B\n";
|
||||||
|
if (mtx_B.try_lock()) {
|
||||||
|
done = true;
|
||||||
|
std::cout << std::this_thread::get_id()
|
||||||
|
<< " thread_A: Acquired locks for A, B! Done.\n";
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
std::cout << std::this_thread::get_id()
|
||||||
|
<< " thread_A: Can't lock B, unlocking A\n";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mtx_B.unlock();
|
||||||
|
});
|
||||||
|
|
||||||
|
std::thread thread_B([waitTime]()->void {
|
||||||
|
// As an example, enter livelock for only 5 iterations
|
||||||
|
// + Also used to select time slot from waitTime vector
|
||||||
|
uint8_t count = 0;
|
||||||
|
bool done = false;
|
||||||
|
while (!done && count < 5) {
|
||||||
|
count++;
|
||||||
|
std::lock_guard l(mtx_B);
|
||||||
|
// Wait until the next time slot to continue
|
||||||
|
// + Helps to show example of livelock by ensuring A is not available
|
||||||
|
std::this_thread::sleep_until(waitTime[count]);
|
||||||
|
if (mtx_A.try_lock()) {
|
||||||
|
// The program will never reach this point in the code
|
||||||
|
// + The only reason livelock ends is because count > 5
|
||||||
|
done = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
thread_A.join();
|
||||||
|
thread_B.join();
|
||||||
|
}
|
||||||
|
|
||||||
|
// The solution below uses std::scoped_lock to avoid the livelock problem
|
||||||
|
void solution() {
|
||||||
|
std::thread thread_A([]()->void {
|
||||||
|
for (int i = 0; i < 5; i++) {
|
||||||
|
// Increase wait time with i
|
||||||
|
// + To encourage alternating lock ownership between threads
|
||||||
|
std::this_thread::sleep_for(std::chrono::milliseconds(100 * i));
|
||||||
|
std::scoped_lock l(mtx_A, mtx_B);
|
||||||
|
std::cout << std::this_thread::get_id()
|
||||||
|
<< " thread_A: Acquired locks for A, B!" << std::endl;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
std::thread thread_B([]()->void {
|
||||||
|
for (int i = 0; i < 5; i++) {
|
||||||
|
std::this_thread::sleep_for(std::chrono::milliseconds(100 * i));
|
||||||
|
std::scoped_lock l(mtx_B, mtx_A);
|
||||||
|
std::cout << std::this_thread::get_id()
|
||||||
|
<< " thread_B: Acquired locks for B, A!" << std::endl;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
thread_A.join();
|
||||||
|
thread_B.join();
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(const int argc, const char * argv[]) {
|
||||||
|
std::cout << "main() thread id: " << std::this_thread::get_id() << std::endl;
|
||||||
|
|
||||||
|
problem();
|
||||||
|
|
||||||
|
std::cout << "\nSolution:\n\n";
|
||||||
|
solution();
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
23
cpp/multithreading/race-condition/CMakeLists.txt
Normal file
23
cpp/multithreading/race-condition/CMakeLists.txt
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
################################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: An example and solution for race conditions in C++ ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
cmake_minimum_required(VERSION 3.16)
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] RaceCondition
|
||||||
|
VERSION 1.0
|
||||||
|
DESCRIPTION "Example and solution for race conditions"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
|
add_executable(
|
||||||
|
multithread-race-condition driver.cpp
|
||||||
|
)
|
||||||
|
|
||||||
|
target_link_libraries(multithread-race-condition pthread)
|
||||||
64
cpp/multithreading/race-condition/driver.cpp
Normal file
64
cpp/multithreading/race-condition/driver.cpp
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
/*##############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: An example of a race condition problem and solution ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <iostream>
|
||||||
|
#include <mutex>
|
||||||
|
#include <thread>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
void problem() {
|
||||||
|
std::vector<std::thread> threads;
|
||||||
|
const uint8_t thread_count = 5;
|
||||||
|
// With no mutex lock, the final value will vary in the range 1000000-5000000
|
||||||
|
// + Threads will modify x simultaneously, so some iterations will be lost
|
||||||
|
// + x will have same initial value entering this loop on different threads
|
||||||
|
uint32_t x = 0;
|
||||||
|
for (uint8_t i = 0; i < thread_count; i++) {
|
||||||
|
threads.emplace_back([&x](){
|
||||||
|
for (uint32_t i = 0; i < 1000000; i++) {
|
||||||
|
x = x + 1;
|
||||||
|
};
|
||||||
|
});
|
||||||
|
}
|
||||||
|
// Ensure the function doesn't continue until all threads are finished
|
||||||
|
// + There's no issue here, the issue is in how `x` is accessed above
|
||||||
|
for (auto &thread : threads) thread.join();
|
||||||
|
std::cout << x << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create mutex lock to prevent threads from modifying same value simultaneously
|
||||||
|
static std::mutex mtx;
|
||||||
|
void solution() {
|
||||||
|
std::vector<std::thread> threads;
|
||||||
|
const uint8_t thread_count = 5;
|
||||||
|
uint32_t x = 0;
|
||||||
|
for (uint8_t i = 0; i < thread_count; i++) {
|
||||||
|
threads.emplace_back([&x](){
|
||||||
|
// The first thread that arrives here will 'lock' other threads from passing
|
||||||
|
// + Once first thread finishes, the next thread will resume
|
||||||
|
// + This process repeats until all threads finish
|
||||||
|
std::lock_guard<std::mutex> lock(mtx);
|
||||||
|
for (uint32_t i = 0; i < 1000000; i++) {
|
||||||
|
x = x + 1;
|
||||||
|
};
|
||||||
|
});
|
||||||
|
}
|
||||||
|
// Ensure the function doesn't continue until all threads are finished
|
||||||
|
for (auto &thread : threads) thread.join();
|
||||||
|
std::cout << x << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(const int argc, const char * argv[]) {
|
||||||
|
// Result will vary from 1000000-5000000
|
||||||
|
problem();
|
||||||
|
|
||||||
|
// Result will always be 5000000
|
||||||
|
solution();
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "A project for practicing various design patterns in C++"
|
DESCRIPTION "A project for practicing various design patterns in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ project(
|
|||||||
DESCRIPTION "An example of the abstract factory design pattern in C++"
|
DESCRIPTION "An example of the abstract factory design pattern in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
add_compile_options("-Wall")
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "An example of the adapter design pattern in C++"
|
DESCRIPTION "An example of the adapter design pattern in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
add_compile_options("-Wall")
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
#ifndef ADAPTER_HPP
|
#ifndef ADAPTER_HPP
|
||||||
#define ADAPTER_HPP
|
#define ADAPTER_HPP
|
||||||
|
|
||||||
|
#include <ctime>
|
||||||
#include <random>
|
#include <random>
|
||||||
|
|
||||||
// Target implementation to adapt to a new interface
|
// Target implementation to adapt to a new interface
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "An example of the bridge design pattern in C++"
|
DESCRIPTION "An example of the bridge design pattern in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
add_compile_options("-Wall")
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "An example of the factory design pattern in C++"
|
DESCRIPTION "An example of the factory design pattern in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
add_compile_options("-Wall")
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "An example of the state design pattern in C++"
|
DESCRIPTION "An example of the state design pattern in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
add_compile_options("-Wall")
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "An example of the prototype design pattern in C++"
|
DESCRIPTION "An example of the prototype design pattern in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
add_compile_options("-Wall")
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "An example of the singleton design pattern in C++"
|
DESCRIPTION "An example of the singleton design pattern in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
patterns-singleton main.cpp
|
patterns-singleton main.cpp
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "An example of the state design pattern in C++"
|
DESCRIPTION "An example of the state design pattern in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
add_compile_options("-Wall")
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ project(
|
|||||||
DESCRIPTION "An example of the visitor design pattern in C++"
|
DESCRIPTION "An example of the visitor design pattern in C++"
|
||||||
LANGUAGES CXX
|
LANGUAGES CXX
|
||||||
)
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
add_compile_options("-Wall")
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
add_executable(
|
add_executable(
|
||||||
|
|||||||
25
cpp/qt/CMakeLists.txt
Normal file
25
cpp/qt/CMakeLists.txt
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
################################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2022 Shaun Reed, all rights reserved ##
|
||||||
|
## About: A root project for practicing Qt 6 projects in C++ ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
cmake_minimum_required(VERSION 3.15)
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] Klips
|
||||||
|
VERSION 1.0
|
||||||
|
DESCRIPTION "A root project for several small Qt6 practice projects"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
message(STATUS "[Klips] Configuring example: ${PROJECT_NAME}")
|
||||||
|
|
||||||
|
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||||
|
add_compile_options("-Wall")
|
||||||
|
|
||||||
|
add_subdirectory(designer)
|
||||||
|
add_subdirectory(designer-plugin)
|
||||||
|
add_subdirectory(designer-plugin-collection)
|
||||||
|
add_subdirectory(slots)
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user