Changeset 2369

Timestamp:

Feb 17, 2010 8:11:43 PM (10 years ago)

Author:

wehart

Message:

Adding functionality for ordered sets.

Location:

coopr.pyomo/trunk

Files:

• coopr/pyomo/base/sets.py (modified) (11 diffs)
• coopr/pyomo/tests/unit/test_set.py (modified) (2 diffs)
• examples/pyomo/tutorials/set.py (modified) (2 diffs)

coopr.pyomo/trunk/coopr/pyomo/base/sets.py

@@ -18 +18 @@
 import types
 import copy
+import bidict
 
 log = pyutilib.component.core.PluginGlobals.env().log
@@ -70 +71 @@
         self.ordered=False
         self.order=[]
+        self.order_dict = bidict.bidict()
         self.domain=None
         self.dimen = None
@@ -235 +237 @@
               # Using a rule of the form f(z,model) -> element
               #
-              ctr=0
+              ctr=1
               val = self.initialize(ctr,self.model)
               if self.dimen is None:
@@ -288 +290 @@
            raise TypeError, "Cannot clear virtual Set object `"+self.name+"'"
         self.value.clear()
-        self.order=[]
+        self.order_dict=bidict.bidict()
 
     def check_values(self):
@@ -297 +299 @@
         for val in self.value:
           self._verify(val)
-
-    def first(self):
-        if self.virtual:
-           raise TypeError, "Cannot access the first element of virtual set `"+self.name+"'"
-        if len(self.order) > 0:
-           return self.order[0]
-        else:
-           for val in self.value:
-             return val
 
     def add(self, *args):
@@ -319 +312 @@
             self.value.add(tmp)
             if self.ordered:
+               if tmp in self.order_dict:
+                    raise ValueError, "Element "+str(tmp)+" already exists in ordered set "+self.name
                self.order.append(tmp)
+               self.order_dict[tmp:] = len(self.order)
+               
+
           except TypeError:
             raise TypeError, "Problem inserting "+str(tmp)+" into set "+self.name
@@ -328 +326 @@
         """
         if self.virtual:
-           raise KeyError, "Cannot remove element `"+str(element)+"' from virtual set "+str(self.name)
+            raise KeyError, "Cannot remove element `"+str(element)+"' from virtual set "+str(self.name)
         if element not in self.value:
-           raise KeyError, "Cannot remove element `"+str(element)+"' from set "+str(self.name)
+            raise KeyError, "Cannot remove element `"+str(element)+"' from set "+str(self.name)
         self.value.remove(element)
         if self.ordered:
-           self.order.remove(element)
+            id = self.order_dict[element]-1
+            for i in xrange(id+1,len(self.order)):
+                self.order_dict[self.order[i]] = i-1
+            del self.order[id]
 
     def discard(self, element):
@@ -344 +345 @@
            self.order.remove(element)
         self.value.discard(element)
+
+    def first(self):
+        if self.virtual:
+            raise TypeError, "Cannot access the first element of virtual set `"+self.name+"'"
+        return self.member(1)
+
+    def last(self):
+        if self.virtual:
+            raise TypeError, "Cannot access the last element of virtual set `"+self.name+"'"
+        return self.member(-1)
+
+    def __getitem__(self, key):
+        return self.member(key)
+
+    def member(self, key):
+        if self.ordered:
+            return self.order_dict.inv[key]
+        #
+        # If the set is not ordered, then we use the intrinsic ordering imposed by the set.
+        # We convert the set to a list and return the specified value.
+        #
+        if key >= 1:
+            return list(self.value)[key-1]
+        elif key < 0:
+            return list(self.value)[key]
+        else:
+            raise IndexError, "Valid index values for sets are 1 ... len(set) or -1 ... -len(set)"
 
     def ord(self, match_element):
@@ -350 +378 @@
         """
         if self.ordered is False:
-           raise AttributeError, "Cannot invoke ord method for an unordered set!"
-        # linear, but the only way given the current representation/attributes of a set.
-        i=1
-        for element in self.order:
-           if match_element == element:
-              return i
-           i=i+1
-        raise ValueError, "Unknown input element="+str(match_element)+" provided as input to ord() method for set="+str(self.name)
+           raise AttributeError, "Cannot invoke ord() method for unordered set="+str(self.name)
+        try:
+            return self.order[match_element]
+        except IndexError:
+            raise IndexError, "Unknown input element="+str(match_element)+" provided as input to ord() method for set="+str(self.name)
+
+    def next(self, match_element, k=1):
+        return self.order[self.order_dict[element]+k]
+
+    def nextw(self, match_element, k=1):
+        ndx = self.order_dict[match_element]+k
+        total = len(self.order)
+        if ndx > total:
+            ndx -= total
+        if ndx <= 0:
+            ndx += total
+        return self.order.inv[ndx]
+
+    def prev(self, match_element, k=1):
+        return self.next(match_element, k=-k)
+
+    def prevw(self, match_element, k=1):
+        return self.nextw(match_element, k=-k)
 
     def pprint(self, ostream=None):
@@ -383 +426 @@
            else:
               tmp = copy.copy(list(self.value))
-           tmp.sort()
+              tmp.sort()
            print >>ostream, "\t  ",tmp
-
-    def __getitem__(self, key):
-        if not self.ordered:
-           raise IndexError, "Cannot get an item in unordered set "+self.name
-        return self.order[key]
 
     def __len__(self):
@@ -758 +796 @@
              else:
                 rule_list=[]
-                ctr=0
+                ctr=1
                 args = tuple(tmp+[ctr,self.model])
                 val = self.initialize(*args)

coopr.pyomo/trunk/coopr/pyomo/tests/unit/test_set.py

@@ -1525 +1525 @@
         OUTPUT.close()
         def tmp_init(z,model):
-            if z==value(model.n) or z == 10:
+            if z>value(model.n) or z == 11:
                return None
             return z
@@ -1737 +1737 @@
         OUTPUT.close()
         def tmp_init(i,z,model):
-            if z==value(model.n):
+            if z>value(model.n):
                return None
             return z

coopr.pyomo/trunk/examples/pyomo/tutorials/set.py

@@ -172 +172 @@
 # 
 def U_init(z, model):
-    if z==5:
+    if z==6:
        return None
-    if z==0:
+    if z==1:
        return 1
     else:
-       return model.U[z-1]*(z+1)
+       return model.U[z-1]*z
 model.U = Set(ordered=True, initialize=U_init)
 #
@@ -187 +187 @@
 #
 def V_init(i, z, model):
-    if z==5:
+    if z==6:
        return None
     if i==1:
-       if z==0:
+       if z==1:
           return 1
        else:
-          return (z+1)
-    return model.V[i-1][z]+z
+          return z
+    return model.V[i-1][z]+z-1
 model.V = Set(RangeSet(1,4), initialize=V_init, ordered=True)