Docker build

.github/workflows/docker-build.yml

@@ -0,0 +1,12 @@
+name: Create docker images
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: jwg4/docker-python-poetry@v1a0
+    - name: Build the Docker image
+      run: docker build --tag exact_cover/debug:$(date +%s) .

.github/workflows/python-validate.yml

@@ -25,6 +25,6 @@ jobs:
     - name: Lint with flake8
       run: poetry run flake8
     - name: Lint with black
-      run: poetry run black --check exact_cover/ tests/ build.py run_tests.py
+      run: poetry run black --check exact_cover/ tests/ tools/ build.py
     - name: Check examples in README
       run: poetry run doctest

Dockerfile

@@ -0,0 +1,13 @@
+FROM etiennenapoleone/docker-python-poetry:3.7-rc
+
+WORKDIR /tmp/working
+
+COPY pyproject.toml .
+COPY src .
+COPY data/debug_data .
+COPY tools/__init__.py .
+COPY tools/debug.py .
+
+RUN poetry install --no-dev
+
+RUN poetry debug

Makefile

@@ -43,7 +43,6 @@ CFLAGS += -O0 -DDEBUG_LEVEL=0
 c_tests: note \
 	note_quad_linked_list run_test_quad_linked_list \
 	note_sparse_matrix run_test_sparse_matrix \
-	note_dlx run_test_dlx \
 	run_munit
 
 tests: c_tests py_tests
@@ -104,15 +103,22 @@ run_test_m_sparse_matrix: $(TEST_DIR)/test_m_sparse_matrix
 $(TEST_DIR)/test_m_dlx: $(OBJ_DIR)/quad_linked_list.o $(OBJ_DIR)/sparse_matrix.o $(OBJ_DIR)/dlx.o $(OBJ_DIR)/munit.o $(TEST_DIR)/test_m_dlx.c
 	$(CC) $(CFLAGS) $(DEBUG_CFLAGS) -o $@ $^
 
+$(TEST_DIR)/test_debug_algo: $(OBJ_DIR)/quad_linked_list.o $(OBJ_DIR)/sparse_matrix.o $(OBJ_DIR)/dlx.o $(OBJ_DIR)/munit.o $(TEST_DIR)/test_debug_algo.c
+	$(CC) $(CFLAGS) $(DEBUG_CFLAGS) -o $@ $^
+
 run_test_m_dlx: $(TEST_DIR)/test_m_dlx
 	$^
 
 run_munit_test_dlx: $(TEST_DIR)/test_dlx
 	$^
 
+run_test_debug_algo: $(TEST_DIR)/test_debug_algo
+	$^
+
 run_munit: run_test_m_sparse_matrix \
 	run_test_m_dlx \
-	run_munit_test_dlx
+	run_munit_test_dlx \
+        run_test_debug_algo
 
 #-----------------------------------------------------------------------------------------
 
@@ -126,17 +132,10 @@ $(OBJ_DIR)/sparse_matrix.o: $(SRC_DIR)/sparse_matrix.c
 run_test_sparse_matrix: $(TEST_DIR)/test_sparse_matrix
 	$^
 
-#-----------------------------------------------------------------------------------------
-
-$(TEST_DIR)/test_dlx: $(OBJ_DIR)/quad_linked_list.o $(OBJ_DIR)/sparse_matrix.o $(OBJ_DIR)/dlx.o $(OBJ_DIR)/munit.o $(TEST_DIR)/test_dlx.c
-	$(CC) $(CFLAGS) $(DEBUG_CFLAGS) -o $@ $^
-
 $(OBJ_DIR)/dlx.o: $(SRC_DIR)/dlx.c
+	mkdir -pv $(OBJ_DIR)
 	$(CC) $(CFLAGS) $(DEBUG_CFLAGS) -o $@ -c $^
 
-run_test_dlx: $(TEST_DIR)/test_dlx
-	$^
-
 #-----------------------------------------------------------------------------------------
 
 exact_cover:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "exact_cover"
-version = "0.6.1"
+version = "0.6.2-alpha.0"
 description = "Solve exact cover problems"
 readme = "README.md"
 authors = ["Moy Easwaran"]
@@ -28,11 +28,12 @@ black = "^21.4b2"
 script = "build.py"
 
 [tool.poetry.scripts]
-test = 'run_tests:test'
-doctest = 'run_tests:run_doctest'
+test = 'tools.run_tests:test'
+doctest = 'tools.run_tests:run_doctest'
+debug = 'tools.debug:run_debug'
 
 [build-system]
-requires = ["setuptools", "numpy>=1.19.4,<2.0", "poetry-core>=1.0.0"]
+requires = ["setuptools>=51.1.2,<52.0", "numpy>=1.19.4,<2.0", "poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.black]

src/dlx.c

@@ -14,7 +14,7 @@
  */
 
 
-int search(list sparse_matrix, int k, int max, int *solution) {
+int search(list sparse_matrix, int k, int max, int *solution, int is_debug) {
     list col, row, next;
     int result = 0;
 
@@ -27,12 +27,19 @@ int search(list sparse_matrix, int k, int max, int *solution) {
     if (get_data(col)->data == 0) return 0;
 
     // Main algorithm:
+    if (is_debug != 0){
+        for (int i = 0; i < k; i++){
+            printf("%d|", solution[i]);
+        }
+    }
+    printf("\n");
+
     cover_column(col);
     for (row = col; (row = get_down(row)) != col; ) {
         solution[k] = get_data(row)->data;  // save the row number
         for (next = row; (next = get_right(next)) != row; )
             cover_column(get_data(next)->list_data);
-        result = search(sparse_matrix, k+1, max, solution);
+        result = search(sparse_matrix, k+1, max, solution, is_debug);
         // If result > 0 we're done, but we should still clean up.
         for (next = row; (next = get_left(next)) != row; )
             uncover_column(get_data(next)->list_data);
@@ -42,12 +49,12 @@ int search(list sparse_matrix, int k, int max, int *solution) {
     return result;
 }
 
-int dlx_get_exact_cover(int rows, int cols, int matrix[], int *solution) {
+int dlx_get_exact_cover(int rows, int cols, int matrix[], int *solution, int is_debug) {
     list sparse_matrix;
     int solution_length;
 
     sparse_matrix = create_sparse(rows, cols, matrix);
-    solution_length = search(sparse_matrix, 0, rows, solution);
+    solution_length = search(sparse_matrix, 0, rows, solution, is_debug);
     destroy_entire_grid(sparse_matrix);
 
     while (rows > solution_length) {

src/dlx.h

@@ -4,8 +4,8 @@
 #include "quad_linked_list.h"
 #include "sparse_matrix.h"
 
-int search(list, int, int, int *);
-int dlx_get_exact_cover(int, int, int [], int*);
+int search(list, int, int, int *, int);
+int dlx_get_exact_cover(int, int, int [], int*, int);
 
 #endif
 

src/exact_cover.c

@@ -35,10 +35,10 @@ static PyObject* get_exact_cover(PyObject* self, PyObject* args)
     PyArrayObject *in_array;
     PyObject      *out_array;
     npy_intp      *dims;
-    int           *in_array_data, rows, cols, result;
+    int           *in_array_data, rows, cols, result, is_debug;
 
     /*  Parse single numpy array argument */
-    if (!PyArg_ParseTuple(args, "O!", &PyArray_Type, &in_array)) return NULL;
+    if (!PyArg_ParseTuple(args, "O!|p", &PyArray_Type, &in_array, &is_debug)) return NULL;
 
     /*  Construct the output array, like the input array */
     out_array = PyArray_NewLikeArray(in_array, NPY_ANYORDER, NULL, 0);
@@ -54,7 +54,7 @@ static PyObject* get_exact_cover(PyObject* self, PyObject* args)
 
     /*  Calculate the exact cover. */
     int nd = 1, *solution = malloc(rows * sizeof(*solution));
-    result = dlx_get_exact_cover(rows, cols, in_array_data, solution);
+    result = dlx_get_exact_cover(rows, cols, in_array_data, solution, is_debug);
 
     dims = malloc(nd * sizeof(*dims));
     dims[0] = result;

tests/.gitignore

@@ -3,3 +3,4 @@ test_quad_linked_list
 test_sparse_matrix
 test_m_dlx
 test_m_sparse_matrix
+test_debug_algo