NuCS 4.4.4__py3-none-any.whl

NuCS-4.4.4.dist-info/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+## Copyright (c) 2024 Yan Georget
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

NuCS-4.4.4.dist-info/METADATA

@@ -0,0 +1,152 @@
+Metadata-Version: 2.1
+Name: NuCS
+Version: 4.4.4
+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 :: 5 - Production/Stable
+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: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+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.1
+Requires-Dist: rich
+
+![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
+{
+    'ALG_BC_NB': 262011,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_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
+{
+    'ALG_BC_NB': 1425,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_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
+{
+    'ALG_BC_NB': 22652,
+    'ALG_BC_WITH_SHAVING_NB': 0,
+    'ALG_SHAVING_NB': 0,
+    'ALG_SHAVING_CHANGE_NB': 0,
+    'ALG_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-4.4.4.dist-info/RECORD

@@ -0,0 +1,147 @@
+docs/source/conf.py,sha256=cvDQ0FUW5qAB2oyqlNf9jNGHU7D5Or2A_FEhOqEVyjs,1276
+nucs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/constants.py,sha256=zQYwKie0a1232-0syLn0I2NqAs5wfqNIZpXaQqC-0Eo,4756
+nucs/numba_helper.py,sha256=_VUNexo50aFJtqbZgfYAJ3nelG4YTnMkJZYdX4Ay5Zs,1408
+nucs/numpy_helper.py,sha256=9EYK3dcniZJqA0qvWgFqzNJvLF2BpT8wExDn0uqf4cs,987
+nucs/examples/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/alpha/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/alpha/__main__.py,sha256=fUmvpFptKFTOVFJFk95R209z02ENz8kBgjcmCdqGJc0,1472
+nucs/examples/alpha/alpha_problem.py,sha256=6Pd2u7yYJLTLsW_C0XhB65blz6kBwucj8Ns5-Dx8fMw,4219
+nucs/examples/bibd/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/bibd/__main__.py,sha256=Wn83zV0LqH4CsQvrT2_M2o2uWMmW0GRRblnhx6ikUTQ,1732
+nucs/examples/bibd/bibd_problem.py,sha256=EyQGhW6YIqpYwWvgPGA5zTQIm_SZTkbgelxGSlhccZ4,3278
+nucs/examples/donald/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/donald/__main__.py,sha256=9erogAn_NP9jdmARzMEZdOPuMA9zBhM1DTDdrxp7Fus,1479
+nucs/examples/donald/donald_problem.py,sha256=EqoKWQTGaMmKvW8R60jkd404tGZMjOz9c2xZe_dBlJs,1877
+nucs/examples/golomb/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/golomb/__main__.py,sha256=vZswqdN-YIVrXH3WtyejX_tj7bhQcpiVLJ1u2_BSpJ4,2393
+nucs/examples/golomb/golomb_problem.py,sha256=5vy2et5GtUI2SQbvTiUc9UehvUYAP9BYO9ysCKwPaE8,7129
+nucs/examples/knapsack/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/knapsack/__main__.py,sha256=CrSzscnsqZKwj01Up24tR7FazLlQDTVleEk6MSJzuTw,1807
+nucs/examples/knapsack/knapsack_problem.py,sha256=njuNB-jXBnt9hLhk5GwRf9ZDoF81fddsVbA_1K_YfDY,1297
+nucs/examples/magic_sequence/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/magic_sequence/__main__.py,sha256=bEmwXvkt21bO2KwdQPJ_TRj-uXCUt-u4uUKtx9dY2ek,1623
+nucs/examples/magic_sequence/magic_sequence_problem.py,sha256=yesK69Rndgi8vn6l3-wIaLyVP0OBdO-bi0OSGP6ppis,1277
+nucs/examples/magic_square/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/magic_square/__main__.py,sha256=8pPmdiDN9LpSi8iQC7Qv5hPATHHR9ousClC6jhUWZOI,1650
+nucs/examples/magic_square/magic_square_problem.py,sha256=1I98kNc25nnMlpMQblawYRKYbZlZ1RajHx3TRSwBU_4,2561
+nucs/examples/quasigroup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/quasigroup/__main__.py,sha256=l_nRVQF_mSyeQuUVyY3SoTkl8n-LIyCTKDF03vXoAIA,2190
+nucs/examples/quasigroup/quasigroup_problem.py,sha256=kET3aTk6pFljaPylLecNTA648EaqMWIS-dFrfNW1s1Q,5099
+nucs/examples/queens/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/queens/__main__.py,sha256=Z4Azi9dLON8q84QvKqJ9GOkmsal9d-PQ-zpvD7NB0zY,2617
+nucs/examples/queens/queens_problem.py,sha256=c3o96RihI8YtXPfNuaSz2IpqfToovNKMeVa6tJOlln0,1461
+nucs/examples/schur_lemma/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/schur_lemma/__main__.py,sha256=pbOh4ymkPUGwIbogUsXq7hVjQ0bcxOS3sbVtO1L1Cgc,1445
+nucs/examples/schur_lemma/schur_lemma_problem.py,sha256=CZLMlzqq4C7riJqbGvVo9eRL8ErZE3LecOAwx1iueV8,1730
+nucs/examples/sports_tournament_scheduling/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/sports_tournament_scheduling/__main__.py,sha256=ZOY-qBD2pLi1vtp3s1AFWKwwYPIWMWxKji5331FxkAU,1811
+nucs/examples/sports_tournament_scheduling/sports_tournament_scheduling_problem.py,sha256=hrG2aeH9Y7JcZtBGd7Ix7qrdzGS-WQtamB7Ho1SWcKc,4710
+nucs/examples/sudoku/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/sudoku/sudoku_problem.py,sha256=pKxivNYoXeveBuGPVL15R85OHMMvDGJUxCIWV7PZ6Ic,1206
+nucs/examples/tsp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/examples/tsp/__main__.py,sha256=QfQM9sv4rWhuHpVmkwZh-EOAvQAjvkMfDh42T4W222Y,3260
+nucs/examples/tsp/total_cost_propagator.py,sha256=Yap4zcpwP7itWXOdz_H17UD9CTXBGslqPnHyx1DI2sQ,3271
+nucs/examples/tsp/tsp_instances.py,sha256=nMf6DZH3ROvCxEtIBn5d7zVEJ5aU_Lh4Mxd3Oxisnzo,6880
+nucs/examples/tsp/tsp_problem.py,sha256=dUlhyC_5vx2wZap1YF8y-ksLCZe1YaizCInZMSkedTw,2302
+nucs/examples/tsp/tsp_var_heuristic.py,sha256=Lhfig18Fht5xv1BNxr3KJV_89lU0Y9VWkSa0565TBR0,1889
+nucs/heuristics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/heuristics/first_not_instantiated_var_heuristic.py,sha256=cg7UH-WL0cNkonlqkawReji7HylgIwWa_mH2AnKuXYQ,1353
+nucs/heuristics/greatest_domain_var_heuristic.py,sha256=9n9olek1M8LnKf5jLTjFlphJQiT8Clx8CcGX83TQhpI,1489
+nucs/heuristics/heuristics.py,sha256=pJpYoS5fUtZjP48z6zDMLVOKkWsHJVmbYAY4I6i2Zqw,2949
+nucs/heuristics/max_regret_var_heuristic.py,sha256=2is67hJp2Fcy7Wdq5MiqFx7X1MVgpIdskF0kNtFTRb4,2027
+nucs/heuristics/max_value_dom_heuristic.py,sha256=r6L2DuDxa1TilGLaxEMCkn54hHb3hGB5kqEEZ8X2u5k,1994
+nucs/heuristics/mid_value_dom_heuristic.py,sha256=cy9C8gmgSlYzGzQ8xPwTI-HnZaMaF9b3RfQ9QACBItk,1657
+nucs/heuristics/min_cost_dom_heuristic.py,sha256=Hw5AuB7hgDzWVcxeC8zAIr7KLAtD39iR8YxFXpN8C6Q,1886
+nucs/heuristics/min_value_dom_heuristic.py,sha256=ie8JZKNE2MDPHcG_KNK7eCUp2WFUV4_iIMIqgqxxpd4,2005
+nucs/heuristics/smallest_domain_var_heuristic.py,sha256=dJxqBi09zwiURIRRSjR4_jemgnJbcM2izeRPnV0d89E,1496
+nucs/heuristics/split_high_dom_heuristic.py,sha256=bZ0ix0tnu4Vzv-Jlcc4hDql5ZxVPDJNAcgagf-hC4Uc,2040
+nucs/heuristics/split_low_dom_heuristic.py,sha256=ImL3S_nqtk3XJN1IYfd9BztmKNYSf5On_CuMz3JKzD8,2038
+nucs/heuristics/value_dom_heuristic.py,sha256=lRVdvVY2Fbs4S1WZ4oDJxDMEPYhJL33LwQELxwjOC-U,2992
+nucs/problems/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/problems/circuit_problem.py,sha256=YWFmqZDTBUml6QQOSVYz6WlA8jpGQqJLriepjJEWoGo,1374
+nucs/problems/latin_square_problem.py,sha256=CGtgKHZYCPlo8c5v1G2iOUuvRzgMEYQ9eeNkxY12rfY,4686
+nucs/problems/permutation_problem.py,sha256=tTN8d_LPbbRxM0tjqnoCBSTeaV9xCX6bebxKTsqDm9I,1270
+nucs/problems/problem.py,sha256=JweaKlE8s8XzCB0GmkL2n4h45dEg4g6EY7PfCbp-4zE,9365
+nucs/propagators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/propagators/affine_eq_propagator.py,sha256=zZz5J9hBTpmbudvR9YlerhztLgn8U8j9J7Uy49Jgi8g,2720
+nucs/propagators/affine_geq_propagator.py,sha256=79SigRzUIRKvBOP_dGT0lArY-HzCk239G32avN952YI,2814
+nucs/propagators/affine_leq_propagator.py,sha256=5lpTNweZZfDM-CMWeSns4IFQS0nHFVO6SaHOr6pMcaw,2812
+nucs/propagators/alldifferent_propagator.py,sha256=ouSfw1u2x1FLPBFfdsxuvKNWI5fs4qZRittWOa-pM7E,6884
+nucs/propagators/and_propagator.py,sha256=khCzVKm6C1oMRZzYnsMOQjm9DkecZ5xc-CzowD899EI,2188
+nucs/propagators/count_eq_propagator.py,sha256=AjMQtUY9KagibVF35CIORVK_MgXRzoeZHC6j7ho-e8U,2693
+nucs/propagators/dummy_propagator.py,sha256=B8lEYioN6ybFx2NZ_0wACeL_MFSkY8mJmxqpnnI_R3A,1551
+nucs/propagators/element_iv_propagator.py,sha256=aPi05TP8Q7NB7lySTSxbUdRqwPPez9u88irPCkjI5fM,2620
+nucs/propagators/element_lic_propagator.py,sha256=lYbZFHThqGGETlUyF-aCJ1Pft_RSSC4opj_Ed7mfvO4,2423
+nucs/propagators/element_liv_propagator.py,sha256=qwH90Dlr5Yjaiu75eTbqE9rZZnyPto3IaIOSCis6gcY,2785
+nucs/propagators/exactly_eq_propagator.py,sha256=6sr3dluMHmT_A3i3UNvRLZyjc42XwIQVqMiRWFTpz64,2739
+nucs/propagators/exactly_true_propagator.py,sha256=iRfqegj9k0qMh4ySmP2l4Vm9ZhCOyz0Vzn3jRen0ccw,2636
+nucs/propagators/gcc_propagator.py,sha256=gnVyDiudpBgpdXBG_XwlSNYugSeLwE1hVJE830C_psE,15594
+nucs/propagators/lexicographic_leq_propagator.py,sha256=gyICaTn8eF7DL42S6uTcsgTOuiP70BCFBoKzFKBqQ-s,5483
+nucs/propagators/max_eq_propagator.py,sha256=4GjM6HG2N1PVh-1cabk5fOMPVGTeRDwCxh1YRryFBtw,2091
+nucs/propagators/max_leq_propagator.py,sha256=ztQkKH2ex6aBUh3fWoSJxCZ7PXODcEsZTXFQ9_6rLYI,2114
+nucs/propagators/min_eq_propagator.py,sha256=o1hsfQ02xUL0PPdlb1hIIgAKfh4MQG-W_HFk9SddqKM,2091
+nucs/propagators/min_geq_propagator.py,sha256=2VWO4XsKNSGYCT9jkVILD9SYWBpRlroqkhES51jl1Ao,2114
+nucs/propagators/no_sub_cycle_propagator.py,sha256=qULnvmsO7-tYInpwYNTaoztLQi0T82PUgto-BHSVVMM,2999
+nucs/propagators/permutation_aux_propagator.py,sha256=jKk9lzG0tkPxV1jZpwcg6-X-Iyl6avq_kG0AvDDBD6M,2216
+nucs/propagators/propagators.py,sha256=IJXBzOjju0Ve7FEdNm5JuD8VBgx9NaLqUHiOCrj3r28,7772
+nucs/propagators/relation_propagator.py,sha256=feDQ0cC40SVdiYtlR2MzzF_b30-IlYZHhjnvNEEvFRc,2464
+nucs/propagators/scc_propagator.py,sha256=Z8CotxBazXJSWJua58DYfgueW4CFiwJEd4T1AQMqGfw,2560
+nucs/solvers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nucs/solvers/backtrack_solver.py,sha256=GCzfTwn6W3YWvqhwWdnjEr9gATuH3o_hctmhebgMpdI,26726
+nucs/solvers/bound_consistency_algorithm.py,sha256=rL1xnolzM9wAZ5FcTyeMUlJkHu05pc6q6x18bWnzn84,6126
+nucs/solvers/choice_points.py,sha256=5I4yvagiTP1Mgml-P7j2BNsLj4uURLKaQUNP4f6oduo,4845
+nucs/solvers/consistency_algorithms.py,sha256=Jp5DiO4zQQ1ArE566cQGDzfsOFpMJOI1EEQ-TSLS2Bw,1298
+nucs/solvers/multiprocessing_solver.py,sha256=etVnZEjWQzIs-kFK39cpBceEnn9ni7DAS80vsz2eJNc,5717
+nucs/solvers/shaving_consistency_algorithm.py,sha256=GNZ0D3nrtDQofdz5ixsCDs68Yr8oTpUMmoAfP0inze4,7707
+nucs/solvers/solver.py,sha256=Z50cVFgjJBH73gyTIfJ-I88Hp15rYF-5cNOGvDqM-co,3920
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/examples/test_alpha.py,sha256=owTEvjwz60JgAjEp7hzft9hCfs7ZV8TaXTT5H2xAqzo,1559
+tests/examples/test_bibd.py,sha256=EbsB0cd4TJ06U50k77g3vQIgyRyxdhPYwk2xVDc4S98,1127
+tests/examples/test_donald.py,sha256=c_Aoh3XnJ_czVZGaWoPqJfh33CBgkBqVHVS7C43NSBs,1172
+tests/examples/test_golomb.py,sha256=UVoDW92lO5HisWzPxAtiQPdoKgGSs_sXtdgQq4zwTNs,1571
+tests/examples/test_knapsack.py,sha256=fBYbM7XFdC89A9g7RxTt6OYlSAJnP4qfmhUcwXMPFfY,1311
+tests/examples/test_latin_square.py,sha256=mZfHm04POuXZvROlMPyuIn81Cnrfqm4wy4VYMNwUws4,1651
+tests/examples/test_magic_sequence.py,sha256=Tmtl5RX1PNpg9-SCpFP9sKok5SWxjTUMSZ0TSq4cXgo,1447
+tests/examples/test_magic_square.py,sha256=gnXLZNv1VzmP-c3HZIz6CmNk5h2PUS7I_a1UzSos57w,1475
+tests/examples/test_quasigroup.py,sha256=ywexQRKzbzCD67frWI6tDLMlHys3hfxyia-wVO6MnUI,2168
+tests/examples/test_queens.py,sha256=Ln3AHeSX-ZDPBmOeyxuny0B-jeu3SwlnDCjCFJkHsFM,1528
+tests/examples/test_schur_lemma.py,sha256=qUjOA4SmOkQRVr3WNS2ddgNrfQh43bgGRnuBYFqTxKg,1441
+tests/examples/test_sports_tournament_scheduling.py,sha256=K4VCbjq6F4JZxXwKFiI1axZep5nVwcq5L1oRxjyM5z8,3200
+tests/examples/test_sudokus.py,sha256=6GTt75Fl3f08VdajyD9o1q_ngiOq_cIWPcS0JjZEHdI,1898
+tests/examples/test_tsp.py,sha256=vn9oss3KCEpDm_rZaTtfLc_lBoX_hzqpRD0SgAZSr8Q,2291
+tests/heuristics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/heuristics/test_max_value_dom_heuristic.py,sha256=B_9jYk00H3g2UBrVfHIBc-11XtfH_YIoFSOseEPtvO4,962
+tests/heuristics/test_mid_value_dom_heuristic.py,sha256=fpo98vU-urqNowpRJAEFbFDNr7kwG47q4clZ0Wjhv98,977
+tests/heuristics/test_min_value_dom_heuristic.py,sha256=Bf52n5s-y90seapxjXHbH8RKlUNQgKmqjhkwhqaZcl4,962
+tests/problems/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/problems/test_circuit_problem.py,sha256=JiT8fDy5jWWqjpEKjoP0-UDfP9AwZxuj1pkafJEaNDE,1502
+tests/problems/test_permutation_problem.py,sha256=x7oDCyobulrCUjd7WYK5SJmJZozH01FnX0jOEwnX3Sg,1375
+tests/problems/test_problem.py,sha256=7T65Irj8C0rjM2UnAfwvcX8PvnaNFbsV7MoHbHkBgsA,1611
+tests/propagators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/propagators/test_affine_eq.py,sha256=3DAz4eTNeecGZc9WO77c5iLsSgrGnYxV8Cl6SR9dpiA,2748
+tests/propagators/test_affine_geq.py,sha256=8IG290rjT6A4SevKnaTb7l7dmtcwKpljyZBfRFGkTZc,1863
+tests/propagators/test_affine_leq.py,sha256=5YZdUpVMadWVqB9k0aGMCAdxmvpPJR7RyyEuycVq8W0,1838
+tests/propagators/test_alldifferent.py,sha256=cTK4Fg9LZaA47pbmpRvSHJqvDu6ts7CkvFxv9sMAYtU,2434
+tests/propagators/test_count_eq.py,sha256=d__FnHuTdTuUDxhYGTTLBobm4v6W6jlM29oMRRby5MY,2778
+tests/propagators/test_element_iv.py,sha256=0rgC5ui_cLDDanU_W7oTIEfFFn6nU4GYNGe4rhz7v2o,1619
+tests/propagators/test_element_lic.py,sha256=_55NUVFchU59Z89h-cYkgG8uTnpPDDfPZkHSXmCTCMo,1633
+tests/propagators/test_element_liv.py,sha256=Xs2BG1ppIQzDX9K8StmLc3CvwrSC2cxgt8cDkyo-IOw,2019
+tests/propagators/test_exactly_eq.py,sha256=lMsPYBWcJfkXb_z4uzAD9tNUHYCFV5Viua0t5C_CufM,2046
+tests/propagators/test_gcc.py,sha256=VwKU8unRjvw7uxn0VNvl-9iKovz9g3aeRoWwiIDq-t0,2784
+tests/propagators/test_lexicographic_leq.py,sha256=b2s8y5xIrrlydnX83IquR-bEMp-OfEcNeOdiFAYmf_4,3587
+tests/propagators/test_max_eq.py,sha256=4Q4eql1IJDDvfE0QsIIfVjKcUBLinzOagPZ_F11wrjI,2048
+tests/propagators/test_max_leq.py,sha256=FtTJXZ6ux_Rod31Vbt6Yk0aQVYVSPqIvyJYqEo786hk,2139
+tests/propagators/test_min_eq.py,sha256=i1oXyAidSCP52g9si4kmja2BFwZu0p0MhpPbP-AobeA,2048
+tests/propagators/test_min_geq.py,sha256=g8H5qtrrXROWg7dOppNhOAsILBRRkslYf2hSozlUTsA,2139
+tests/propagators/test_no_sub_cycle.py,sha256=UleY08obAYNtzze9fAyXjmmDRpyuYDfPxBlB1FaFTP4,1465
+tests/propagators/test_relation.py,sha256=k8yCUMtBs-PHYV-eVe6lvUFYnWXHeJNcZYDTbD46PVI,2822
+tests/propagators/test_scc.py,sha256=ZnQYmQqA4wLwDjTHXerzf07EAyMgPedaEn-i3cVVfOw,1401
+tests/solvers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/solvers/test_backtrack_solver.py,sha256=rRceFxlS-BCzRQ1r0r_M2AhAy_ivmDAlyQWqCuhKG5k,4516
+tests/solvers/test_multiprocessing_solver.py,sha256=dcMRlIXvMtq3-xkHAN4r-t4fxgq9RdLkg5Swgp15Cxk,2824
+NuCS-4.4.4.dist-info/LICENSE.md,sha256=MqbogGRoftDA7kJ5LzCwNDT8JE4nJZbdB7NN0dPvklE,1072
+NuCS-4.4.4.dist-info/METADATA,sha256=dAbtswGq9JPI3Y6LbXL9RnlzmzOjNGaKA04P-B2ouQs,7246
+NuCS-4.4.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+NuCS-4.4.4.dist-info/top_level.txt,sha256=rlOWPmROiPsaCDsuV3R_Eie_jj1rBdsD4FdFqJU6nEo,16
+NuCS-4.4.4.dist-info/RECORD,,

NuCS-4.4.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

NuCS-4.4.4.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+docs
+nucs
+tests

docs/source/conf.py

@@ -0,0 +1,54 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'NuCS'
+copyright = '2024, Yan Georget'
+author = 'Yan Georget'
+
+release = '4.4.4'
+version = '4.4.4'
+
+# -- General configuration
+
+tls_verify = False
+
+extensions = [
+    'sphinx.ext.linkcode',
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+
+html_context = {
+    "display_github": True, # Integrate GitHub
+    "github_user": "yangeorget", # Username
+    "github_repo": "nucs", # Repo name
+    "github_version": "main", # Version
+    "conf_py_path": "/docs/source/", # Path in the checkout to the docs root
+}
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'
+
+def linkcode_resolve(domain, info):
+    if domain != 'py':
+        return None
+    if info['module']:
+        filename = info['module'].replace('.', '/')
+        return f"https://github.com/yangeorget/nucs/tree/main/{filename}.py"
+    return None

nucs/constants.py

@@ -0,0 +1,127 @@
+###############################################################################
+# __   _            _____    _____
+# | \ | |          / ____|  / ____|
+# |  \| |  _   _  | |      | (___
+# | . ` | | | | | | |       \___ \
+# | |\  | | |_| | | |____   ____) |
+# |_| \_|  \__,_|  \_____| |_____/
+#
+# Fast constraint solving in Python  - https://github.com/yangeorget/nucs
+#
+# Copyright 2024 - Yan Georget
+###############################################################################
+import os
+
+from numba import bool, int32, int64, types, uint8, uint16  # type: ignore
+
+OPTIM_RESET = "RESET"
+OPTIM_PRUNE = "PRUNE"
+OPTIM_MODES = [OPTIM_RESET, OPTIM_PRUNE]
+
+RG_START = 0  # index corresponding the start of a values range
+RG_END = 1  # index corresponding the end of a values range
+
+MIN = 0  # min value of a domain
+MAX = 1  # max value of a domain
+
+DOM_UPDATE_IDX = 0
+DOM_UPDATE_EVENTS = 1
+
+EVENT_MASK_MIN = 1 << 0
+EVENT_MASK_MAX = 1 << 1
+EVENT_MASK_GROUND = 1 << 2
+EVENT_MASK_MIN_MAX = EVENT_MASK_MIN | EVENT_MASK_MAX
+EVENT_MASK_MIN_GROUND = EVENT_MASK_MIN | EVENT_MASK_GROUND
+EVENT_MASK_MAX_GROUND = EVENT_MASK_MAX | EVENT_MASK_GROUND
+EVENT_MASK_MIN_MAX_GROUND = EVENT_MASK_MIN | EVENT_MASK_MAX | EVENT_MASK_GROUND
+
+
+PROP_INCONSISTENCY = 0  # returned by a propagator when inconsistent
+PROP_CONSISTENCY = 1  # returned by a propagator when consistent
+PROP_ENTAILMENT = 2  # returned by a propagator when entailed
+
+PROBLEM_INCONSISTENT = 0  # returned when the filtering of a problem detects an inconsistency
+PROBLEM_UNBOUND = 1  # returned when the filtering of a problem has been completed but the problem is not solved
+PROBLEM_BOUND = 2  # returned when a problem is solved
+
+SIGNATURE_COMPUTE_DOMAINS = int64(int32[:, :], int32[:])  # domains, parameters
+SIGNATURE_CONSISTENCY_ALG = int64(
+    int64[:],  # statistics
+    uint8[:],  # algorithms
+    uint16[:, :],  # var_bounds
+    uint16[:, :],  # param_bounds
+    uint16[:],  # dom_indices_arr
+    int32[:],  # dom_offsets_arr
+    uint16[:],  # props_dom_indices
+    int32[:, :],  # props_dom_offsets
+    int32[:],  # props_parameters
+    uint8[:, :],  # shr_domains_propagators
+    int32[:, :, :],  # shr_domains_stack
+    bool[:, :],  # not_entailed_propagators_stack
+    uint16[:, :],  # dom_update_stack
+    uint8[:],  # stacks_top
+    bool[:],  # triggered_propagators
+    int64[:],  # compute_domains_addrs
+    uint16[:],  # decision_domains
+)
+SIGNATURE_DOM_HEURISTIC = int64(
+    int32[:, :, :],  # shr_domains_stack
+    bool[:, :],  # not_entailed_propagators_stack
+    uint16[:, :],  # dom_update_stack
+    uint8[:],  # stacks_top
+    int64,  # dom_idx
+    int64[:, :],  # dom_heuristic_params
+)
+SIGNATURE_VAR_HEURISTIC = int64(
+    uint16[:],  # decision_variables
+    int32[:, :, :],  # shr_domains_stack
+    uint8[:],  # stacks_top
+    int64[:, :],  # var_heuristic_params
+)
+
+
+TYPE_COMPUTE_DOMAINS = types.FunctionType(SIGNATURE_COMPUTE_DOMAINS)
+TYPE_DOM_HEURISTIC = types.FunctionType(SIGNATURE_DOM_HEURISTIC)
+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 | %(processName)s | %(levelname)s ] %(name)s.%(funcName)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]
+
+STATS_MAX = 13
+(
+    STATS_IDX_ALG_BC_NB,
+    STATS_IDX_ALG_BC_WITH_SHAVING_NB,
+    STATS_IDX_ALG_SHAVING_NB,
+    STATS_IDX_ALG_SHAVING_CHANGE_NB,
+    STATS_IDX_ALG_SHAVING_NO_CHANGE_NB,
+    STATS_IDX_PROPAGATOR_ENTAILMENT_NB,
+    STATS_IDX_PROPAGATOR_FILTER_NB,
+    STATS_IDX_PROPAGATOR_FILTER_NO_CHANGE_NB,
+    STATS_IDX_PROPAGATOR_INCONSISTENCY_NB,
+    STATS_IDX_SOLVER_BACKTRACK_NB,
+    STATS_IDX_SOLVER_CHOICE_NB,
+    STATS_IDX_SOLVER_CHOICE_DEPTH,
+    STATS_IDX_SOLVER_SOLUTION_NB,
+) = tuple(range(STATS_MAX))
+
+STATS_LBL_ALG_BC_NB = "ALG_BC_NB"
+STATS_LBL_ALG_BC_WITH_SHAVING_NB = "ALG_BC_WITH_SHAVING_NB"
+STATS_LBL_ALG_SHAVING_NB = "ALG_SHAVING_NB"
+STATS_LBL_ALG_SHAVING_CHANGE_NB = "ALG_SHAVING_CHANGE_NB"
+STATS_LBL_ALG_SHAVING_NO_CHANGE_NB = "ALG_SHAVING_NO_CHANGE_NB"
+STATS_LBL_PROPAGATOR_ENTAILMENT_NB = "PROPAGATOR_ENTAILMENT_NB"
+STATS_LBL_PROPAGATOR_FILTER_NB = "PROPAGATOR_FILTER_NB"
+STATS_LBL_PROPAGATOR_FILTER_NO_CHANGE_NB = "PROPAGATOR_FILTER_NO_CHANGE_NB"
+STATS_LBL_PROPAGATOR_INCONSISTENCY_NB = "PROPAGATOR_INCONSISTENCY_NB"
+STATS_LBL_SOLVER_BACKTRACK_NB = "SOLVER_BACKTRACK_NB"
+STATS_LBL_SOLVER_CHOICE_NB = "SOLVER_CHOICE_NB"
+STATS_LBL_SOLVER_CHOICE_DEPTH = "SOLVER_CHOICE_DEPTH"
+STATS_LBL_SOLVER_SOLUTION_NB = "SOLVER_SOLUTION_NB"

nucs/examples/alpha/__main__.py

@@ -0,0 +1,37 @@
+###############################################################################
+# __   _            _____    _____
+# | \ | |          / ____|  / ____|
+# |  \| |  _   _  | |      | (___
+# | . ` | | | | | | |       \___ \
+# | |\  | | |_| | | |____   ____) |
+# |_| \_|  \__,_|  \_____| |_____/
+#
+# Fast constraint solving in Python  - https://github.com/yangeorget/nucs
+#
+# 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.heuristics.heuristics import DOM_HEURISTIC_MIN_VALUE, VAR_HEURISTIC_SMALLEST_DOMAIN
+from nucs.solvers.backtrack_solver import BacktrackSolver
+
+# Run with the following command (the second run is much faster because the code has been compiled):
+# NUMBA_CACHE_DIR=.numba/cache 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,
+        log_level=args.log_level,
+    )
+    solutions = solver.find_all()
+    print(solver.get_statistics())
+    print(problem.solution_as_dict(solutions[0]))