Constraint programming extensions (#270)

* CPE for AllDifferent and AllEqual
* deprecation warning for AllDifferentSet and EqualSet
* v0.7

Author: Wikunia

.gitignore

@@ -8,6 +8,7 @@ literature/
 extra/
 test/logs/
 docs/build/
+docs/Manifest.toml
 benchmark/**/results
 instances
 **/nohup.out

CHANGELOG.md

@@ -1,11 +1,16 @@
 # ConstrainSolver.jl - Changelog
 
+## v0.7.0 (7th of August 2021)
+- Using [ConstraintProgrammingExtensions.jl](https://github.com/dourouc05/ConstraintProgrammingExtensions.jl)
+  - `AllDifferent` instead of `AllDifferentSet`
+  - `AllEqual` instead of `EqualSet`
+
 ## v0.6.10 (26th of July 2021)
 - Allow variables as constraint like `a || !b` instead of `a == 1 || b == 0`. [PR #267](https://github.com/Wikunia/ConstraintSolver.jl/pull/267)
   - **Attention** Does not check if variable is a binary variable
 - Support for indicator/reified in indicator/reified (without bridges) [PR #251](https://github.com/Wikunia/ConstraintSolver.jl/pull/251)
 - Support for VectorAffineFunction in TableSet/AllDifferentSet 
-  - i.e `[x[i]+i for i in 1:n] in CS.AllDifferentSet()` 
+  - i.e `[x[i]+i for i in 1:n] in CS.AllDifferent()` 
   - `[x,y,10] in CS.TableSet(...)`
   - see [issue #235](https://github.com/Wikunia/ConstraintSolver.jl/issues/235) for in-depth examples  
 
@@ -32,11 +37,11 @@
 - Bugfix in reified `still_feasible` when setting to inactive
 - Bugfix in alldifferent constraint when there is a gap in the values
 - Support for `And` constraints in the inner constraints of `Indicator` and `Reified`:
-    i.e `b := { sum(x) >= 10 && x in CS.AllDifferentSet() }`
+    i.e `b := { sum(x) >= 10 && x in CS.AllDifferent() }`
 - Support for `Or` constraints in the inner constraints of `Indicator` and `Reified`:
-    i.e `b := { sum(x) >= 10 || x in CS.AllDifferentSet() }`
+    i.e `b := { sum(x) >= 10 || x in CS.AllDifferent() }`
 - Support for `&&` and `||` outside of `Indicator` and `Reified`
-  - i.e `sum(x) >= 10 || x in CS.AllDifferentSet()`
+  - i.e `sum(x) >= 10 || x in CS.AllDifferent()`
 - Basic support for `Indicator` inside of reified:
   - i.e `@constraint(model, b1 := {b2 => { v == 1 }})`
   - currently lacks support for bridges such that `v > 1` in the inner constraint will fail
@@ -120,17 +125,17 @@
 ## v0.1.7 (22nd of May 2020)
 - Better feasibility and pruning in `==`
 - **Bugfixes:**
-  - Correct set of change ptr in `EqualSet` for faster/correct pruning
+  - Correct set of change ptr in `AllEqual` for faster/correct pruning
   - Call to `isapprox_discrete` in `eq_sum`
   - Fixed threshold rounding
 
 ## v0.1.6 (11th of May 2020)
 - Reduction of memory allocations in `TableConstraint`
-- Pruning in `EqualSet`
+- Pruning in `AllEqual`
 
 ## v0.1.5 (6th of May 2020)
 - **Bugfixes:**
-  - EqualSet feasibility: Check if other vars have value + no memory allocation
+  - AllEqual feasibility: Check if other vars have value + no memory allocation
   - Call `call_finished_pruning!(com)` after second `prune!` before backtracking
 
 ## v0.1.4 (6th of May 2020)

Project.toml

@@ -1,9 +1,10 @@
 name = "ConstraintSolver"
 uuid = "e0e52ebd-5523-408d-9ca3-7641f1cd1405"
 authors = ["Ole Kröger <[email protected]>"]
-version = "0.6.10"
+version = "0.7.0"
 
 [deps]
+ConstraintProgrammingExtensions = "b65d079e-ed98-51d9-b0db-edee61a5c5f8"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Formatting = "59287772-0a20-5a39-b81b-1366585eb4c0"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
@@ -17,6 +18,7 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 StatsFuns = "4c63d2b9-4356-54db-8cca-17b64c39e42c"
 
 [compat]
+ConstraintProgrammingExtensions = "^0.3"
 DataStructures = "~0.11, ~0.12, ~0.13, ~0.14, ~0.15, ~0.16, ~0.17, ~0.18"
 Formatting = "^0.4.1"
 JSON = "~0.18, ~0.19, ~0.20, ~0.21"

README.md

@@ -53,13 +53,13 @@ for r=1:9, c=1:9
 end
 
 for rc = 1:9
-    @constraint(m, x[rc,:] in CS.AllDifferentSet())
-    @constraint(m, x[:,rc] in CS.AllDifferentSet())
+    @constraint(m, x[rc,:] in CS.AllDifferent())
+    @constraint(m, x[:,rc] in CS.AllDifferent())
 end
 
 for br=0:2
     for bc=0:2
-        @constraint(m, vec(x[br*3+1:(br+1)*3,bc*3+1:(bc+1)*3]) in CS.AllDifferentSet())
+        @constraint(m, vec(x[br*3+1:(br+1)*3,bc*3+1:(bc+1)*3]) in CS.AllDifferent())
     end
 end
 

benchmark/eternity/benchmark.jl

@@ -73,7 +73,7 @@ function solve_eternity(
         @variable(m, b[1:height, 1:width], Bin)
     end
 
-    @constraint(m, p[:] in CS.AllDifferentSet())
+    @constraint(m, p[:] in CS.AllDifferent())
     for i in 1:height, j in 1:width
         if indicator
             @constraint(

benchmark/eternity/cs.jl

@@ -46,7 +46,7 @@ function main(pname; time_limit = 1800)
     @variable(m, 0 <= pd[1:height, 1:width] <= ncolors, Int)
     @variable(m, 0 <= pl[1:height, 1:width] <= ncolors, Int)
 
-    @constraint(m, p[:] in CS.AllDifferentSet())
+    @constraint(m, p[:] in CS.AllDifferent())
     for i in 1:height, j in 1:width
         @constraint(
             m,

benchmark/graph_color/benchmark.jl

@@ -166,10 +166,10 @@ function solve_us_graph_coloring(; num_colors = 8, equality = false, branch_stra
     @constraint(m, south_carolina != georgia)
     @constraint(m, georgia != florida)
 
-    # test for EqualSet constraint
+    # test for AllEqual constraint
     if equality
-        @constraint(m, [california, new_york, florida] in CS.EqualSet())
-        @constraint(m, [maryland, alabama, wisconsin, south_carolina] in CS.EqualSet())
+        @constraint(m, [california, new_york, florida] in CS.AllEqual())
+        @constraint(m, [maryland, alabama, wisconsin, south_carolina] in CS.AllEqual())
     end
 
     @constraint(m, max_color .>= states)

benchmark/killer_sudoku/benchmark.jl

@@ -34,7 +34,7 @@ function solve_killer_sudoku(filename; special = false, branch_strategy=:Auto)
             MOI.add_constraint(
                 m,
                 [x[ind[1]][ind[2]][1] for ind in s.indices],
-                CS.AllDifferentSetInternal(length(s.indices)),
+                CS.CPE.AllDifferent(length(s.indices)),
             )
         end
     end
@@ -44,14 +44,14 @@ function solve_killer_sudoku(filename; special = false, branch_strategy=:Auto)
         MOI.add_constraint(
             m,
             MOI.VectorOfVariables([x[r][c][1] for c in 1:9]),
-            CS.AllDifferentSetInternal(9),
+            CS.CPE.AllDifferent(9),
         )
     end
     for c in 1:9
         MOI.add_constraint(
             m,
             MOI.VectorOfVariables([x[r][c][1] for r in 1:9]),
-            CS.AllDifferentSetInternal(9),
+            CS.CPE.AllDifferent(9),
         )
     end
     variables = [MOI.VariableIndex(0) for _ in 1:9]
@@ -62,7 +62,7 @@ function solve_killer_sudoku(filename; special = false, branch_strategy=:Auto)
                 variables[variables_i] = x[i][j][1]
                 variables_i += 1
             end
-            MOI.add_constraint(m, variables, CS.AllDifferentSetInternal(9))
+            MOI.add_constraint(m, variables, CS.CPE.AllDifferent(9))
         end
     end
 

benchmark/killer_sudoku/cs.jl

@@ -43,7 +43,7 @@ function solve_all(filenames; benchmark = false, single_times = true)
                 0.0,
             )
             MOI.add_constraint(m, saf, MOI.EqualTo(convert(Float64, s.result)))
-            # MOI.add_constraint(m, [x[ind[1]][ind[2]][1] for ind in s.indices], CS.AllDifferentSetInternal(length(s.indices)))
+            # MOI.add_constraint(m, [x[ind[1]][ind[2]][1] for ind in s.indices], CS.CPE.AllDifferent(length(s.indices)))
         end
 
         # sudoku constraints

benchmark/sudoku/benchmark.jl

@@ -42,14 +42,14 @@ function solve_sudoku(grid)
         MOI.add_constraint(
             m,
             MOI.VectorOfVariables([x[r][c][1] for c in 1:side_len]),
-            CS.AllDifferentSetInternal(side_len),
+            CS.CPE.AllDifferent(side_len),
         )
     end
     for c in 1:side_len
         MOI.add_constraint(
             m,
             MOI.VectorOfVariables([x[r][c][1] for r in 1:side_len]),
-            CS.AllDifferentSetInternal(side_len),
+            CS.CPE.AllDifferent(side_len),
         )
     end
     variables = [MOI.VariableIndex(0) for _ in 1:side_len]
@@ -60,7 +60,7 @@ function solve_sudoku(grid)
                 variables[variables_i] = x[i][j][1]
                 variables_i += 1
             end
-            MOI.add_constraint(m, variables, CS.AllDifferentSetInternal(side_len))
+            MOI.add_constraint(m, variables, CS.CPE.AllDifferent(side_len))
         end
     end