Merge pull request #15 from ArjArav98/separated_hosts

Separated hosts

Author: ArjArav98

README.md

@@ -18,7 +18,7 @@ A C++17-compatible header that provides useful functions which help with the sol
 ## Usage 
 
 * Simply download the `src/sudoku_suite.h` file and move it to your project's directory.
-* Include the header file, as shown below in the examples, and use the functions you need!
+* Include the required header files, as shown below in the examples, and use the functions you need!
 * **NOTE:** The code is incompatible with pre-C++17 versions. While compiling, you'll have to compile with the `--std=c++17` flag.
     * For example; when using the clang compiler, the compile command would be `c++ --std=c++17 /path/to/file.cpp`
 
@@ -40,7 +40,7 @@ There are **three functions** that Sudoku-Suite provides the developer, along wi
 
 ## Examples
 
-**NOTE:** The following examples are also present in the repository in the `samples/` directory.
+**NOTE:** The following examples are also present in the repository in the `examples/` directory.
 
 * [Solving and validating a Sudoku puzzle](#solving-and-validating-sudoku-puzzle)
 * [Generating a Sudoku puzzle](#generating-a-sudoku-puzzle)
@@ -51,7 +51,8 @@ There are **three functions** that Sudoku-Suite provides the developer, along wi
 #### Solving and validating Sudoku puzzle
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/sudoku_solver.h"
+#include"/path/to/src/sudoku_validator.h"
 
 int main() {
     sudoku::Grid grid({{
@@ -80,7 +81,7 @@ int main() {
 #### Generating a Sudoku puzzle 
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/sudoku_generator.h"
 
 int main() {
     sudoku::Grid grid = sudoku::generate_puzzle();
@@ -93,7 +94,10 @@ int main() {
 #### Initialising and reusing Grid objects 
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/grid.h"
+
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
 
 int main() {
     //================
@@ -162,7 +166,10 @@ File: `sample1.txt`
 
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/grid.h"
+
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
 
 int main() {
     sudoku::Grid grid;
@@ -179,7 +186,10 @@ int main() {
 #### Operations on Grid objects 
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/grid.h"
+
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
 
 int main() {
 

samples/initialising_grid_from_file.cpp examples/initialising_grid_from_file.cppsamples/initialising_grid_from_file.cpp renamed to examples/initialising_grid_from_file.cpp

@@ -1,7 +1,11 @@
-/* A basic example. */
+/* Copyright 2023 Arjun Aravind */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
-#include"../src/sudoku_suite.h"
+#include"../src/sudoku_solver.h"
+
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
 
 int main() {
     sudoku::Grid grid;

samples/initialising_grids.cpp examples/initialising_grids.cppsamples/initialising_grids.cpp renamed to examples/initialising_grids.cpp

@@ -1,7 +1,11 @@
-/* A basic example. */
+/* Copyright 2023 Arjun Aravind */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
-#include"../src/sudoku_suite.h"
+#include"../src/grid.h"
+
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
 
 int main() {
     // Method 1: Use the constructor and pass in a
@@ -18,7 +22,7 @@ int main() {
         {{ 0, 2, 8, 0, 0, 0, 0, 0, 0 }}
     }});
     std::cout << grid << std::endl;
-    
+
     // Method 2: Declare a 2D array and pass it
     // into the set_initial_state() method.
 
@@ -38,7 +42,7 @@ int main() {
 
     // Method 3: Read the initial state of the puzzle
     // from a file.
-    
+
     grid.set_initial_state_from_file("samples/sample1.txt");
     std::cout << grid << std::endl;
 

samples/operations_on_grid_objects.cpp examples/operations_on_grid_objects.cppsamples/operations_on_grid_objects.cpp renamed to examples/operations_on_grid_objects.cpp

@@ -1,10 +1,13 @@
-/* A basic example. */
+/* Copyright 2023 Arjun Aravind */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
-#include"../src/sudoku_suite.h"
+#include"../src/grid.h"
 
-int main() {
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
 
+int main() {
     sudoku::Grid sample_grid_1({{
         {{ 1, 7, 2, 5, 4, 9, 6, 8, 3 }},
         {{ 6, 4, 5, 8, 7, 3, 2, 1, 9 }},
@@ -16,7 +19,7 @@ int main() {
         {{ 7, 3, 1, 6, 8, 2, 5, 9, 4 }},
         {{ 5, 2, 8, 9, 3, 4, 1, 6, 7 }}
     }});
-    
+
     sudoku::Grid sample_grid_2({{
         {{ 1, 7, 2, 5, 4, 9, 6, 8, 3 }},
         {{ 6, 4, 5, 8, 7, 3, 2, 1, 9 }},

samples/sample1.txt examples/sample1.txtsamples/sample1.txt renamed to examples/sample1.txt

@@ -1,7 +1,8 @@
-/* A basic example. */
+/* Copyright 2023 Arjun Aravind */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
-#include"../src/sudoku_suite.h"
+#include"../src/sudoku_generator.h"
 
 int main() {
     sudoku::Grid grid = sudoku::generate_puzzle();

samples/sudoku_generator.cpp examples/sudoku_generator.cppsamples/sudoku_generator.cpp renamed to examples/sudoku_generator.cpp

@@ -1,11 +1,13 @@
-/* A basic example. */
+/* Copyright 2023 Arjun Aravind */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
-#include"../src/sudoku_suite.h"
+#include"../src/sudoku_solver.h"
+#include"../src/sudoku_validator.h"
 
 int main() {
     sudoku::Grid grid({{
-        {{ 0, 0, 0, 0, 0, 0, 6, 8, 0 }}, // The 0s represent blank cells.
+        {{ 0, 0, 0, 0, 0, 0, 6, 8, 0 }},  // The 0s represent blank cells.
         {{ 0, 0, 0, 0, 7, 3, 0, 0, 9 }},
         {{ 3, 0, 9, 0, 0, 0, 0, 4, 5 }},
         {{ 4, 9, 0, 0, 0, 0, 0, 0, 0 }},
@@ -18,9 +20,13 @@ int main() {
 
     sudoku::solve(&grid);
 
-    std::cout << "Solution is valid? --> ";
-    std::cout << sudoku::is_valid_solution(grid) << std::endl;
     std::cout << grid << std::endl;
 
+    if (sudoku::is_valid_solution(grid)) {
+        std::cout << "Solution is valid!\n";
+    } else {
+        std::cout << "DEFCON 4! Something isn't working.\n";
+    }
+
     return 0;
 }

samples/sudoku_solver.cpp examples/sudoku_solver.cppsamples/sudoku_solver.cpp renamed to examples/sudoku_solver.cpp

@@ -0,0 +1,14 @@
+/* Copyright 2023 Arjun Aravind */
+#ifndef SRC_COORD_H_
+#define SRC_COORD_H_
+
+#include<utility>
+
+namespace sudoku {
+
+typedef std::pair<int, int> Coord;
+int GRID_LEN = 9;
+
+}  // namespace sudoku
+
+#endif  // SRC_COORD_H_

src/coord.h

@@ -0,0 +1,45 @@
+/* Copyright 2023 Arjun Aravind */
+#ifndef SRC_COORD_UTILS_H_
+#define SRC_COORD_UTILS_H_
+
+#include<chrono>
+#include<random>
+#include<set>
+#include<utility>
+#include<vector>
+
+#include"../src/coord.h"
+
+namespace sudoku {
+
+Coord get_next_cell_coord(Coord coord) {
+    /* Function which returns the next successive coordinate for a
+     * Sudoku grid, given a current coordinate. */
+    if (coord.second == GRID_LEN-1 && coord.first == GRID_LEN-1)
+        return coord;
+    else if (coord.second == GRID_LEN-1)
+        return std::make_pair(coord.first+1, 0);
+    return std::make_pair(coord.first, coord.second + 1);
+}
+
+std::set<Coord> get_N_random_cell_coords(int n) {
+    std::random_device rd;  // obtain a random number from hardware
+    std::mt19937 gen(rd());  // seed the generator
+    std::uniform_int_distribution<> distr(0, GRID_LEN-1);  // define the range
+
+    std::set<Coord> random_cell_coords;
+
+    while (n > 0) {
+        auto cell_coord = std::make_pair(distr(gen), distr(gen));
+        auto inserted = random_cell_coords.insert(cell_coord);
+
+        if (!inserted.second) continue;  // Element already existed.
+        n--;
+    }
+
+    return random_cell_coords;
+}
+
+}  // namespace sudoku
+
+#endif  // SRC_COORD_UTILS_H_