[feat/fix/docs]: Improvements in the...

...`backtracking` folder, and minor fixes in the `others/iterative_tree_traversals.cpp` and the `math/check_prime.cpp` files.
This commit is contained in:
David Leal
2021-08-05 13:47:05 -05:00
parent 97afa0e3e4
commit 9cc3951dba
10 changed files with 376 additions and 343 deletions

View File

@@ -15,83 +15,93 @@
* @author [Anup Kumar Panwar](https://github.com/AnupKumarPanwar) * @author [Anup Kumar Panwar](https://github.com/AnupKumarPanwar)
* @author [David Leal](https://github.com/Panquesito7) * @author [David Leal](https://github.com/Panquesito7)
*/ */
#include <iostream> #include <iostream> /// for IO operations
#include <array> #include <array> /// for std::array
#include <vector> #include <vector> /// for std::vector
/** /**
* @namespace * @namespace backtracking
* @brief Backtracking algorithms * @brief Backtracking algorithms
*/ */
namespace backtracking { namespace backtracking {
/** A utility function to print solution /**
* @tparam V number of vertices in the graph * @namespace graph_coloring
* @param color array of colors assigned to the nodes * @brief Functions for the [Graph Coloring](https://en.wikipedia.org/wiki/Graph_coloring) algorith,
*/ */
template <size_t V> namespace graph_coloring {
void printSolution(const std::array <int, V>& color) { /**
std::cout << "Following are the assigned colors\n"; * @brief A utility function to print the solution
for (auto &col : color) { * @tparam V number of vertices in the graph
std::cout << col; * @param color array of colors assigned to the nodes
} */
std::cout << "\n"; template <size_t V>
void printSolution(const std::array <int, V>& color) {
std::cout << "Following are the assigned colors\n";
for (auto &col : color) {
std::cout << col;
} }
std::cout << "\n";
}
/** A utility function to check if the current color assignment is safe for /**
* vertex v * @brief Utility function to check if the current color assignment is safe for
* @tparam V number of vertices in the graph * vertex v
* @param v index of graph vertex to check * @tparam V number of vertices in the graph
* @param graph matrix of graph nonnectivity * @param v index of graph vertex to check
* @param color vector of colors assigned to the graph nodes/vertices * @param graph matrix of graph nonnectivity
* @param c color value to check for the node `v` * @param color vector of colors assigned to the graph nodes/vertices
* @returns `true` if the color is safe to be assigned to the node * @param c color value to check for the node `v`
* @returns `false` if the color is not safe to be assigned to the node * @returns `true` if the color is safe to be assigned to the node
*/ * @returns `false` if the color is not safe to be assigned to the node
template <size_t V> */
bool isSafe(int v, const std::array<std::array <int, V>, V>& graph, const std::array <int, V>& color, int c) { template <size_t V>
for (int i = 0; i < V; i++) { bool isSafe(int v, const std::array<std::array <int, V>, V>& graph, const std::array <int, V>& color, int c) {
if (graph[v][i] && c == color[i]) { for (int i = 0; i < V; i++) {
return false; if (graph[v][i] && c == color[i]) {
} return false;
}
return true;
}
/** A recursive utility function to solve m coloring problem
* @tparam V number of vertices in the graph
* @param graph matrix of graph nonnectivity
* @param m number of colors
* @param [in,out] color description // used in,out to notify in documentation
* that this parameter gets modified by the function
* @param v index of graph vertex to check
*/
template <size_t V>
void graphColoring(const std::array<std::array <int, V>, V>& graph, int m, std::array <int, V> color, int v) {
// base case:
// If all vertices are assigned a color then return true
if (v == V) {
backtracking::printSolution<V>(color);
return;
}
// Consider this vertex v and try different colors
for (int c = 1; c <= m; c++) {
// Check if assignment of color c to v is fine
if (backtracking::isSafe<V>(v, graph, color, c)) {
color[v] = c;
// recur to assign colors to rest of the vertices
backtracking::graphColoring<V>(graph, m, color, v + 1);
// If assigning color c doesn't lead to a solution then remove it
color[v] = 0;
}
} }
} }
return true;
}
/**
* @brief Recursive utility function to solve m coloring problem
* @tparam V number of vertices in the graph
* @param graph matrix of graph nonnectivity
* @param m number of colors
* @param [in,out] color description // used in,out to notify in documentation
* that this parameter gets modified by the function
* @param v index of graph vertex to check
*/
template <size_t V>
void graphColoring(const std::array<std::array <int, V>, V>& graph, int m, std::array <int, V> color, int v) {
// base case:
// If all vertices are assigned a color then return true
if (v == V) {
printSolution<V>(color);
return;
}
// Consider this vertex v and try different colors
for (int c = 1; c <= m; c++) {
// Check if assignment of color c to v is fine
if (isSafe<V>(v, graph, color, c)) {
color[v] = c;
// recur to assign colors to rest of the vertices
graphColoring<V>(graph, m, color, v + 1);
// If assigning color c doesn't lead to a solution then remove it
color[v] = 0;
}
}
}
} // namespace graph_coloring
} // namespace backtracking } // namespace backtracking
/** /**
* Main function * @brief Main function
* @returns 0 on exit
*/ */
int main() { int main() {
// Create following graph and test whether it is 3 colorable // Create following graph and test whether it is 3 colorable
@@ -112,6 +122,6 @@ int main() {
int m = 3; // Number of colors int m = 3; // Number of colors
std::array <int, V> color{}; std::array <int, V> color{};
backtracking::graphColoring<V>(graph, m, color, 0); backtracking::graph_coloring::graphColoring<V>(graph, m, color, 0);
return 0; return 0;
} }

View File

@@ -12,70 +12,77 @@
* @author [Nikhil Arora](https://github.com/nikhilarora068) * @author [Nikhil Arora](https://github.com/nikhilarora068)
* @author [David Leal](https://github.com/Panquesito7) * @author [David Leal](https://github.com/Panquesito7)
*/ */
#include <iostream> #include <iostream> /// for IO operations
#include <array> #include <array> /// for std::array
/** /**
* @namespace backtracking * @namespace backtracking
* @brief Backtracking algorithms * @brief Backtracking algorithms
*/ */
namespace backtracking { namespace backtracking {
/** /**
* A utility function to check if i,j are valid indexes for N*N chessboard * @namespace knight_tour
* @tparam V number of vertices in array * @brief Functions for the [Knight's tour](https://en.wikipedia.org/wiki/Knight%27s_tour) algorithm
* @param x current index in rows */
* @param y current index in columns namespace knight_tour {
* @param sol matrix where numbers are saved /**
* @returns `true` if .... * A utility function to check if i,j are valid indexes for N*N chessboard
* @returns `false` if .... * @tparam V number of vertices in array
*/ * @param x current index in rows
template <size_t V> * @param y current index in columns
bool issafe(int x, int y, const std::array <std::array <int, V>, V>& sol) { * @param sol matrix where numbers are saved
return (x < V && x >= 0 && y < V && y >= 0 && sol[x][y] == -1); * @returns `true` if ....
} * @returns `false` if ....
*/
/** template <size_t V>
* Knight's tour algorithm bool issafe(int x, int y, const std::array <std::array <int, V>, V>& sol) {
* @tparam V number of vertices in array return (x < V && x >= 0 && y < V && y >= 0 && sol[x][y] == -1);
* @param x current index in rows }
* @param y current index in columns
* @param mov movement to be done
* @param sol matrix where numbers are saved
* @param xmov next move of knight (x coordinate)
* @param ymov next move of knight (y coordinate)
* @returns `true` if solution exists
* @returns `false` if solution does not exist
*/
template <size_t V>
bool solve(int x, int y, int mov, std::array <std::array <int, V>, V> &sol,
const std::array <int, V> &xmov, std::array <int, V> &ymov) {
int k, xnext, ynext;
if (mov == V * V) {
return true;
}
for (k = 0; k < V; k++) {
xnext = x + xmov[k];
ynext = y + ymov[k];
if (backtracking::issafe<V>(xnext, ynext, sol)) {
sol[xnext][ynext] = mov;
if (backtracking::solve<V>(xnext, ynext, mov + 1, sol, xmov, ymov) == true) {
return true;
}
else {
sol[xnext][ynext] = -1;
}
}
}
return false;
}
} // namespace backtracking
/** /**
* Main function * Knight's tour algorithm
* @tparam V number of vertices in array
* @param x current index in rows
* @param y current index in columns
* @param mov movement to be done
* @param sol matrix where numbers are saved
* @param xmov next move of knight (x coordinate)
* @param ymov next move of knight (y coordinate)
* @returns `true` if solution exists
* @returns `false` if solution does not exist
*/
template <size_t V>
bool solve(int x, int y, int mov, std::array <std::array <int, V>, V> &sol,
const std::array <int, V> &xmov, std::array <int, V> &ymov) {
int k = 0, xnext = 0, ynext = 0;
if (mov == V * V) {
return true;
}
for (k = 0; k < V; k++) {
xnext = x + xmov[k];
ynext = y + ymov[k];
if (issafe<V>(xnext, ynext, sol)) {
sol[xnext][ynext] = mov;
if (solve<V>(xnext, ynext, mov + 1, sol, xmov, ymov) == true) {
return true;
}
else {
sol[xnext][ynext] = -1;
}
}
}
return false;
}
} // namespace knight_tour
} // namespace backtracking
/**
* @brief Main function
* @returns 0 on exit
*/ */
int main() { int main() {
const int n = 8; const int n = 8;
@@ -91,7 +98,7 @@ int main() {
sol[0][0] = 0; sol[0][0] = 0;
bool flag = backtracking::solve<n>(0, 0, 1, sol, xmov, ymov); bool flag = backtracking::knight_tour::solve<n>(0, 0, 1, sol, xmov, ymov);
if (flag == false) { if (flag == false) {
std::cout << "Error: Solution does not exist\n"; std::cout << "Error: Solution does not exist\n";
} }

View File

@@ -15,10 +15,10 @@
* @author [Gleison Batista](https://github.com/gleisonbs) * @author [Gleison Batista](https://github.com/gleisonbs)
* @author [David Leal](https://github.com/Panquesito7) * @author [David Leal](https://github.com/Panquesito7)
*/ */
#include <algorithm> #include <algorithm> /// for std::max, std::min
#include <cmath> #include <cmath> /// for log2
#include <iostream> #include <iostream> /// for IO operations
#include <array> #include <array> /// for std::array
/** /**
* @namespace backtracking * @namespace backtracking
@@ -26,13 +26,13 @@
*/ */
namespace backtracking { namespace backtracking {
/** /**
* Check which number is the maximum/minimum in the array * @brief Check which is the maximum/minimum number in the array
* @param depth current depth in game tree * @param depth current depth in game tree
* @param node_index current index in array * @param node_index current index in array
* @param is_max if current index is the longest number * @param is_max if current index is the longest number
* @param scores saved numbers in array * @param scores saved numbers in array
* @param height maximum height for game tree * @param height maximum height for game tree
* @return maximum or minimum number * @returns the maximum or minimum number
*/ */
template <size_t T> template <size_t T>
int minimax(int depth, int node_index, bool is_max, int minimax(int depth, int node_index, bool is_max,
@@ -46,10 +46,11 @@ int minimax(int depth, int node_index, bool is_max,
return is_max ? std::max(v1, v2) : std::min(v1, v2); return is_max ? std::max(v1, v2) : std::min(v1, v2);
} }
} // namespace backtracking } // namespace backtracking
/** /**
* Main function * @brief Main function
* @returns 0 on exit
*/ */
int main() { int main() {
std::array<int, 8> scores = {90, 23, 6, 33, 21, 65, 123, 34423}; std::array<int, 8> scores = {90, 23, 6, 33, 21, 65, 123, 34423};

View File

@@ -23,97 +23,98 @@
* @brief Backtracking algorithms * @brief Backtracking algorithms
*/ */
namespace backtracking { namespace backtracking {
/** /**
* @namespace n_queens * @namespace n_queens
* @brief Functions for [Eight Queens](https://en.wikipedia.org/wiki/Eight_queens_puzzle) puzzle. * @brief Functions for [Eight Queens](https://en.wikipedia.org/wiki/Eight_queens_puzzle) puzzle.
*/ */
namespace n_queens { namespace n_queens {
/** /**
* Utility function to print matrix * Utility function to print matrix
* @tparam n number of matrix size * @tparam n number of matrix size
* @param board matrix where numbers are saved * @param board matrix where numbers are saved
*/ */
template <size_t n> template <size_t n>
void printSolution(const std::array<std::array<int, n>, n> &board) { void printSolution(const std::array<std::array<int, n>, n> &board) {
std::cout << "\n";
for (int i = 0; i < n; i++) {
for (int j = 0; j < n; j++) {
std::cout << "" << board[i][j] << " ";
}
std::cout << "\n"; std::cout << "\n";
for (int i = 0; i < n; i++) {
for (int j = 0; j < n; j++) {
std::cout << "" << board[i][j] << " ";
}
std::cout << "\n";
}
} }
}
/** /**
* Check if a queen can be placed on matrix * Check if a queen can be placed on matrix
* @tparam n number of matrix size * @tparam n number of matrix size
* @param board matrix where numbers are saved * @param board matrix where numbers are saved
* @param row current index in rows * @param row current index in rows
* @param col current index in columns * @param col current index in columns
* @returns `true` if queen can be placed on matrix * @returns `true` if queen can be placed on matrix
* @returns `false` if queen can't be placed on matrix * @returns `false` if queen can't be placed on matrix
*/ */
template <size_t n> template <size_t n>
bool isSafe(const std::array<std::array<int, n>, n> &board, const int &row, bool isSafe(const std::array<std::array<int, n>, n> &board, const int &row,
const int &col) { const int &col) {
int i = 0, j = 0; int i = 0, j = 0;
// Check this row on left side // Check this row on left side
for (i = 0; i < col; i++) { for (i = 0; i < col; i++) {
if (board[row][i]) { if (board[row][i]) {
return false; return false;
}
}
// Check upper diagonal on left side
for (i = row, j = col; i >= 0 && j >= 0; i--, j--) {
if (board[i][j]) {
return false;
}
}
// Check lower diagonal on left side
for (i = row, j = col; j >= 0 && i < n; i++, j--) {
if (board[i][j]) {
return false;
}
}
return true;
} }
}
/** // Check upper diagonal on left side
* Solve n queens problem for (i = row, j = col; i >= 0 && j >= 0; i--, j--) {
* @tparam n number of matrix size if (board[i][j]) {
* @param board matrix where numbers are saved return false;
* @param col current index in columns
*/
template <size_t n>
void solveNQ(std::array<std::array<int, n>, n> board, const int &col) {
if (col >= n) {
printSolution<n>(board);
return;
}
// Consider this column and try placing
// this queen in all rows one by one
for (int i = 0; i < n; i++) {
// Check if queen can be placed
// on board[i][col]
if (isSafe<n>(board, i, col)) {
// Place this queen in matrix
board[i][col] = 1;
// Recursive to place rest of the queens
solveNQ<n>(board, col + 1);
board[i][col] = 0; // backtrack
}
}
} }
} // namespace n_queens }
// Check lower diagonal on left side
for (i = row, j = col; j >= 0 && i < n; i++, j--) {
if (board[i][j]) {
return false;
}
}
return true;
}
/**
* Solve n queens problem
* @tparam n number of matrix size
* @param board matrix where numbers are saved
* @param col current index in columns
*/
template <size_t n>
void solveNQ(std::array<std::array<int, n>, n> board, const int &col) {
if (col >= n) {
printSolution<n>(board);
return;
}
// Consider this column and try placing
// this queen in all rows one by one
for (int i = 0; i < n; i++) {
// Check if queen can be placed
// on board[i][col]
if (isSafe<n>(board, i, col)) {
// Place this queen in matrix
board[i][col] = 1;
// Recursive to place rest of the queens
solveNQ<n>(board, col + 1);
board[i][col] = 0; // backtrack
}
}
}
} // namespace n_queens
} // namespace backtracking } // namespace backtracking
/** /**
* Main function * @brief Main function
* @returns 0 on exit
*/ */
int main() { int main() {
const int n = 4; const int n = 4;

View File

@@ -111,7 +111,7 @@ int main() {
std::array<std::array<int, n>, n> board{}; std::array<std::array<int, n>, n> board{};
if (n % 2 == 0) { if (n % 2 == 0) {
for (int i = 0; i <= n / 2 - 1; i++) { // 😎 for (int i = 0; i <= n / 2 - 1; i++) {
if (backtracking::n_queens_optimized::CanIMove(board, i, 0)) { if (backtracking::n_queens_optimized::CanIMove(board, i, 0)) {
board[i][0] = 1; board[i][0] = 1;
backtracking::n_queens_optimized::NQueenSol(board, 1); backtracking::n_queens_optimized::NQueenSol(board, 1);
@@ -119,7 +119,7 @@ int main() {
} }
} }
} else { } else {
for (int i = 0; i <= n / 2; i++) { // 😏 for (int i = 0; i <= n / 2; i++) {
if (backtracking::n_queens_optimized::CanIMove(board, i, 0)) { if (backtracking::n_queens_optimized::CanIMove(board, i, 0)) {
board[i][0] = 1; board[i][0] = 1;
backtracking::n_queens_optimized::NQueenSol(board, 1); backtracking::n_queens_optimized::NQueenSol(board, 1);

View File

@@ -7,8 +7,8 @@
* @author [David Leal](https://github.com/Panquesito7) * @author [David Leal](https://github.com/Panquesito7)
* *
*/ */
#include <iostream> #include <iostream> /// for IO operations
#include <array> #include <array> /// for std::array
/** /**
* @namespace backtracking * @namespace backtracking
@@ -17,12 +17,12 @@
namespace backtracking { namespace backtracking {
/** /**
* @namespace n_queens_all_solutions * @namespace n_queens_all_solutions
* @brief Functions for [Eight * @brief Functions for the [Eight
* Queens](https://en.wikipedia.org/wiki/Eight_queens_puzzle) puzzle with all solutions. * Queens](https://en.wikipedia.org/wiki/Eight_queens_puzzle) puzzle with all solutions.
*/ */
namespace n_queens_all_solutions { namespace n_queens_all_solutions {
/** /**
* Utility function to print matrix * @brief Utility function to print matrix
* @tparam n number of matrix size * @tparam n number of matrix size
* @param board matrix where numbers are saved * @param board matrix where numbers are saved
*/ */
@@ -38,7 +38,7 @@ void PrintSol(const std::array<std::array<int, n>, n>& board) {
} }
/** /**
* Check if a queen can be placed on matrix * @brief Check if a queen can be placed on the matrix
* @tparam n number of matrix size * @tparam n number of matrix size
* @param board matrix where numbers are saved * @param board matrix where numbers are saved
* @param row current index in rows * @param row current index in rows
@@ -70,7 +70,7 @@ bool CanIMove(const std::array<std::array<int, n>, n>& board, int row, int col)
} }
/** /**
* Solve n queens problem * @brief Main function to solve the N Queens problem
* @tparam n number of matrix size * @tparam n number of matrix size
* @param board matrix where numbers are saved * @param board matrix where numbers are saved
* @param col current index in columns * @param col current index in columns
@@ -89,11 +89,12 @@ void NQueenSol(std::array<std::array<int, n>, n> board, int col) {
} }
} }
} }
} // namespace n_queens_all_solutions } // namespace n_queens_all_solutions
} // namespace backtracking } // namespace backtracking
/** /**
* Main function * @brief Main function
* @returns 0 on exit
*/ */
int main() { int main() {
const int n = 4; const int n = 4;

View File

@@ -16,9 +16,9 @@
* @author [David Leal](https://github.com/Panquesito7) * @author [David Leal](https://github.com/Panquesito7)
*/ */
#include <array> #include <array> /// for std::array
#include <iostream> #include <iostream> /// for IO operations
#include <cassert> #include <cassert> /// for assert
/** /**
* @namespace backtracking * @namespace backtracking
@@ -39,7 +39,8 @@ namespace rat_maze {
* @param currposcol current position in columns * @param currposcol current position in columns
* @param maze matrix where numbers are saved * @param maze matrix where numbers are saved
* @param soln matrix to problem solution * @param soln matrix to problem solution
* @returns 0 on end * @returns `true` if there exists a solution to move one step ahead in a column or in a row
* @returns `false` for the backtracking part
*/ */
template <size_t size> template <size_t size>
bool solveMaze(int currposrow, int currposcol, bool solveMaze(int currposrow, int currposcol,
@@ -78,7 +79,7 @@ bool solveMaze(int currposrow, int currposcol,
} // namespace backtracking } // namespace backtracking
/** /**
* @brief Test implementations * @brief Self-test implementations
* @returns void * @returns void
*/ */
static void test(){ static void test(){
@@ -96,8 +97,8 @@ static void test(){
} }
} }
int currposrow = 0; // Current position in rows int currposrow = 0; // Current position in the rows
int currposcol = 0; // Current position in columns int currposcol = 0; // Current position in the columns
assert(backtracking::rat_maze::solveMaze<size>(currposrow, currposcol, maze, assert(backtracking::rat_maze::solveMaze<size>(currposrow, currposcol, maze,
soln) == 1); soln) == 1);
@@ -108,6 +109,6 @@ static void test(){
* @returns 0 on exit * @returns 0 on exit
*/ */
int main() { int main() {
test(); // run the tests test(); // run self-test implementations
return 0; return 0;
} }

View File

@@ -13,126 +13,133 @@
* @author [DarthCoder3200](https://github.com/DarthCoder3200) * @author [DarthCoder3200](https://github.com/DarthCoder3200)
* @author [David Leal](https://github.com/Panquesito7) * @author [David Leal](https://github.com/Panquesito7)
*/ */
#include <iostream> #include <iostream> /// for IO operations
#include <array> #include <array> /// for assert
/** /**
* @namespace backtracking * @namespace backtracking
* @brief Backtracking algorithms * @brief Backtracking algorithms
*/ */
namespace backtracking { namespace backtracking {
/** /**
* Checks if it's possible to place a number 'no' * @namespace sudoku_solver
* @tparam V number of vertices in the array * @brief Functions for the [Sudoku Solver](https://en.wikipedia.org/wiki/Sudoku) implementation
* @param mat matrix where numbers are saved */
* @param i current index in rows namespace sudoku_solver {
* @param j current index in columns /**
* @param no number to be added in matrix * @brief Check if it's possible to place a number (`no` parameter)
* @param n number of times loop will run * @tparam V number of vertices in the array
* @returns `true` if 'mat' is different from 'no' * @param mat matrix where numbers are saved
* @returns `false` if 'mat' equals to 'no' * @param i current index in rows
*/ * @param j current index in columns
template <size_t V> * @param no number to be added in matrix
bool isPossible(const std::array <std::array <int, V>, V> &mat, int i, int j, int no, int n) { * @param n number of times loop will run
/// 'no' shouldn't be present in either row i or column j * @returns `true` if 'mat' is different from 'no'
for (int x = 0; x < n; x++) { * @returns `false` if 'mat' equals to 'no'
if (mat[x][j] == no || mat[i][x] == no) { */
template <size_t V>
bool isPossible(const std::array <std::array <int, V>, V> &mat, int i, int j, int no, int n) {
/// `no` shouldn't be present in either row i or column j
for (int x = 0; x < n; x++) {
if (mat[x][j] == no || mat[i][x] == no) {
return false;
}
}
/// `no` shouldn't be present in the 3*3 subgrid
int sx = (i / 3) * 3;
int sy = (j / 3) * 3;
for (int x = sx; x < sx + 3; x++) {
for (int y = sy; y < sy + 3; y++) {
if (mat[x][y] == no) {
return false; return false;
} }
} }
}
/// 'no' shouldn't be present in the 3*3 subgrid return true;
int sx = (i / 3) * 3; }
int sy = (j / 3) * 3; /**
* @brief Utility function to print the matrix
for (int x = sx; x < sx + 3; x++) { * @tparam V number of vertices in array
for (int y = sy; y < sy + 3; y++) { * @param mat matrix where numbers are saved
if (mat[x][y] == no) { * @param starting_mat copy of mat, required by printMat for highlighting the differences
return false; * @param n number of times loop will run
} * @return void
*/
template <size_t V>
void printMat(const std::array <std::array <int, V>, V> &mat, const std::array <std::array <int, V>, V> &starting_mat, int n) {
for (int i = 0; i < n; i++) {
for (int j = 0; j < n; j++) {
if (starting_mat[i][j] != mat[i][j]) {
std::cout << "\033[93m" << mat[i][j] << "\033[0m" << " ";
} else {
std::cout << mat[i][j] << " ";
}
if ((j + 1) % 3 == 0) {
std::cout << '\t';
} }
} }
if ((i + 1) % 3 == 0) {
return true;
}
/**
* Utility function to print matrix
* @tparam V number of vertices in array
* @param mat matrix where numbers are saved
* @param starting_mat copy of mat, required by printMat for highlighting the differences
* @param n number of times loop will run
* @return void
*/
template <size_t V>
void printMat(const std::array <std::array <int, V>, V> &mat, const std::array <std::array <int, V>, V> &starting_mat, int n) {
for (int i = 0; i < n; i++) {
for (int j = 0; j < n; j++) {
if (starting_mat[i][j] != mat[i][j]) {
std::cout << "\033[93m" << mat[i][j] << "\033[0m" << " ";
} else {
std::cout << mat[i][j] << " ";
}
if ((j + 1) % 3 == 0) {
std::cout << '\t';
}
}
if ((i + 1) % 3 == 0) {
std::cout << std::endl;
}
std::cout << std::endl; std::cout << std::endl;
} }
std::cout << std::endl;
} }
}
/**
* Sudoku algorithm
* @tparam V number of vertices in array
* @param mat matrix where numbers are saved
* @param starting_mat copy of mat, required by printMat for highlighting the differences
* @param i current index in rows
* @param j current index in columns
* @returns `true` if 'no' was placed
* @returns `false` if 'no' was not placed
*/
template <size_t V>
bool solveSudoku(std::array <std::array <int, V>, V> &mat, const std::array <std::array <int, V>, V> &starting_mat, int i, int j) {
/// Base Case
if (i == 9) {
/// Solved for 9 rows already
backtracking::printMat<V>(mat, starting_mat, 9);
return true;
}
/// Crossed the last Cell in the row
if (j == 9) {
return backtracking::solveSudoku<V>(mat, starting_mat, i + 1, 0);
}
/// Blue Cell - Skip
if (mat[i][j] != 0) {
return backtracking::solveSudoku<V>(mat, starting_mat, i, j + 1);
}
/// White Cell
/// Try to place every possible no
for (int no = 1; no <= 9; no++) {
if (backtracking::isPossible<V>(mat, i, j, no, 9)) {
/// Place the 'no' - assuming a solution will exist
mat[i][j] = no;
bool solution_found = backtracking::solveSudoku<V>(mat, starting_mat, i, j + 1);
if (solution_found) {
return true;
}
/// Couldn't find a solution
/// loop will place the next no.
}
}
/// Solution couldn't be found for any of the numbers provided
mat[i][j] = 0;
return false;
}
} // namespace backtracking
/** /**
* Main function * @brief Main function to implement the Sudoku algorithm
* @tparam V number of vertices in array
* @param mat matrix where numbers are saved
* @param starting_mat copy of mat, required by printMat for highlighting the differences
* @param i current index in rows
* @param j current index in columns
* @returns `true` if 'no' was placed
* @returns `false` if 'no' was not placed
*/
template <size_t V>
bool solveSudoku(std::array <std::array <int, V>, V> &mat, const std::array <std::array <int, V>, V> &starting_mat, int i, int j) {
/// Base Case
if (i == 9) {
/// Solved for 9 rows already
printMat<V>(mat, starting_mat, 9);
return true;
}
/// Crossed the last Cell in the row
if (j == 9) {
return solveSudoku<V>(mat, starting_mat, i + 1, 0);
}
/// Blue Cell - Skip
if (mat[i][j] != 0) {
return solveSudoku<V>(mat, starting_mat, i, j + 1);
}
/// White Cell
/// Try to place every possible no
for (int no = 1; no <= 9; no++) {
if (isPossible<V>(mat, i, j, no, 9)) {
/// Place the 'no' - assuming a solution will exist
mat[i][j] = no;
bool solution_found = solveSudoku<V>(mat, starting_mat, i, j + 1);
if (solution_found) {
return true;
}
/// Couldn't find a solution
/// loop will place the next `no`.
}
}
/// Solution couldn't be found for any of the numbers provided
mat[i][j] = 0;
return false;
}
} // namespace sudoku_solver
} // namespace backtracking
/**
* @brief Main function
* @returns 0 on exit
*/ */
int main() { int main() {
const int V = 9; const int V = 9;
@@ -148,10 +155,10 @@ int main() {
std::array <int, V> {0, 0, 0, 0, 8, 0, 0, 7, 9} std::array <int, V> {0, 0, 0, 0, 8, 0, 0, 7, 9}
}; };
backtracking::printMat<V>(mat, mat, 9); backtracking::sudoku_solver::printMat<V>(mat, mat, 9);
std::cout << "Solution " << std::endl; std::cout << "Solution " << std::endl;
std::array <std::array <int, V>, V> starting_mat = mat; std::array <std::array <int, V>, V> starting_mat = mat;
backtracking::solveSudoku<V>(mat, starting_mat, 0, 0); backtracking::sudoku_solver::solveSudoku<V>(mat, starting_mat, 0, 0);
return 0; return 0;
} }

View File

@@ -22,11 +22,11 @@ template <typename T>
bool is_prime(T num) { bool is_prime(T num) {
bool result = true; bool result = true;
if (num <= 1) { if (num <= 1) {
return 0; return false;
} else if (num == 2) { } else if (num == 2) {
return 1; return true;
} else if ((num & 1) == 0) { } else if ((num & 1) == 0) {
return 0; return false;
} }
if (num >= 3) { if (num >= 3) {
for (T i = 3; (i * i) < (num); i = (i + 2)) { for (T i = 3; (i * i) < (num); i = (i + 2)) {

View File

@@ -204,8 +204,9 @@ static void test2(others::iterative_tree_traversals::BinaryTree binaryTree, othe
result = binaryTree.postOrderIterative(root); result = binaryTree.postOrderIterative(root);
// Self-testing the result using `assert` // Self-testing the result using `assert`
for(int i = 0; i < result.size(); i++) for(int i = 0; i < result.size(); i++) {
assert(actual_result[i] == result[i]); assert(actual_result[i] == result[i]);
}
// Printing the result storing postorder. // Printing the result storing postorder.
std::cout<< "\nPostOrder Traversal Is : "<< std::endl; std::cout<< "\nPostOrder Traversal Is : "<< std::endl;
@@ -228,8 +229,9 @@ static void test3(others::iterative_tree_traversals::BinaryTree binaryTree, othe
result = binaryTree.inOrderIterative(root); result = binaryTree.inOrderIterative(root);
// Self-testing the result using `assert` // Self-testing the result using `assert`
for(int i = 0; i < result.size(); i++) for(int i = 0; i < result.size(); i++) {
assert(actual_result[i] == result[i]); assert(actual_result[i] == result[i]);
}
// Printing the result storing inorder. // Printing the result storing inorder.
std::cout<< "\nInOrder Traversal Is : "<< std::endl; std::cout<< "\nInOrder Traversal Is : "<< std::endl;
@@ -252,8 +254,9 @@ static void test4(others::iterative_tree_traversals::BinaryTree binaryTree, othe
result = binaryTree.preOrderIterative(root); result = binaryTree.preOrderIterative(root);
// Self-testing the result using `assert` // Self-testing the result using `assert`
for(int i = 0; i < result.size(); i++) for(int i = 0; i < result.size(); i++) {
assert(actual_result[i] == result[i]); assert(actual_result[i] == result[i]);
}
// Printing the result storing preorder. // Printing the result storing preorder.
std::cout<< "\nPreOrder Traversal Is : "<< std::endl; std::cout<< "\nPreOrder Traversal Is : "<< std::endl;
@@ -276,8 +279,9 @@ static void test5(others::iterative_tree_traversals::BinaryTree binaryTree, othe
result = binaryTree.postOrderIterative(root); result = binaryTree.postOrderIterative(root);
// Self-testing the result using `assert` // Self-testing the result using `assert`
for(int i = 0; i < result.size(); i++) for(int i = 0; i < result.size(); i++) {
assert(actual_result[i] == result[i]); assert(actual_result[i] == result[i]);
}
// Printing the result storing postorder. // Printing the result storing postorder.
std::cout<< "\nPostOrder Traversal Is : "<< std::endl; std::cout<< "\nPostOrder Traversal Is : "<< std::endl;
@@ -300,8 +304,9 @@ static void test6(others::iterative_tree_traversals::BinaryTree binaryTree, othe
result = binaryTree.inOrderIterative(root); result = binaryTree.inOrderIterative(root);
// Self-testing the result using `assert` // Self-testing the result using `assert`
for(int i = 0; i < result.size(); i++) for(int i = 0; i < result.size(); i++) {
assert(actual_result[i] == result[i]); assert(actual_result[i] == result[i]);
}
// Printing the result storing inorder. // Printing the result storing inorder.
std::cout<< "\nInOrder Traversal Is : "<< std::endl; std::cout<< "\nInOrder Traversal Is : "<< std::endl;