variable naming in examples, tests

Author: tias

README.md

@@ -40,7 +40,7 @@ given = np.array([
 
 
 # Variables
-puzzle = IntVar(1,9, shape=given.shape)
+puzzle = IntVar(1,9, shape=given.shape, name="puzzle")
 
 constraints = []
 # Constraints on rows and columns
@@ -81,7 +81,7 @@ from cpmpy import *
 import numpy as np
 
 # Construct the model
-s,e,n,d,m,o,r,y = IntVar(0,9, 8)
+s,e,n,d,m,o,r,y = IntVar(0,9, shape=8)
 
 constraint = []
 constraint += [ alldifferent([s,e,n,d,m,o,r,y]) ]
@@ -109,7 +109,7 @@ demands = [8, 10, 7, 12, 4, 4]
 slots = len(demands)
 
 # variables
-x = IntVar(0,sum(demands), slots)
+x = IntVar(0,sum(demands), shape=slots, name="x")
 
 constraint  = [x[i] + x[i+1] >= demands[i] for i in range(0,slots-1)]
 constraint += [x[-1] + x[0] == demands[-1]] # 'around the clock' constraint

examples/bibd.py

@@ -25,7 +25,7 @@
 l = 1
 
 # Variables, incidence matrix
-block = BoolVar(shape=(v,b))
+block = BoolVar(shape=(v,b), name="block")
 
 # Constraints on incidence matrix
 m = Model([

examples/bus_schedule.py

@@ -14,7 +14,7 @@
 slots = len(demands)
 
 # variables
-x = IntVar(0,sum(demands), slots)
+x = IntVar(0,sum(demands), shape=slots, name="x")
 
 constraint  = [x[i] + x[i+1] >= demands[i] for i in range(0,slots-1)]
 constraint += [x[-1] + x[0] == demands[-1]] # 'around the clock' constraint

examples/knapsack.py

@@ -15,7 +15,7 @@
 capacity = np.random.randint(sum(weights)*.2, sum(weights)*.5)
 
 # Construct the model.
-x = BoolVar(n)
+x = BoolVar(shape=n, name="x")
 
 constraint = [ sum(x*weights) <= capacity ]
 objective  = sum(x*values)

examples/mario.py

@@ -24,7 +24,7 @@
 arc_fuel = data['conso'] # arc_fuel[a,b] = fuel from a to b
 
 # s[i] is the house succeeding to the ith house (s[i]=i if not part of the route)
-s = IntVar(0,nHouses-1, shape=nHouses)
+s = IntVar(0,nHouses-1, shape=nHouses, name="s")
 
 cons = []
 # s should be a path, mimic (sub)circuit by connecting end-point back to start

examples/npuzzle.py

@@ -57,17 +57,17 @@ def pos(r,c):
                 valid_table.append([pos(r,c), pos(r+rr,c+cc)])
 
 # Variables
-x = IntVar(0,n-1, shape=(num_sols,n))
+x = IntVar(0,n-1, shape=(num_sols,n), name="x")
 
 # the moves, index in puzzle
-move_from = IntVar(0,n-1, shape=(num_sols)) # is move_to[i-1]...
-move_to = IntVar(0,n-1, shape=(num_sols))
+move_from = IntVar(0,n-1, shape=(num_sols), name="move_from") # is move_to[i-1]
+move_to = IntVar(0,n-1, shape=(num_sols), name="move_to")
 
 # is this row the solution?
-check = BoolVar(shape=num_sols)
+check = BoolVar(shape=num_sols, name="check")
 
 # index of first solution
-check_ix = IntVar(0,num_sols)
+check_ix = IntVar(0,num_sols, name="check_ix")
 
 
 m = Model(minimize=check_ix)

examples/nqueens.py

@@ -17,13 +17,13 @@
 N = 8
 
 # Variables (one per row)
-queens = IntVar(1,N, shape=N)
+queens = IntVar(1,N, shape=N, name="queens")
 
 # Constraints on columns and left/right diagonal
 m = Model([
         alldifferent(queens),
-        alldifferent([queens[i] - i for i in range(N)]),
         alldifferent([queens[i] + i for i in range(N)]),
+        alldifferent([queens[i] - i for i in range(N)]),
     ])
 
 if m.solve():

examples/quickstart_sudoku.ipynb

@@ -77,7 +77,7 @@
    "outputs": [],
    "source": [
     "# Variables\n",
-    "puzzle = IntVar(1, 9, shape=given.shape)"
+    "puzzle = IntVar(1, 9, shape=given.shape, name=\"puzzle\")"
    ]
   },
   {

examples/sudoku.py

@@ -23,7 +23,7 @@
 
 
 # Variables
-puzzle = IntVar(1,9, shape=given.shape)
+puzzle = IntVar(1,9, shape=given.shape, name="puzzle")
 
 constraints = []
 # Constraints on rows and columns

examples/who_killed_agatha.py

@@ -16,14 +16,14 @@
 
 # Who killed agatha?
 victim = agatha
-killer = IntVar(0,2)
+killer = IntVar(0,2, name="killer")
 
 constraint = []
 # A killer always hates, and is no richer than his victim. 
-hates = BoolVar((n,n))
+hates = BoolVar((n,n), name="hates")
 constraint += [ hates[killer, victim] == 1 ]
 
-richer = BoolVar((n,n))
+richer = BoolVar((n,n), name="richer")
 constraint += [ richer[killer, victim] == 0 ]
 
 # implied richness: no one richer than himself, and anti-reflexive

tests/test_variables.py

@@ -39,3 +39,13 @@ def test_array_IntVar(self):
                 iv = cp.IntVar(0, i, shape=(i, j))
                 self.assertEqual(iv.shape, (i,j), "Shape should be equal size")
                 self.assertIsInstance(iv, cp.NDVarArray, f"Instance not {cp.NDVarArray} got {type(iv)}")
+
+    def test_namevar(self):
+        a = cp.BoolVar(name="a")
+        self.assertEqual(str(a), "a")
+
+        b = cp.BoolVar(shape=(3,), name="b")
+        self.assertEqual(str(b), "[b[0] b[1] b[2]]")
+
+        c = cp.BoolVar(shape=(2,3), name="c")
+        self.assertEqual(str(c), "[[c[0,0] c[0,1] c[0,2]]\n [c[1,0] c[1,1] c[1,2]]]")