NUCS 2.0.0__tar.gz → 2.2.0__tar.gz

nucs-2.2.0/NUCS.egg-info/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.1
+Name: NUCS
+Version: 2.2.0
+Summary: A Numpy and Numba based Python library for solving Constraint Satisfaction Problems over finite domains
+Author-email: Yan Georget <yan.georget@gmail.com>
+Project-URL: Homepage, https://github.com/yangeorget/nucs
+Project-URL: Issues, https://github.com/yangeorget/nucs/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numba==0.60.0
+Requires-Dist: numpy==2.0.1
+
+![NucS logo](https://github.com/yangeorget/nucs/blob/main/assets/nucs.png?raw=true)
+
+
+![pypi version](https://img.shields.io/pypi/v/nucs?color=blue&label=pypi%20version&logo=pypi&logoColor=white)
+![pypi downloads](https://img.shields.io/pypi/dm/NUCS)
+
+![numba version](https://img.shields.io/badge/numba-v0.60-blue)
+![numpy version](https://img.shields.io/badge/numpy-v2.0-blue)
+
+![tests](https://github.com/yangeorget/nucs/actions/workflows/test.yml/badge.svg)
+![doc](https://img.shields.io/readthedocs/nucs)
+![license](https://img.shields.io/github/license/yangeorget/nucs)
+
+## TLDR
+NuCS is a Python library for solving Constraint Satisfaction and Optimization Problems.
+Because it is 100% written in Python, 
+NuCS is easy to install and allows to model complex problems in a few lines of code.
+The NuCS solver is also very fast because it is powered by [Numpy](https://numpy.org/) and [Numba](https://numba.pydata.org/).
+
+## Installation
+```bash
+pip install nucs
+```
+## Documentation
+Check out [NUCS documentation](https://nucs.readthedocs.io/).
+
+## With NuCS, in a few seconds you can ...
+### Find all 14200 solutions to the [12-queens problem](https://www.csplib.org/Problems/prob054/)
+```bash
+NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.queens -n 12 --log_level=INFO
+```
+```bash
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 3 propagators
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 12 variables
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:24:49,200 - INFO - nucs.solvers.multiprocessing_solver - MultiprocessingSolver has 1 processors
+{
+    'OPTIMIZER_SOLUTION_NB': 0,
+    'PROBLEM_FILTER_NB': 262011,
+    'PROBLEM_SHAVING_NB': 0,
+    'PROBLEM_SHAVING_CHANGE_NB': 0,
+    'PROBLEM_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 0,
+    'PROPAGATOR_FILTER_NB': 2269980,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 990450,
+    'PROPAGATOR_INCONSISTENCY_NB': 116806,
+    'SOLVER_BACKTRACK_NB': 131005,
+    'SOLVER_CHOICE_NB': 131005,
+    'SOLVER_CHOICE_DEPTH': 10,
+    'SOLVER_SOLUTION_NB': 14200
+}
+```
+
+### Compute the 92 solutions to the [BIBD(8,14,7,4,3) problem](https://www.csplib.org/Problems/prob028/)
+```bash
+NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.bibd -v 8 -b 14 -r 7 -k 4 -l 3 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 462 propagators
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 504 variables
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 1
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+{
+    'OPTIMIZER_SOLUTION_NB': 0,
+    'PROBLEM_FILTER_NB': 1425,
+    'PROBLEM_SHAVING_NB': 0,
+    'PROBLEM_SHAVING_CHANGE_NB': 0,
+    'PROBLEM_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 4711,
+    'PROPAGATOR_FILTER_NB': 104392,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 73792,
+    'PROPAGATOR_INCONSISTENCY_NB': 621,
+    'SOLVER_BACKTRACK_NB': 712,
+    'SOLVER_CHOICE_NB': 712,
+    'SOLVER_CHOICE_DEPTH': 19,
+    'SOLVER_SOLUTION_NB': 92
+}
+```
+
+### Demonstrate that the optimal [10-marks Golomb ruler](https://www.csplib.org/Problems/prob006/) length is 55
+```bash
+NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.golomb -n 10 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 82 propagators
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 45 variables
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 2
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:27:45,172 - INFO - nucs.solvers.backtrack_solver - Minimizing variable 8
+2024-11-12 17:27:45,644 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 80
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 75
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 73
+2024-11-12 17:27:45,678 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 72
+2024-11-12 17:27:45,679 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 70
+2024-11-12 17:27:45,682 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 68
+2024-11-12 17:27:45,687 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 66
+2024-11-12 17:27:45,693 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 62
+2024-11-12 17:27:45,717 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 60
+2024-11-12 17:27:45,977 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 55
+{
+    'OPTIMIZER_SOLUTION_NB': 10,
+    'PROBLEM_FILTER_NB': 22652,
+    'PROBLEM_SHAVING_NB': 0,
+    'PROBLEM_SHAVING_CHANGE_NB': 0,
+    'PROBLEM_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 107911,
+    'PROPAGATOR_FILTER_NB': 2813035,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 1745836,
+    'PROPAGATOR_INCONSISTENCY_NB': 11289,
+    'SOLVER_BACKTRACK_NB': 11288,
+    'SOLVER_CHOICE_NB': 11353,
+    'SOLVER_CHOICE_DEPTH': 9,
+    'SOLVER_SOLUTION_NB': 10
+}
+[ 1  6 10 23 26 34 41 53 55]
+```
+
+

{nucs-2.0.0 → nucs-2.2.0}/NUCS.egg-info/SOURCES.txt

@@ -74,9 +74,11 @@ nucs/propagators/relation_propagator.py
 nucs/solvers/__init__.py
 nucs/solvers/backtrack_solver.py
 nucs/solvers/bound_consistency_algorithm.py
+nucs/solvers/choice_points.py
 nucs/solvers/consistency_algorithms.py
 nucs/solvers/heuristics.py
 nucs/solvers/multiprocessing_solver.py
+nucs/solvers/shaving_consistency_algorithm.py
 nucs/solvers/solver.py
 tests/__init__.py
 tests/examples/test_alpha.py

nucs-2.2.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.1
+Name: NUCS
+Version: 2.2.0
+Summary: A Numpy and Numba based Python library for solving Constraint Satisfaction Problems over finite domains
+Author-email: Yan Georget <yan.georget@gmail.com>
+Project-URL: Homepage, https://github.com/yangeorget/nucs
+Project-URL: Issues, https://github.com/yangeorget/nucs/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numba==0.60.0
+Requires-Dist: numpy==2.0.1
+
+![NucS logo](https://github.com/yangeorget/nucs/blob/main/assets/nucs.png?raw=true)
+
+
+![pypi version](https://img.shields.io/pypi/v/nucs?color=blue&label=pypi%20version&logo=pypi&logoColor=white)
+![pypi downloads](https://img.shields.io/pypi/dm/NUCS)
+
+![numba version](https://img.shields.io/badge/numba-v0.60-blue)
+![numpy version](https://img.shields.io/badge/numpy-v2.0-blue)
+
+![tests](https://github.com/yangeorget/nucs/actions/workflows/test.yml/badge.svg)
+![doc](https://img.shields.io/readthedocs/nucs)
+![license](https://img.shields.io/github/license/yangeorget/nucs)
+
+## TLDR
+NuCS is a Python library for solving Constraint Satisfaction and Optimization Problems.
+Because it is 100% written in Python, 
+NuCS is easy to install and allows to model complex problems in a few lines of code.
+The NuCS solver is also very fast because it is powered by [Numpy](https://numpy.org/) and [Numba](https://numba.pydata.org/).
+
+## Installation
+```bash
+pip install nucs
+```
+## Documentation
+Check out [NUCS documentation](https://nucs.readthedocs.io/).
+
+## With NuCS, in a few seconds you can ...
+### Find all 14200 solutions to the [12-queens problem](https://www.csplib.org/Problems/prob054/)
+```bash
+NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.queens -n 12 --log_level=INFO
+```
+```bash
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 3 propagators
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 12 variables
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:24:49,200 - INFO - nucs.solvers.multiprocessing_solver - MultiprocessingSolver has 1 processors
+{
+    'OPTIMIZER_SOLUTION_NB': 0,
+    'PROBLEM_FILTER_NB': 262011,
+    'PROBLEM_SHAVING_NB': 0,
+    'PROBLEM_SHAVING_CHANGE_NB': 0,
+    'PROBLEM_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 0,
+    'PROPAGATOR_FILTER_NB': 2269980,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 990450,
+    'PROPAGATOR_INCONSISTENCY_NB': 116806,
+    'SOLVER_BACKTRACK_NB': 131005,
+    'SOLVER_CHOICE_NB': 131005,
+    'SOLVER_CHOICE_DEPTH': 10,
+    'SOLVER_SOLUTION_NB': 14200
+}
+```
+
+### Compute the 92 solutions to the [BIBD(8,14,7,4,3) problem](https://www.csplib.org/Problems/prob028/)
+```bash
+NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.bibd -v 8 -b 14 -r 7 -k 4 -l 3 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 462 propagators
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 504 variables
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 1
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+{
+    'OPTIMIZER_SOLUTION_NB': 0,
+    'PROBLEM_FILTER_NB': 1425,
+    'PROBLEM_SHAVING_NB': 0,
+    'PROBLEM_SHAVING_CHANGE_NB': 0,
+    'PROBLEM_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 4711,
+    'PROPAGATOR_FILTER_NB': 104392,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 73792,
+    'PROPAGATOR_INCONSISTENCY_NB': 621,
+    'SOLVER_BACKTRACK_NB': 712,
+    'SOLVER_CHOICE_NB': 712,
+    'SOLVER_CHOICE_DEPTH': 19,
+    'SOLVER_SOLUTION_NB': 92
+}
+```
+
+### Demonstrate that the optimal [10-marks Golomb ruler](https://www.csplib.org/Problems/prob006/) length is 55
+```bash
+NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.golomb -n 10 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 82 propagators
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 45 variables
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 2
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:27:45,172 - INFO - nucs.solvers.backtrack_solver - Minimizing variable 8
+2024-11-12 17:27:45,644 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 80
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 75
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 73
+2024-11-12 17:27:45,678 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 72
+2024-11-12 17:27:45,679 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 70
+2024-11-12 17:27:45,682 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 68
+2024-11-12 17:27:45,687 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 66
+2024-11-12 17:27:45,693 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 62
+2024-11-12 17:27:45,717 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 60
+2024-11-12 17:27:45,977 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 55
+{
+    'OPTIMIZER_SOLUTION_NB': 10,
+    'PROBLEM_FILTER_NB': 22652,
+    'PROBLEM_SHAVING_NB': 0,
+    'PROBLEM_SHAVING_CHANGE_NB': 0,
+    'PROBLEM_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 107911,
+    'PROPAGATOR_FILTER_NB': 2813035,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 1745836,
+    'PROPAGATOR_INCONSISTENCY_NB': 11289,
+    'SOLVER_BACKTRACK_NB': 11288,
+    'SOLVER_CHOICE_NB': 11353,
+    'SOLVER_CHOICE_DEPTH': 9,
+    'SOLVER_SOLUTION_NB': 10
+}
+[ 1  6 10 23 26 34 41 53 55]
+```
+
+

nucs-2.2.0/README.md

@@ -0,0 +1,125 @@
+![NucS logo](https://github.com/yangeorget/nucs/blob/main/assets/nucs.png?raw=true)
+
+
+![pypi version](https://img.shields.io/pypi/v/nucs?color=blue&label=pypi%20version&logo=pypi&logoColor=white)
+![pypi downloads](https://img.shields.io/pypi/dm/NUCS)
+
+![numba version](https://img.shields.io/badge/numba-v0.60-blue)
+![numpy version](https://img.shields.io/badge/numpy-v2.0-blue)
+
+![tests](https://github.com/yangeorget/nucs/actions/workflows/test.yml/badge.svg)
+![doc](https://img.shields.io/readthedocs/nucs)
+![license](https://img.shields.io/github/license/yangeorget/nucs)
+
+## TLDR
+NuCS is a Python library for solving Constraint Satisfaction and Optimization Problems.
+Because it is 100% written in Python, 
+NuCS is easy to install and allows to model complex problems in a few lines of code.
+The NuCS solver is also very fast because it is powered by [Numpy](https://numpy.org/) and [Numba](https://numba.pydata.org/).
+
+## Installation
+```bash
+pip install nucs
+```
+## Documentation
+Check out [NUCS documentation](https://nucs.readthedocs.io/).
+
+## With NuCS, in a few seconds you can ...
+### Find all 14200 solutions to the [12-queens problem](https://www.csplib.org/Problems/prob054/)
+```bash
+NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.queens -n 12 --log_level=INFO
+```
+```bash
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 3 propagators
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.solver - Problem has 12 variables
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:24:49,061 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:24:49,200 - INFO - nucs.solvers.multiprocessing_solver - MultiprocessingSolver has 1 processors
+{
+    'OPTIMIZER_SOLUTION_NB': 0,
+    'PROBLEM_FILTER_NB': 262011,
+    'PROBLEM_SHAVING_NB': 0,
+    'PROBLEM_SHAVING_CHANGE_NB': 0,
+    'PROBLEM_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 0,
+    'PROPAGATOR_FILTER_NB': 2269980,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 990450,
+    'PROPAGATOR_INCONSISTENCY_NB': 116806,
+    'SOLVER_BACKTRACK_NB': 131005,
+    'SOLVER_CHOICE_NB': 131005,
+    'SOLVER_CHOICE_DEPTH': 10,
+    'SOLVER_SOLUTION_NB': 14200
+}
+```
+
+### Compute the 92 solutions to the [BIBD(8,14,7,4,3) problem](https://www.csplib.org/Problems/prob028/)
+```bash
+NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.bibd -v 8 -b 14 -r 7 -k 4 -l 3 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 462 propagators
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.solver - Problem has 504 variables
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 1
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 0
+2024-11-12 17:26:39,734 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+{
+    'OPTIMIZER_SOLUTION_NB': 0,
+    'PROBLEM_FILTER_NB': 1425,
+    'PROBLEM_SHAVING_NB': 0,
+    'PROBLEM_SHAVING_CHANGE_NB': 0,
+    'PROBLEM_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 4711,
+    'PROPAGATOR_FILTER_NB': 104392,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 73792,
+    'PROPAGATOR_INCONSISTENCY_NB': 621,
+    'SOLVER_BACKTRACK_NB': 712,
+    'SOLVER_CHOICE_NB': 712,
+    'SOLVER_CHOICE_DEPTH': 19,
+    'SOLVER_SOLUTION_NB': 92
+}
+```
+
+### Demonstrate that the optimal [10-marks Golomb ruler](https://www.csplib.org/Problems/prob006/) length is 55
+```bash
+NUMBA_CACHE_DIR=.numba/cache python -m nucs.examples.golomb -n 10 --symmetry_breaking --log_level=INFO
+```
+```bash
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 82 propagators
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.solver - Problem has 45 variables
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses variable heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses domain heuristic 0
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - BacktrackSolver uses consistency algorithm 2
+2024-11-12 17:27:45,110 - INFO - nucs.solvers.backtrack_solver - Choice points stack has a maximal height of 128
+2024-11-12 17:27:45,172 - INFO - nucs.solvers.backtrack_solver - Minimizing variable 8
+2024-11-12 17:27:45,644 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 80
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 75
+2024-11-12 17:27:45,677 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 73
+2024-11-12 17:27:45,678 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 72
+2024-11-12 17:27:45,679 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 70
+2024-11-12 17:27:45,682 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 68
+2024-11-12 17:27:45,687 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 66
+2024-11-12 17:27:45,693 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 62
+2024-11-12 17:27:45,717 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 60
+2024-11-12 17:27:45,977 - INFO - nucs.solvers.backtrack_solver - Found a (new) solution: 55
+{
+    'OPTIMIZER_SOLUTION_NB': 10,
+    'PROBLEM_FILTER_NB': 22652,
+    'PROBLEM_SHAVING_NB': 0,
+    'PROBLEM_SHAVING_CHANGE_NB': 0,
+    'PROBLEM_SHAVING_NO_CHANGE_NB': 0,
+    'PROPAGATOR_ENTAILMENT_NB': 107911,
+    'PROPAGATOR_FILTER_NB': 2813035,
+    'PROPAGATOR_FILTER_NO_CHANGE_NB': 1745836,
+    'PROPAGATOR_INCONSISTENCY_NB': 11289,
+    'SOLVER_BACKTRACK_NB': 11288,
+    'SOLVER_CHOICE_NB': 11353,
+    'SOLVER_CHOICE_DEPTH': 9,
+    'SOLVER_SOLUTION_NB': 10
+}
+[ 1  6 10 23 26 34 41 53 55]
+```
+
+

{nucs-2.0.0 → nucs-2.2.0}/docs/source/conf.py

@@ -6,8 +6,8 @@ project = 'NUCS'
 copyright = '2024, Yan Georget'
 author = 'Yan Georget'
 
-release = '2.0.0'
-version = '2.0.0'
+release = '2.2.0'
+version = '2.2.0'
 
 # -- General configuration
 

{nucs-2.0.0 → nucs-2.2.0}/nucs/constants.py

@@ -42,8 +42,10 @@ SIGNATURE_CONSISTENCY_ALG = int64(
     int32[:, :],  # props_dom_offsets
     int32[:],  # props_parameters
     bool[:, :, :],  # shr_domains_propagators
-    int32[:, :],  # shr_domains_arr
-    bool[:],  # not_entailed_propagators
+    int32[:, :, :],  # shr_domains_stack
+    bool[:, :],  # not_entailed_propagators_stack
+    uint16[:, :],  # dom_update_stack
+    uint8[:],  # stacks_height
     bool[:],  # triggered_propagators
     int64[:],  # compute_domains_addrs
 )
@@ -54,3 +56,11 @@ TYPE_VAR_HEURISTIC = types.FunctionType(SIGNATURE_VAR_HEURISTIC)
 TYPE_CONSISTENCY_ALG = types.FunctionType(SIGNATURE_CONSISTENCY_ALG)
 
 NUMBA_DISABLE_JIT = os.getenv("NUMBA_DISABLE_JIT")
+
+LOG_FORMAT = "%(asctime)s - %(levelname)s - %(name)s - %(message)s"
+LOG_LEVEL_DEBUG = "DEBUG"
+LOG_LEVEL_INFO = "INFO"
+LOG_LEVEL_WARNING = "WARNING"
+LOG_LEVEL_ERROR = "ERROR"
+LOG_LEVEL_CRITICAL = "CRITICAL"
+LOG_LEVELS = [LOG_LEVEL_DEBUG, LOG_LEVEL_INFO, LOG_LEVEL_WARNING, LOG_LEVEL_ERROR, LOG_LEVEL_CRITICAL]

{nucs-2.0.0 → nucs-2.2.0}/nucs/examples/alpha/__main__.py

@@ -10,8 +10,11 @@
 #
 # Copyright 2024 - Yan Georget
 ###############################################################################
+import argparse
+
 from rich import print
 
+from nucs.constants import LOG_LEVEL_INFO, LOG_LEVELS
 from nucs.examples.alpha.alpha_problem import AlphaProblem
 from nucs.solvers.backtrack_solver import BacktrackSolver
 from nucs.solvers.heuristics import DOM_HEURISTIC_MIN_VALUE, VAR_HEURISTIC_SMALLEST_DOMAIN
@@ -20,9 +23,15 @@ from nucs.statistics import get_statistics
 # Run with the following command (the second run is much faster because the code has been compiled):
 # NUMBA_CACHE_DIR=.numba/cache PYTHONPATH=. python -m nucs.examples.alpha
 if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--log_level", choices=LOG_LEVELS, default=LOG_LEVEL_INFO)
+    args = parser.parse_args()
     problem = AlphaProblem()
     solver = BacktrackSolver(
-        problem, var_heuristic_idx=VAR_HEURISTIC_SMALLEST_DOMAIN, dom_heuristic_idx=DOM_HEURISTIC_MIN_VALUE
+        problem,
+        var_heuristic_idx=VAR_HEURISTIC_SMALLEST_DOMAIN,
+        dom_heuristic_idx=DOM_HEURISTIC_MIN_VALUE,
+        log_level=args.log_level,
     )
     solutions = solver.find_all()
     print(get_statistics(solver.statistics))

{nucs-2.0.0 → nucs-2.2.0}/nucs/examples/bibd/__main__.py

@@ -14,6 +14,7 @@ import argparse
 
 from rich import print
 
+from nucs.constants import LOG_LEVEL_INFO, LOG_LEVELS
 from nucs.examples.bibd.bibd_problem import BIBDProblem
 from nucs.solvers.backtrack_solver import BacktrackSolver
 from nucs.solvers.heuristics import DOM_HEURISTIC_MAX_VALUE
@@ -29,8 +30,9 @@ if __name__ == "__main__":
     parser.add_argument("-k", type=int)
     parser.add_argument("-l", type=int)
     parser.add_argument("--symmetry_breaking", action=argparse.BooleanOptionalAction, default=True)
+    parser.add_argument("--log_level", choices=LOG_LEVELS, default=LOG_LEVEL_INFO)
     args = parser.parse_args()
     problem = BIBDProblem(args.v, args.b, args.r, args.k, args.l, args.symmetry_breaking)
-    solver = BacktrackSolver(problem, dom_heuristic_idx=DOM_HEURISTIC_MAX_VALUE)
+    solver = BacktrackSolver(problem, dom_heuristic_idx=DOM_HEURISTIC_MAX_VALUE, log_level=args.log_level)
     solver.solve_all()
     print(get_statistics(solver.statistics))

{nucs-2.0.0 → nucs-2.2.0}/nucs/examples/donald/__main__.py

@@ -10,8 +10,11 @@
 #
 # Copyright 2024 - Yan Georget
 ###############################################################################
+import argparse
+
 from rich import print
 
+from nucs.constants import LOG_LEVEL_INFO, LOG_LEVELS
 from nucs.examples.donald.donald_problem import DonaldProblem
 from nucs.solvers.backtrack_solver import BacktrackSolver
 from nucs.solvers.heuristics import DOM_HEURISTIC_MIN_VALUE, VAR_HEURISTIC_SMALLEST_DOMAIN
@@ -20,9 +23,15 @@ from nucs.statistics import get_statistics
 # Run with the following command (the second run is much faster because the code has been compiled):
 # NUMBA_CACHE_DIR=.numba/cache PYTHONPATH=. python -m nucs.examples.donald
 if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--log_level", choices=LOG_LEVELS, default=LOG_LEVEL_INFO)
+    args = parser.parse_args()
     problem = DonaldProblem()
     solver = BacktrackSolver(
-        problem, var_heuristic_idx=VAR_HEURISTIC_SMALLEST_DOMAIN, dom_heuristic_idx=DOM_HEURISTIC_MIN_VALUE
+        problem,
+        var_heuristic_idx=VAR_HEURISTIC_SMALLEST_DOMAIN,
+        dom_heuristic_idx=DOM_HEURISTIC_MIN_VALUE,
+        log_level=args.log_level,
     )
     print(get_statistics(solver.statistics))
     for solution in solver.solve():

{nucs-2.0.0 → nucs-2.2.0}/nucs/examples/golomb/__main__.py

@@ -14,6 +14,7 @@ import argparse
 
 from rich import print
 
+from nucs.constants import LOG_LEVEL_INFO, LOG_LEVELS
 from nucs.examples.golomb.golomb_problem import GolombProblem, golomb_consistency_algorithm
 from nucs.solvers.backtrack_solver import BacktrackSolver
 from nucs.solvers.consistency_algorithms import register_consistency_algorithm
@@ -25,10 +26,11 @@ if __name__ == "__main__":
     parser = argparse.ArgumentParser()
     parser.add_argument("-n", type=int, default=10)
     parser.add_argument("--symmetry_breaking", action=argparse.BooleanOptionalAction, default=True)
+    parser.add_argument("--log_level", choices=LOG_LEVELS, default=LOG_LEVEL_INFO)
     args = parser.parse_args()
     problem = GolombProblem(args.n, args.symmetry_breaking)
     consistency_alg_golomb = register_consistency_algorithm(golomb_consistency_algorithm)
-    solver = BacktrackSolver(problem, consistency_alg_idx=consistency_alg_golomb)
+    solver = BacktrackSolver(problem, consistency_alg_idx=consistency_alg_golomb, log_level=args.log_level)
     solution = solver.minimize(problem.length_idx)
     print(get_statistics(solver.statistics))
     if solution is not None:

{nucs-2.0.0 → nucs-2.2.0}/nucs/examples/golomb/golomb_problem.py

@@ -18,7 +18,7 @@ from numpy.typing import NDArray
 
 from nucs.constants import MAX, MIN
 from nucs.problems.problem import Problem
-from nucs.propagators.propagators import ALG_AFFINE_EQ, ALG_AFFINE_LEQ, ALG_ALLDIFFERENT
+from nucs.propagators.propagators import ALG_AFFINE_EQ, ALG_AFFINE_LEQ, ALG_ALLDIFFERENT, add_propagators
 from nucs.solvers.bound_consistency_algorithm import bound_consistency_algorithm
 from nucs.solvers.heuristics import first_not_instantiated_var_heuristic
 
@@ -124,8 +124,10 @@ def golomb_consistency_algorithm(
     props_dom_offsets: NDArray,
     props_parameters: NDArray,
     shr_domains_propagators: NDArray,
-    shr_domains_arr: NDArray,
-    not_entailed_propagators: NDArray,
+    shr_domains_stack: NDArray,
+    not_entailed_propagators_stack: NDArray,
+    dom_update_stack: NDArray,
+    stacks_height: NDArray,
     triggered_propagators: NDArray,
     compute_domains_addrs: NDArray,
 ) -> int:
@@ -137,7 +139,7 @@ def golomb_consistency_algorithm(
     """
     # first prune the search space
     mark_nb = (1 + int(math.sqrt(8 * len(dom_indices_arr) + 1))) // 2
-    ni_var_idx = first_not_instantiated_var_heuristic(shr_domains_arr)  # no domains shared between vars
+    ni_var_idx = first_not_instantiated_var_heuristic(shr_domains_stack[0])  # no domains shared between vars
     if 1 < ni_var_idx < mark_nb - 1:  # otherwise useless
         used_distance = np.zeros(sum_first(mark_nb - 2) + 1, dtype=np.bool)
         # a reusable array for storing the minimal sum of different integers:
@@ -146,7 +148,7 @@ def golomb_consistency_algorithm(
         # the following will mark at most sum(n-3) numbers as used
         # hence there will be at least n-2 unused numbers greater than 0
         for var_idx in range(index(mark_nb, ni_var_idx - 2, ni_var_idx - 1) + 1):
-            dist = shr_domains_arr[dom_indices_arr[var_idx], MIN]  # no offset
+            dist = shr_domains_stack[0, dom_indices_arr[var_idx], MIN]  # no offset
             if dist < len(used_distance):
                 used_distance[dist] = True
         # let's compute the sum of non-used numbers
@@ -158,7 +160,11 @@ def golomb_consistency_algorithm(
             distance += 1
         for i in range(ni_var_idx - 1, mark_nb - 1):
             for j in range(i + 1, mark_nb):
-                shr_domains_arr[dom_indices_arr[index(mark_nb, i, j)], MIN] = minimal_sum[j - i]  # no offset
+                dom_idx = dom_indices_arr[index(mark_nb, i, j)]
+                shr_domains_stack[0, dom_idx, MIN] = minimal_sum[j - i]  # no offset
+                add_propagators(
+                    triggered_propagators, not_entailed_propagators_stack[0], shr_domains_propagators, dom_idx, MIN
+                )
     return bound_consistency_algorithm(
         statistics,
         algorithms,
@@ -170,8 +176,10 @@ def golomb_consistency_algorithm(
         props_dom_offsets,
         props_parameters,
         shr_domains_propagators,
-        shr_domains_arr,
-        not_entailed_propagators,
+        shr_domains_stack,
+        not_entailed_propagators_stack,
+        dom_update_stack,
+        stacks_height,
         triggered_propagators,
         compute_domains_addrs,
     )