gecoder 0.6.0 → 0.6.1

data/CHANGES

@@ -1,3 +1,11 @@
+== Version 0.6.1
+This release fixes various bugs introduced in 0.6.0 and changes the way that
+int variable domains are specified (breaking backward-compatibility).
+
+* The domain for int variables can no longer be specified as several individual elements, it has to be specified as either a single element, a range or another enumeration.
+* Fixed a bug with set cardinality, min and max constraints using composite sugar.
+* Variables can now be created inside the optimization block.
+
 == Version 0.6.0
 This release adds most of the remaining set constraints. It also makes 
 backward-compatibility breaking changes to the way that properties of variables
@@ -9,7 +17,7 @@ are accessed.
 * Added include (match) constraint for sets.
 * Added distinct constraints (distinct and at most one) for sets.
 * Added branch and bound search (optimization search). It's quite shaky at the moment though.
-* Assigned values of variables are now always accessed using #value instread of the various previous methods. The methods for extracting information from set variables have been changed and renamed.
+* Assigned values of variables are now always accessed using #value instead of the various previous methods. The methods for extracting information from set variables have been changed and renamed.
 * Enumerations containing variables now provide a convenience method #values which returns an array of the enum's values.
 
 == Version 0.5.0

data/Rakefile

@@ -8,3 +8,6 @@ task :default => [:verify_rcov]
 
 desc 'Performs the tasks necessary when releasing'
 task :release => [:publish_website, :publish_packages, :tag]
+
+desc 'Runs all the tests'
+task :test => :specs

data/example/send_most_money.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/example_helper'
+
+# Solves the cryptarithmetic send+most=money problem while maximizing the value
+# of "money".
+class SendMoreMoney < Gecode::Model
+  attr :money
+
+  def initialize
+    # Set up the variables, 9 letters with domain 0..9.
+    s,e,n,d,m,o,s,t,y = @letters = int_var_array(9, 0..9)
+    @money = wrap_enum([m,o,n,e,y])
+    
+    # Set up the constraints.
+    # The equation must hold.
+    (equation_row(s, e, n, d) + equation_row(m, o, s, t)).must == 
+      equation_row(m,o,n,e,y) 
+    
+    # The initial letters may not be 0.
+    s.must_not == 0
+    m.must_not == 0
+    
+    # All letters must be assigned different digits.
+    @letters.must_be.distinct
+
+    # Set the branching.
+    branch_on @letters, :variable => :smallest_size, :value => :min
+  end
+
+  def to_s
+    %w{s e n d m o s t y}.zip(@letters).map do |text, letter|
+      "#{text}: #{letter.value}" 
+    end.join(', ')
+  end
+  
+  private
+
+  # A helper to make the linear equation a bit tidier. Takes a number of
+  # variables and computes the linear combination as if the variable
+  # were digits in a base 10 number. E.g. x,y,z becomes
+  # 100*x + 10*y + z .
+  def equation_row(*variables)
+    variables.to_number
+  end
+end
+
+class Array
+  # Computes a number of the specified base using the array's elements as 
+  # digits.
+  def to_number(base = 10)
+    inject{ |result, variable| variable + result * base }
+  end
+end
+
+solution = SendMoreMoney.new.optimize! do |model, best_so_far|
+  model.money.to_number.must > best_so_far.money.values.to_number
+end
+puts solution.to_s
+puts "money: #{solution.money.values.to_number}"

data/ext/missing.cpp

@@ -194,12 +194,37 @@ void MSpace::own(Gecode::MSetVarArray *sva, const char *name)
 	d->setArrays[name] = sva;
 }
 
+void MSpace::gc_mark()
+{
+  {
+		IntVarArrays::iterator it, eend = d->intArrays.end();
+		for(it = d->intArrays.begin(); it != eend; it++)
+		{
+			rb_gc_mark(Rust_gecode::cxx2ruby((*it).second));
+		}
+	}
+	{
+		BoolVarArrays::iterator it, eend = d->boolArrays.end();
+		for(it = d->boolArrays.begin(); it != eend; it++)
+		{
+			rb_gc_mark(Rust_gecode::cxx2ruby((*it).second));
+		}
+	}
+	{
+		SetVarArrays::iterator it, eend = d->setArrays.end();
+		for(it = d->setArrays.begin(); it != eend; it++)
+		{
+			rb_gc_mark(Rust_gecode::cxx2ruby((*it).second));
+		}
+	}
+}
+
 // For BAB.
 void MSpace::constrain(MSpace* s)
 {
   // Call Ruby's constrain.
   rb_funcall(Rust_gecode::cxx2ruby(this), rb_intern("constrain"), 1,
-    Rust_gecode::cxx2ruby(s)); 
+    Rust_gecode::cxx2ruby(s, false)); 
 }
 
 Gecode::MIntVarArray *MSpace::intVarArray(const char *name) const

data/ext/missing.h

@@ -61,6 +61,8 @@ class MSpace : public Space
 		void own(Gecode::MBoolVarArray *bva, const char *name);
 		void own(Gecode::MSetVarArray *sva, const char *name);
 		
+		void gc_mark();
+		
 		void constrain(MSpace* s);
 		
 		Gecode::MIntVarArray *intVarArray(const char *name ) const;

data/ext/vararray.cpp

@@ -18,6 +18,7 @@
 **/
 
 #include "vararray.h"
+#include "gecode.hh"
 
 namespace Gecode {
 
@@ -74,7 +75,6 @@ MIntVarArray::MIntVarArray() : d(new Private)
 MIntVarArray::MIntVarArray(const Gecode::IntVarArray &arr) : d(new Private)
 {
 	setArray(arr);
-	setCount(0);
 }
 
 MIntVarArray::MIntVarArray (Space *home, int n) : d(new Private)
@@ -107,7 +107,7 @@ void MIntVarArray::setArray(const Gecode::IntVarArray &arr)
 void MIntVarArray::enlargeArray(Gecode::Space *parent, int n)
 {
 	Gecode::IntVarArray na(parent, size()+n, 0, 0);
-	for(int i = count(); i--; )
+	for(int i = size(); i--; )
 		na[i] = d->array[i];
 	
 	d->array = na;
@@ -130,6 +130,13 @@ IntVar &MIntVarArray::operator [](int index)
 	return d->array[index];
 }
 
+void MIntVarArray::gc_mark()
+{
+  for(int i = size(); i--; ) {
+		rb_gc_mark(Rust_gecode::cxx2ruby(&(d->array[i])));
+	}
+}
+
 void MIntVarArray::debug() const
 {
 	for(int i = 0; i < d->array.size(); i++)
@@ -150,14 +157,14 @@ struct MBoolVarArray::Private
 
 MBoolVarArray::MBoolVarArray() : d(new Private)
 {
+	setArray(Gecode::BoolVarArray());
 }
 
 MBoolVarArray::MBoolVarArray(const Gecode::BoolVarArray &arr) : d(new Private)
 {
-	d->array = arr;
-	setSize(arr.size());
-	setCount(0);
+	setArray(arr);
 }
+
 MBoolVarArray::MBoolVarArray (Space *home, int n) : d(new Private)
 {
 	setArray(Gecode::BoolVarArray(home, n));
@@ -177,7 +184,7 @@ void MBoolVarArray::setArray(const Gecode::BoolVarArray &arr)
 void MBoolVarArray::enlargeArray(Gecode::Space *parent, int n)
 {
 	Gecode::BoolVarArray na(parent, size()+n, 0, 0);
-	for(int i = count(); i--; )
+	for(int i = size(); i--; )
 		na[i] = d->array[i];
 	
 	d->array = na;
@@ -200,6 +207,13 @@ Gecode::BoolVar &MBoolVarArray::operator[](int index)
 	return d->array[index];
 }
 
+void MBoolVarArray::gc_mark()
+{
+  for(int i = size(); i--; ) {
+		rb_gc_mark(Rust_gecode::cxx2ruby(&(d->array[i])));
+	}
+}
+
 void MBoolVarArray::debug() const
 {
 	for(int i = 0; i < d->array.size(); i++)
@@ -219,13 +233,12 @@ struct MSetVarArray::Private
 
 MSetVarArray::MSetVarArray() : d(new Private)
 {
+	setArray(Gecode::SetVarArray());
 }
 
 MSetVarArray::MSetVarArray(const Gecode::SetVarArray &arr) : d(new Private)
 {
-	d->array = arr;
-	setSize(arr.size());
-	setCount(0);
+	setArray(arr);
 }
 
 MSetVarArray::MSetVarArray(Space *home, int n) : d(new Private)
@@ -266,8 +279,8 @@ void MSetVarArray::setArray(const Gecode::SetVarArray &arr)
 
 void MSetVarArray::enlargeArray(Gecode::Space *parent, int n)
 {
-	Gecode::SetVarArray na(parent, size()*n);
-	for (int i = count(); i--; )
+	Gecode::SetVarArray na(parent, size()+n);
+	for (int i = size(); i--; )
 		na[i] = d->array[i];
 	
 	d->array = na;
@@ -290,6 +303,13 @@ Gecode::SetVar &MSetVarArray::operator[](int index)
 	return d->array[index];
 }
 
+void MSetVarArray::gc_mark()
+{
+  for(int i = size(); i--; ) {
+		rb_gc_mark(Rust_gecode::cxx2ruby(&(d->array[i])));
+	}
+}
+
 void MSetVarArray::debug() const
 {
 	for(int i = 0; i < d->array.size(); i++)

data/ext/vararray.h

@@ -65,6 +65,8 @@ class MIntVarArray : public MVarArray
 		
 		void debug() const;
 		
+		void gc_mark();
+		
 		IntVar &operator [](int index);
 		
 	private:
@@ -93,6 +95,8 @@ class MBoolVarArray : public MVarArray
 		
 		void debug() const;
 		
+		void gc_mark();
+		
 	private:
 		struct Private;
 		Private *const d;
@@ -131,6 +135,8 @@ class MSetVarArray : public MVarArray
 		
 		void debug() const;
 		
+		void gc_mark();
+		
 	private:
 		struct Private;
 		Private *const d;

data/lib/gecoder/bindings.rb

@@ -3,11 +3,6 @@ module Gecode
   # The Gecode::Raw module is what the interface should use to access methods
   # in Gecode. The actual bindings are located in ::GecodeRaw.
   
-  # We just make Gecode::Raw an alias of the real module.
-  Raw = ::GecodeRaw
-  # Log all calls via Gecode::Raw.
-  #Raw = ::LoggingLayer
-  
   # Describes a layer that delegates to GecodeRaw only after having logged the 
   # call.
   module LoggingLayer
@@ -31,4 +26,9 @@ module Gecode
       @logger
     end
   end
+  
+  # We just make Gecode::Raw an alias of the real module.
+  Raw = ::GecodeRaw
+  # Log all calls via Gecode::Raw.
+  #Raw = LoggingLayer
 end

data/lib/gecoder/bindings/bindings.rb

@@ -48,6 +48,28 @@ Gecode::IntArgs ruby2Gecode_IntArgs(VALUE arr, int argn)
 }
 @
 
+custom_mark_definitions =<<-"end_custom_definition"
+  static void Gecode_MSpace_custom_mark(void *p) {
+    Gecode_MSpace_mark(p);
+    ((Gecode::MSpace*)p)->gc_mark();
+  }
+  
+  static void Gecode_MIntVarArray_custom_mark(void *p) {
+    Gecode_MIntVarArray_mark(p);
+    ((Gecode::MIntVarArray*)p)->gc_mark();
+  }
+  
+  static void Gecode_MBoolVarArray_custom_mark(void *p) {
+    Gecode_MBoolVarArray_mark(p);
+    ((Gecode::MBoolVarArray*)p)->gc_mark();
+  }
+  
+  static void Gecode_MSetVarArray_custom_mark(void *p) {
+    Gecode_MSetVarArray_mark(p);
+    ((Gecode::MSetVarArray*)p)->gc_mark();
+  }
+end_custom_definition
+
 
 Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
   b.include_header 'gecode/kernel.hh', Rust::Bindings::HeaderGlobal
@@ -57,6 +79,7 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
   b.include_header 'missing.h', Rust::Bindings::HeaderLocal
   
   b.add_custom_definition ruby2intargs
+  b.add_custom_definition custom_mark_definitions
   
   # Is it possible to use namespaces with multiple levels in Rust? I.e. use
   # Gecode::Raw instead of GecodeRaw here (and avoid the hidious renaming)
@@ -146,6 +169,8 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
     
     ns.add_cxx_class "MIntVarArray" do |klass|
       klass.bindname = "IntVarArray"
+      klass.function_mark = 'Gecode_MIntVarArray_custom_mark'
+      
       klass.add_constructor
       klass.add_constructor do |func|
         func.add_parameter "Gecode::MSpace *", "home"
@@ -178,6 +203,11 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
         method.add_parameter "Gecode::IntVar", "val"
       end
       
+      klass.add_method "enlargeArray" do |method|
+        method.add_parameter "Gecode::MSpace *", "home"
+        method.add_parameter "int", "n"
+      end
+      
       klass.add_method "size", "int"
       
       klass.add_method "debug"
@@ -187,6 +217,8 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
     
     ns.add_cxx_class "MBoolVarArray" do |klass|
       klass.bindname = "BoolVarArray"
+      klass.function_mark = 'Gecode_MBoolVarArray_custom_mark'
+      
       klass.add_constructor
       klass.add_constructor do |func|
         func.add_parameter "Gecode::MSpace *", "home"
@@ -206,6 +238,11 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
         method.add_parameter "Gecode::BoolVar", "val"
       end
       
+      klass.add_method "enlargeArray" do |method|
+        method.add_parameter "Gecode::MSpace *", "home"
+        method.add_parameter "int", "n"
+      end
+      
       klass.add_method "size", "int"
       
       klass.add_method "debug"
@@ -214,6 +251,8 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
     
     ns.add_cxx_class "MSetVarArray" do |klass|
       klass.bindname = "SetVarArray"
+      klass.function_mark = 'Gecode_MSetVarArray_custom_mark'
+      
       klass.add_constructor
       
       klass.add_constructor do |method|
@@ -274,6 +313,11 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
         method.add_parameter "Gecode::SetVar", "val"
       end
       
+      klass.add_method "enlargeArray" do |method|
+        method.add_parameter "Gecode::MSpace *", "home"
+        method.add_parameter "int", "n"
+      end
+      
       klass.add_method "size", "int"
       
       klass.add_method "debug"
@@ -288,6 +332,7 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
     
     ns.add_cxx_class "MSpace" do |klass|
       klass.bindname = "Space"
+      klass.function_mark = 'Gecode_MSpace_custom_mark'
       
       klass.add_constructor
       
@@ -1429,6 +1474,13 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
 # 			func.add_parameter "Gecode::IntConLevel", "icl", true
 # 		end
     
+    ns.add_function "bab", "Gecode::MSpace*" do |func|
+      func.add_parameter "Gecode::MSpace*", "home"
+      func.add_parameter "int", "c_d"
+      func.add_parameter "int", "a_d"
+      func.add_parameter "Gecode::Search::MStop *", "st"
+    end
+    
     ns.add_function "rel" do |func|
       func.add_parameter "Gecode::MSpace*", "home"
       func.add_parameter "Gecode::IntVar", "x0"

data/lib/gecoder/interface/binding_changes.rb

@@ -52,31 +52,40 @@ module GecodeRaw
       Gecode::Model.constrain(self, best_so_far_space)
     end
     
+    # Refreshes the underlying stores used by the space.
+    def refresh
+      @int_var_store = nil
+      @bool_var_store = nil
+      @set_var_store = nil
+    end
+    
     private
     
     # Retrieves the store used for integer variables. Creates one if none
     # exists.
     def int_var_store
-      if @int_var_store.nil?
+      # TODO: caching interferes with the variable creation during BAB-search,
+      # find out why.
+      #if @int_var_store.nil?
         @int_var_store = Gecode::Util::IntVarStore.new(self) 
-      end
+      #end
       return @int_var_store
     end
     
     # Retrieves the store used for boolean variables. Creates one if none
     # exists.
     def bool_var_store
-      if @bool_var_store.nil?
+      #if @bool_var_store.nil?
         @bool_var_store = Gecode::Util::BoolVarStore.new(self) 
-      end
+      #end
       return @bool_var_store
     end
     
     # Retrieves the store used for set variables. Creates one if none exists.
     def set_var_store
-      if @set_var_store.nil?
+      #if @set_var_store.nil?
         @set_var_store = Gecode::Util::SetVarStore.new(self) 
-      end
+      #end
       return @set_var_store
     end
   end
@@ -100,11 +109,7 @@ module Gecode
       
       # Grows the store to the new size.
       def grow(new_size)
-        new_array = new_storage_array(new_size)
-        @var_array.size.times do |i|
-          new_array[i] = @var_array[i]
-        end
-        @var_array = new_array
+        @var_array.enlargeArray(@space, new_size - @size)
         @size = new_size
       end
     end