gecoder 0.9.0 → 0.9.1

data/CHANGES

@@ -1,3 +1,9 @@
+== Version 0.9.1
+This release changes the preferred way of defining a model to including Gecode::Mixin (a mixin) rather than inheriting from Gecode::Model. The backend has also been updated to fix some rare bugs.
+
+* Added Gecode::Mixin which can be mixed in rather than inheriting from Gecode::Model. Thanks to Adam Rose for the suggestion.
+* Updated the backend to Gecode 2.2.0. See http://www.gecode.org/gecode-doc-latest/PageChanges_2_2_0.html for a list of changes.
+
 == Version 0.9.0
 This release adds a generous amount of sugar designed to cut down on often 
 repeated code. It also adds the ability to freely combine constraints

data/README

@@ -17,7 +17,7 @@ people to play with it and give feedback.
 
 == Installation
 
-Gecode/R requires Gecode 2.1.1, which can be downloaded from 
+Gecode/R requires Gecode 2.2.0, which can be downloaded from 
 http://www.gecode.org/download.html . See 
 http://www.gecode.org/gecode-doc-latest/PageComp.html for the installation
 instructions.

data/THANKS

@@ -0,0 +1,18 @@
+A list of people who have contributed to making Gecode/R what it is
+today.  Sorted in alphabetical order by last name.
+
+* David Cuadrado - For the initial raw bindings from Gecode to Ruby.
+* Eivind Eklund - For the idea that led to the syntax used to specify 
+  the regular expressions used in regexp constraints.
+* Google and Ruby Central - For the funding through Google Summer of 
+  Code 2007 that got the project started.
+* James Edward Gray II - For the superb mentoring during Google Summer 
+  of Code 2007, influencing many decisions made.
+* Mikael Lagerkvist - For the support from the Gecode side.
+* Andreas Launila - For the interface on top of the raw bindings and 
+  the website.
+* Adam Rose - For suggesting that Gecode/R should use a mixin rather 
+  than inheritance.
+
+If you think that you should be on this list then please contact the 
+gecoder-devel mailing list.

data/example/equation_system.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/example_helper'
 
-class EquationProblem < Gecode::Model
+class EquationProblem
+  include Gecode::Mixin
+
   def initialize
     x, y, z = vars_is_an int_var_array(3, 0..9)
 

data/example/magic_sequence.rb

@@ -1,7 +1,9 @@
 require File.dirname(__FILE__) + '/example_helper'
 
 # Solves the magic sequence problem.
-class MagicSequence < Gecode::Model
+class MagicSequence
+  include Gecode::Mixin
+
   # n is the length of the sequence.
   def initialize(n)
     # The i:th variable represents the value of the i:th element in the 

data/example/queens.rb

@@ -2,7 +2,9 @@ require File.dirname(__FILE__) + '/example_helper'
 
 # Solves the n-queens problem: http://en.wikipedia.org/wiki/Nqueens . No attempt
 # to break the involved symmetries is made.
-class NQueens < Gecode::Model
+class NQueens
+  include Gecode::Mixin
+
   def initialize(n)
     @size = n
   

data/example/send_more_money.rb

@@ -2,35 +2,7 @@ require File.dirname(__FILE__) + '/example_helper'
 
 # Solves the send+more=money problem: 
 # http://en.wikipedia.org/wiki/Send%2Bmore%3Dmoney
-class SendMoreMoney < Gecode::Model
-  def initialize
-    # Set up the variables, 8 letters with domain 0..9.
-    s,e,n,d,m,o,r,y = @letters = int_var_array(8, 0..9)
-
-    # Set up the constraints.
-    # The equation must hold.
-    (equation_row(s, e, n, d) + equation_row(m, o, r, e)).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 r y}.zip(@letters).map do |text, letter|
-      "#{text}: #{letter.value}" 
-    end.join(', ')
-  end
-
-  private
-
+solution = Gecode.solve do
   # 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
@@ -38,6 +10,28 @@ class SendMoreMoney < Gecode::Model
   def equation_row(*variables)
     variables.inject{ |result, variable| variable + result*10 }
   end
+
+  # Set up the variables. 
+  # Let "letters" be an array of 8 integer variables with domain 0..9.
+  # The elements represents the letters s, e, n, d, m, o, r and y.
+  letters_is_an int_var_array(8, 0..9)
+  s,e,n,d,m,o,r,y = letters
+
+  # Set up the constraints.
+  # The equation must hold.
+  (equation_row(s, e, n, d) + equation_row(m, o, r, e)).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
+
+  # Tell Gecode what variables we want to know the values of.
+  branch_on letters, :variable => :smallest_size, :value => :min
 end
 
-puts SendMoreMoney.new.solve!.to_s
+puts 's e n d m o r y'
+puts solution.letters.values.join(' ')

data/example/send_most_money.rb

@@ -2,36 +2,34 @@ require File.dirname(__FILE__) + '/example_helper'
 
 # Solves the cryptarithmetic send+most=money problem while maximizing the value
 # of "money".
-class SendMoreMoney < Gecode::Model
+class SendMostMoney
+  include Gecode::Mixin
+
   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])
+    s,e,n,d,m,o,s,t,y = letters_is_an int_var_array(9, 0..9)
+    # Express the quantity we are optimizing, in this case money.
+    # This utilises that any operand can be converted into a variable.
+    @money = equation_row(m,o,n,e,y).to_int_var
     
     # 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) 
+      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
+    letters.must_be.distinct
 
     # Set the branching.
-    branch_on @letters, :variable => :smallest_size, :value => :min
+    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
@@ -39,20 +37,11 @@ class SendMoreMoney < Gecode::Model
   # 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 }
+    variables.inject{ |result, variable| variable + result * 10 }
   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}"
+solution = SendMostMoney.new.maximize! :money
+puts 's e n d m o s t y'
+puts solution.letters.values.join(' ')
+puts "money: #{solution.money.value}"

data/example/square_tiling.rb

@@ -2,7 +2,9 @@ require File.dirname(__FILE__) + '/example_helper'
 
 # Solves the square tiling problem. The objective is to pack supplied squares 
 # into a bigger rectangle so that there is no overlap.
-class SquareTiling < Gecode::Model
+class SquareTiling
+  include Gecode::Mixin
+
   # Takes the width and height of the rectangle to pack the squares into. Then
   # the sizes of the squares that should be packed into the rectangle. The sizes
   # must be sorted.

data/example/sudoku-set.rb

@@ -4,7 +4,9 @@ require 'enumerator'
 # Solves the sudoku problem using sets. The model used is a fairly direct 
 # translation of the corresponding Gecode example: 
 # http://www.gecode.org/gecode-doc-latest/sudoku-set_8cc-source.html .
-class SudokuSet < Gecode::Model
+class SudokuSet
+  include Gecode::Mixin
+
   # Takes a 9x9 matrix of values in the initial sudoku, 0 if the square is 
   # empty. 
   def initialize(predefined_values)

data/lib/gecoder/bindings.rb

@@ -1,6 +1,6 @@
 # Problems can be formulated and solved either through defining a new
-# class that inherits from Gecode::Model or by using Gecode#solve et al.
-# Gecode::Model describes how to formulate problems.
+# class that mixes in Gecode::Mixin or by using Gecode.solve et al.
+# Gecode::Mixin describes how to formulate problems.
 #
 # ==== Examples 
 #
@@ -12,9 +12,11 @@
 #   x = y - 3
 #   0 <= x,y,z <= 9
 #
-# === Inheriting from Gecode::Model
+# === Mixing in Gecode::Mixin
+#
+#   class EquationProblem 
+#     include Gecode::Mixin
 #
-#   class EquationProblem < Gecode::Model
 #     def initialize
 #       variables_is_an int_var_array(3, 0..9)
 #       x, y, z = variables
@@ -27,7 +29,7 @@
 #   end
 #   puts EquationProblem.new.solve!.variables.join(' ')
 #
-# === Using Gecode#solve
+# === Using Gecode.solve
 #
 #   solution = Gecode.solve do
 #     variables_is_an int_var_array(3, 0..9)

data/lib/gecoder/bindings/bindings.rb

@@ -1966,7 +1966,7 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
       func.add_parameter "Gecode::BoolVar", "b"
     end
     
-    ns.add_function "selectUnion" do |func|
+    ns.add_function "elementsUnion" do |func|
       func.add_parameter "Gecode::MSpace*", "home"
       func.add_parameter "Gecode::MSetVarArray", "x" do |param|
         param.custom_conversion = "*ruby2Gecode_MSetVarArrayPtr(x, 2)->ptr()"
@@ -1975,35 +1975,35 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
       func.add_parameter "Gecode::SetVar", "z"
     end
     
-    ns.add_function "selectInter" do |func|
+    ns.add_function "elementsInter" do |func|
       func.add_parameter "Gecode::MSpace*", "home"
       func.add_parameter "Gecode::MSetVarArray", "x" do |param|
-        param.custom_conversion = "*ruby2Gecode_MSetVarArrayPtr(x, 2)->ptr()"
+        param.custom_conversion = "*ruby2Gecode_MSetVarArrayPtr(argv[1], 2)->ptr()"
       end
       func.add_parameter "Gecode::SetVar", "y"
       func.add_parameter "Gecode::SetVar", "z"
     end
     
-    ns.add_function "selectInterIn" do |func|
+    ns.add_function "elementsInter" do |func|
       func.add_parameter "Gecode::MSpace*", "home"
       func.add_parameter "Gecode::MSetVarArray", "x" do |param|
-        param.custom_conversion = "*ruby2Gecode_MSetVarArrayPtr(x, 2)->ptr()"
+        param.custom_conversion = "*ruby2Gecode_MSetVarArrayPtr(argv[1], 2)->ptr()"
       end
       func.add_parameter "Gecode::SetVar", "y"
       func.add_parameter "Gecode::SetVar", "z"
       func.add_parameter "Gecode::IntSet", "universe"
     end
     
-    ns.add_function "selectSet" do |func|
+    ns.add_function "element" do |func|
       func.add_parameter "Gecode::MSpace*", "home"
       func.add_parameter "Gecode::MSetVarArray", "x" do |param|
-        param.custom_conversion = "*ruby2Gecode_MSetVarArrayPtr(x, 2)->ptr()"
+        param.custom_conversion = "*ruby2Gecode_MSetVarArrayPtr(argv[1], 2)->ptr()"
       end
       func.add_parameter "Gecode::IntVar", "y"
       func.add_parameter "Gecode::SetVar", "z"
     end
     
-    ns.add_function "selectDisjoint" do |func|
+    ns.add_function "elementsDisjoint" do |func|
       func.add_parameter "Gecode::MSpace*", "home"
       func.add_parameter "Gecode::MSetVarArray", "x" do |param|
         param.custom_conversion = "*ruby2Gecode_MSetVarArrayPtr(x, 2)->ptr()"

data/lib/gecoder/interface.rb

@@ -1,9 +1,11 @@
 require 'gecoder/interface/binding_changes'
 require 'gecoder/interface/enum_matrix'
-require 'gecoder/interface/model'
+require 'gecoder/interface/mixin'
+require 'gecoder/interface/mixin'
+require 'gecoder/interface/mixin'
 require 'gecoder/interface/search'
 require 'gecoder/interface/constraints'
 require 'gecoder/interface/variables'
 require 'gecoder/interface/enum_wrapper'
 require 'gecoder/interface/branch'
-require 'gecoder/interface/model_sugar'
+require 'gecoder/interface/convenience'

data/lib/gecoder/interface/binding_changes.rb

@@ -3,7 +3,7 @@ module GecodeRaw #:nodoc: all
   class Space
     # Used by Gecode during BAB-search.
     def constrain(best_so_far_space)
-      Gecode::Model.constrain(self, best_so_far_space)
+      Gecode::Mixin.constrain(self, best_so_far_space)
     end
   end
 end

data/lib/gecoder/interface/branch.rb

@@ -1,5 +1,5 @@
 module Gecode
-  class Model
+  module Mixin
     # Specifies which variables that should be branched on (given as an
     # enum of operands or as a single operand). One can optionally
     # also select which of the variables that should be used first with

data/lib/gecoder/interface/constraints/bool_enum_constraints.rb

@@ -5,19 +5,19 @@ module Gecode::BoolEnum #:nodoc:
   # constraints defined in BoolEnumConstraintReceiver can be placed.
   #
   # Enumerations of boolean operands can be created either by using
-  # Gecode::Model#bool_var_array and Gecode::Model#bool_var_matrix, or
+  # Gecode::Mixin#bool_var_array and Gecode::Mixin#bool_var_matrix, or
   # by wrapping an existing enumeration containing BoolOperand using
-  # Gecode::Model#wrap_enum. The enumerations, no matter how they were
+  # Gecode::Mixin#wrap_enum. The enumerations, no matter how they were
   # created, all respond to the properties defined by BoolEnumOperand.
   #
   # ==== Examples 
   #
   # Produces an array of five boolean operands inside a problem formulation
-  # using Gecode::Model#bool_var_array:
+  # using Gecode::Mixin#bool_var_array:
   #
   #   bool_enum = bool_var_array(5)
   #
-  # Uses Gecode::Model#wrap_enum inside a problem formulation to create
+  # Uses Gecode::Mixin#wrap_enum inside a problem formulation to create
   # a BoolEnumOperand from an existing enumeration containing the
   # boolean operands +bool_operand1+ and +bool_operand2+:
   #

data/lib/gecoder/interface/constraints/bool_var_constraints.rb

@@ -5,14 +5,14 @@ module Gecode::Bool #:nodoc:
   # constraints defined in BoolConstraintReceiver can be placed.
   #
   # Boolean operands can be created either by using
-  # Gecode::Model#bool_var et al, or by using properties that produce
+  # Gecode::Mixin#bool_var et al, or by using properties that produce
   # boolean operands. The operands, no matter how they were created, 
   # all respond to the properties defined by BoolOperand.
   #
   # ==== Examples 
   #
   # Produces a single boolean operand (more specifically a BoolVar)
-  # inside a problem formulation, using Gecode::Model#bool_var:
+  # inside a problem formulation, using Gecode::Mixin#bool_var:
   #
   #   bool_operand = bool_var
   #

data/lib/gecoder/interface/constraints/extensional_regexp.rb

@@ -1,5 +1,5 @@
 module Gecode
-  class Model
+  module Mixin
     # Specifies an integer regexp that matches +regexp+ repeated between
     # +at_least+ and +at_most+ times (inclusive). If +at_most+ is
     # omitted then no upper bound is placed. If both +at_least+ and

data/lib/gecoder/interface/constraints/fixnum_enum_constraints.rb

@@ -6,12 +6,12 @@ module Gecode::FixnumEnum #:nodoc:
   # They typically service as constant arrays or constant sets.
   #
   # The fixnum enumeration operands are created by wrapping an enumeration 
-  # of fixnum Gecode::Model#wrap_enum. The enumerations created that way
+  # of fixnum Gecode::Mixin#wrap_enum. The enumerations created that way
   # all respond to the properties defined by FixnumEnumOperand.
   #
   # ==== Examples 
   #
-  # Uses Gecode::Model#wrap_enum inside a problem formulation to create
+  # Uses Gecode::Mixin#wrap_enum inside a problem formulation to create
   # a FixnumEnumOperand from an existing enumeration of Fixnum:
   #
   #   fixnum_enum = wrap_enum([3, 5, 7])

data/lib/gecoder/interface/constraints/int_enum/extensional.rb

@@ -44,7 +44,7 @@ module Gecode::IntEnum
     # == Regexp syntax
     #
     # The regular expressions are specified using arrays, integers and a
-    # few methods provided by Model. Arrays are used to group the
+    # few methods provided by Mixin. Arrays are used to group the
     # integers in sequences that must be matched. The following array
     # describes a regular expression matching a 1 followed by a 7.
     #
@@ -55,18 +55,18 @@ module Gecode::IntEnum
     #
     #   [[[1], 7]]
     #
-    # A couple of methods provided by Model are used to express patterns 
+    # A couple of methods provided by Mixin are used to express patterns 
     # beyond mere sequences:
     #
-    # [Model#repeat] Used for specifying patterns that include patterns
+    # [Mixin#repeat] Used for specifying patterns that include patterns
     #                that may be repeated a given number of times. The 
     #                number of times to repeat a pattern can be specified 
     #                using a lower and upper bound, but the bounds can be 
     #                omitted to for instance allow an expression to be 
     #                repeated any number of times.
-    # [Model#any]    Used for specifying alternatives.
+    # [Mixin#any]    Used for specifying alternatives.
     # 
-    # Additionally Model#at_least_once and Model#at_most_once are
+    # Additionally Mixin#at_least_once and Mixin#at_most_once are
     # provided as convenience methods.
     #
     # ==== Examples