gecoder 1.0.0 → 1.1.0

data/CHANGES

@@ -1,3 +1,9 @@
+== Version 1.1.0
+This release fixes a compilation error when installing the gecoder-with-gecode gem using GCC 4.4+ .
+
+* Added the :time_limit to Gecode#solve! which can be used to limit the amount of time that the solver is allowed to search for a solution.
+* [#29630] Fixed compilation errors when installing gecoder-with-gecode using GCC 4.4+ .
+
 == Version 1.0.0
 This release represents a commitment to the current syntax.
 
@@ -10,7 +16,7 @@ This release changes the preferred way of defining a model to including Gecode::
 * 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 
+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
 without needing temporary variables.
 
@@ -24,11 +30,11 @@ without needing temporary variables.
 * [#21580] Fixed a bug that caused ranges that use three dots to not be correctly interpreted by the negated integer domain constraint.
 * [#21581] Fixed a bug that caused the abs constraint to prune away valid solutions in some cases.
 
-== Version 0.8.3 
+== Version 0.8.3
 This release adds regular expression constraints, the last channel
 constraint and various minor convenience improvements. It also fixes a
 rather serious bug that occurs when using the latest patchlevels of Ruby
-1.8.6. 
+1.8.6.
 
 * [#20888] Fixed a GC bug causing problems with Ruby 1.8.6 at patchlevels around 230.
 * Boolean constraints can no longer be specified using the form "bool.must == true". Only the "bool.must_be.true" form can now be used.
@@ -39,7 +45,7 @@ rather serious bug that occurs when using the latest patchlevels of Ruby
 * Added integer and boolean regular expression constraints. Thanks goes to Eivind Eklund for providing the idea for the syntax used to specify the regular expressions.
 
 == Version 0.8.2
-This release adds search statistics along with some new arithmetic constraints 
+This release adds search statistics along with some new arithmetic constraints
 and channel constraints between boolean and integer variables.
 
 * Wrapping an enumerable that is already wrapped is no longer allowed.
@@ -49,17 +55,17 @@ and channel constraints between boolean and integer variables.
 * Added channel constraints between enumerations of boolean variables and single integer variables.
 
 == Version 0.8.1
-This release adds tuple constraints along with a couple of minor features. It 
+This release adds tuple constraints along with a couple of minor features. It
 also fixes a bug introduced in the previous version.
 
 * [#19435] Fixed a bug causing inconsistencies during BAB-search. The bug stopped the send+more=money example from working correctly.
 * Fixed the "raw_bindings" and "sudoku-set" examples, which were broken by the 0.8.0 release.
-* Integers can now be used to specify singleton lower and upper bounds when creating set variables. 
+* Integers can now be used to specify singleton lower and upper bounds when creating set variables.
 * Added convenience methods Model#maximize! and Model#minimize! for optimizing single variables.
 * Added tuple constraints for enumerations of integer and boolean variables.
 
 == Version 0.8.0
-This release makes the jump from using Gecode 1.3.1 to using Gecode 2.1.1 . 
+This release makes the jump from using Gecode 1.3.1 to using Gecode 2.1.1 .
 The following changes have been made to the interface as a result of the jump.
 
 * Removed the distinct constraint for sets.
@@ -87,7 +93,7 @@ int variable domains are specified (breaking backward-compatibility).
 * 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 
+This release adds most of the remaining set constraints. It also makes
 backward-compatibility breaking changes to the way that properties of variables
 are accessed.
 
@@ -101,7 +107,7 @@ are accessed.
 * Enumerations containing variables now provide a convenience method #values which returns an array of the enum's values.
 
 == Version 0.5.0
-This release adds set variables and some of their constraints, along with the 
+This release adds set variables and some of their constraints, along with the
 last of the boolean constraints.
 
 * Added exclusive or and implication.
@@ -125,7 +131,7 @@ This release adds most of the integer variable constraints supported by Gecode.
 * Added arithmetic constraints (min, max, abs and variable multiplication).
 
 == Version 0.3.0
-This release fleshes out the existing constraints with things such as 
+This release fleshes out the existing constraints with things such as
 reification and adds boolean variables and their basic constraints.
 
 * The constructor of Gecode::Model no longer has to be called by classes inheriting from it.

data/THANKS

@@ -1,18 +1,19 @@
 This is a list of people who have contributed to making Gecode/R what it
 is today. It is 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 
+* David Cuadrado - Created the initial raw bindings from Gecode to Ruby.
+* Eivind Eklund - Provided 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 
+* Google and Ruby Central - Got the project started with funding through 
+  Google Summer of Code 2007.
+* James Edward Gray II - Provided 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 
+* Hakan Kjellerstrand - Created many new example models.
+* Mikael Lagerkvist - Provided support from the Gecode side.
+* Andreas Launila - Created 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.
+* Adam Rose - Suggested 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/minesweeper.rb

@@ -0,0 +1,136 @@
+# Copyright 2009, Hakan Kjellerstrand <hakank@bonetmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require File.dirname(__FILE__) + '/example_helper'
+require 'enumerator'
+
+#
+# Minesweeper in Gecode/R
+#
+# From gecode/examples/minesweeper.cc:
+# """
+# A specification is a square matrix of characters. Alphanumeric 
+# characters represent the number of mines adjacent to that field. 
+# Dots represent fields with an unknown number of mines adjacent to 
+# it (or an actual mine).
+# """
+# 
+# E.g.
+#      "..2.3."
+#      "2....."
+#      "..24.3"
+#      "1.34.."
+#      ".....3"
+#      ".3.3.."
+# """
+# 
+# Also see 
+#  
+# http://www.janko.at/Raetsel/Minesweeper/index.htm
+#
+# http://en.wikipedia.org/wiki/Minesweeper_(computer_game)
+#
+# Ian Stewart on Minesweeper: http://www.claymath.org/Popular_Lectures/Minesweeper/
+#
+# Richard Kaye's Minesweeper Pages
+# http://web.mat.bham.ac.uk/R.W.Kaye/minesw/minesw.htm
+# Some Minesweeper Configurations
+# http://web.mat.bham.ac.uk/R.W.Kaye/minesw/minesw.pdf
+#
+# Compare with my other Minesweeper models:
+#
+# - MiniZinc: http://www.hakank.org/minizinc/minesweeper.mzn
+#
+# - Choco: http://www.hakank.org/choco/MineSweeper.java
+#
+# - JaCoP: http://www.hakank.org/JaCoP/MineSweeper.java
+#
+#
+# Model created by Hakan Kjellerstrand, hakank@bonetmail.com
+# See also my Gecode/R page: http://www.hakank.org/gecode_r
+#
+# Slight modifications made by Andreas Launila to keep the example in
+# line with the other example models.
+class Minesweeper
+  include Gecode::Mixin
+
+  # The provided +game+ should be a matrix encoding the problem in the
+  # following way:
+  #   -1 for the unknowns, 
+  #  >= 0 for number of mines in the neighbourhood
+  def initialize(game)
+    # Boolean variables representing whether each square has a mine or
+    # not.
+    mines_is_an bool_var_matrix(game.row_size, game.column_size)
+
+    # Place the constraints.
+    game.row_size.times do |i|
+      game.column_size.times do |j|
+        # The sum of all the number of mines in the neighbourhood of this cell
+        # must agree with the problem specification.
+        if game[i,j] >= 0 then
+          neighbourhood = mines.minor([i-1,0].max..(i+1), [j-1,0].max..(j+1))
+          neighbourhood.to_a.flatten.sum.must == game[i,j]
+        end
+
+        # A square can not contain a mine if the number of neighbouring
+        # mines is known.
+        if game[i,j] >= 0 then
+          mines[i,j].must_be.false
+        end
+      end
+    end
+
+    branch_on mines, :variable => :largest_degree, :value => :max
+  end
+end
+
+class Array
+  # A helper for summing the contents of an array.
+  def sum
+    inject{ |sum, x| sum + x }
+  end
+end
+
+# Problem from Gecode/examples/minesweeper.cc  problem 2
+X = -1 # unknowns
+game = Matrix[
+  [1,X,X,2,X,2,X,2,X,X],
+  [X,3,2,X,X,X,4,X,X,1],
+  [X,X,X,1,3,X,X,X,4,X],
+  [3,X,1,X,X,X,3,X,X,X],
+  [X,2,1,X,1,X,X,3,X,2],
+  [X,3,X,2,X,X,2,X,1,X],
+  [2,X,X,3,2,X,X,2,X,X],
+  [X,3,X,X,X,3,2,X,X,3],
+  [X,X,3,X,3,3,X,X,X,X],
+  [X,2,X,2,X,X,X,2,2,X]
+]
+
+minesweeper = Minesweeper.new(game)
+# Find all of the solutions.
+num_solutions = 0
+minesweeper.each_solution do |s| 
+  num_solutions += 1
+  puts "\nSolution ##{num_solutions}\n";
+  # Print the solution.
+  s.mines.values.enum_slice(s.mines.column_size).each do |row|
+    puts row.map{ |filled| filled ? "X " : ". " }.join
+  end
+end
+
+puts "\nNumber of solutions: #{num_solutions}"
+

data/example/nonogram.rb

@@ -0,0 +1,155 @@
+# Copyright 2009, Hakan Kjellerstrand <hakank@bonetmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require File.dirname(__FILE__) + '/example_helper'
+require 'enumerator'
+
+#
+# Nonogram (a.k.a. Painting by Numbers) in Gecode/R
+# 
+# http://en.wikipedia.org/wiki/Nonogram
+# """
+# Nonograms or Paint by Numbers are picture logic puzzles in which cells
+# in a grid have to be colored or left blank according to numbers given
+# at the side of the grid to reveal a hidden picture. In this puzzle
+# type, the numbers measure how many unbroken lines of filled-in squares
+# there are in any given row or column. For example, a clue of "4 8 3"
+# would mean there are sets of four, eight, and three filled squares, in
+# that order, with at least one blank square between successive groups.
+# """
+#
+# Also see
+#   * Brunetti, Sara & Daurat, Alain (2003)
+#     "An algorithm reconstructing convex lattice sets"
+#     http://geodisi.u-strasbg.fr/~daurat/papiers/tomoqconv.pdf
+#
+#   * CSPLib problem 12 at http://www.csplib.org/
+#
+#   * http://www.puzzlemuseum.com/nonogram.htm
+#
+#   * Haskell solution:
+#     http://twan.home.fmf.nl/blog/haskell/Nonograms.details
+#
+#   * My MiniZinc model http://www.hakank.org/minizinc/nonogram.mzn
+#
+#
+# Model created by Hakan Kjellerstrand, hakank@bonetmail.com
+# See also my Gecode/R page: http://www.hakank.org/gecode_r
+#
+# Slight modifications made by Andreas Launila to keep the example in
+# line with the other example models.
+class Nonogram 
+  include Gecode::Mixin
+
+  def initialize(row_rules, col_rules)
+    # A matrix of variables where each variable represents whether the 
+    # square has been filled in or not.
+    filled_is_an bool_var_matrix(row_rules.size, col_rules.size)
+
+    # Place the constraints on the rows.
+    row_rules.each_with_index do |row_rule, i| 
+      filled.row(i).must.match parse_regex(row_rule)
+    end
+    # Place the constraints on the columns.
+    col_rules.each_with_index do |col_rule, i|
+      filled.column(i).must.match parse_regex(col_rule)
+    end
+
+    branch_on filled, :variable => :none, :value => :max
+  end
+
+  # Parses a nonogram segment and converts it to a "regexp"
+  # e.g. [3,2] -> [repeat(false), repeat(true,3,3), at_least_once(false),
+  #                repeat(true,2,2),repeat(false)]
+  def parse_regex(a)
+    r = [repeat(false)]
+    a.each_with_index do |e,i| 
+      r << repeat(true,e,e)
+      if i < a.length-1 then
+        r << at_least_once(false) 
+      end
+    end
+    r << repeat(false)
+    return r
+  end
+end
+
+# A nonogram problem taken from Wikipedia 
+# http://en.wikipedia.org/wiki/Nonogram
+# Animation:
+# http://en.wikipedia.org/wiki/File:Paint_by_numbers_Animation.gif
+#
+row_rules = 
+[
+  [3],
+  [5],
+  [3,1],
+  [2,1],
+  [3,3,4],
+  [2,2,7],
+  [6,1,1],
+  [4,2,2],
+  [1,1],
+  [3,1],
+  [6],
+  [2,7],
+  [6,3,1],
+  [1,2,2,1,1],
+  [4,1,1,3],
+  [4,2,2],
+  [3,3,1],
+  [3,3],
+  [3],
+  [2,1]
+]
+  
+col_rules = 
+ [
+  [2],
+  [1,2],
+  [2,3],
+  [2,3],
+  [3,1,1],
+  [2,1,1],
+  [1,1,1,2,2],
+  [1,1,3,1,3],
+  [2,6,4],
+  [3,3,9,1],
+  [5,3,2],
+  [3,1,2,2],
+  [2,1,7],
+  [3,3,2],
+  [2,4],
+  [2,1,2],
+  [2,2,1],
+  [2,2],
+  [1],
+  [1]
+]
+
+nonogram = Nonogram.new(row_rules, col_rules)
+# Find all of the solutions.
+num_solutions = 0
+nonogram.each_solution do |s| 
+  num_solutions += 1
+  puts "\nSolution ##{num_solutions}\n"
+  # Output the solution.
+  s.filled.values.enum_slice(s.filled.column_size).each do |row|
+    puts row.map{ |filled| filled ? "#" : " " }.join
+  end
+end
+
+puts "\nNumber of solutions: #{num_solutions}"

data/example/survo.rb

@@ -0,0 +1,131 @@
+# Copyright 2009, Hakan Kjellerstrand <hakank@bonetmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require File.dirname(__FILE__) + '/example_helper'
+require 'enumerator'
+
+# Survo Puzzle in Gecode/R
+#
+# http://en.wikipedia.org/wiki/Survo_Puzzle
+# """
+# Survo puzzle is a kind of logic puzzle presented (in April 2006) and studied 
+# by Seppo Mustonen. The name of the puzzle is associated to Mustonen's 
+# Survo system which is a general environment for statistical computing and 
+# related areas.
+# 
+# In a Survo puzzle the task is to fill an m * n table by integers 1,2,...,m*n so 
+# that each of these numbers appears only once and their row and column sums are 
+# equal to integers given on the bottom and the right side of the table. 
+# Often some of the integers are given readily in the table in order to 
+# guarantee uniqueness of the solution and/or for making the task easier.
+# """
+# 
+# See also
+# http://www.survo.fi/english/index.html
+# http://www.survo.fi/puzzles/index.html
+#
+# References:
+# Mustonen, S. (2006b). "On certain cross sum puzzles", http://www.survo.fi/papers/puzzles.pdf 
+# Mustonen, S. (2007b). "Enumeration of uniquely solvable open Survo puzzles.", http://www.survo.fi/papers/enum_survo_puzzles.pdf 
+# Kimmo Vehkalahti: "Some comments on magic squares and Survo puzzles", http://www.helsinki.fi/~kvehkala/Kimmo_Vehkalahti_Windsor.pdf
+# R code: http://koti.mbnet.fi/tuimala/tiedostot/survo.R
+#
+# Compare with my other Survo Puzzle models
+#
+# - MiniZinc: http://www.hakank.org/minizinc/survo_puzzle.mzn
+# - JaCoP: http://www.hakank.org/JaCoP/SurvoPuzzle.java
+# - Choco: http://www.hakank.org/choco/SurvoPuzzle.java
+#
+# Model created by Hakan Kjellerstrand, hakank@bonetmail.com
+# See also my Gecode/R page: http://www.hakank.org/gecode_r
+#
+# Slight modifications made by Andreas Launila to keep the example in
+# line with the other example models.
+class SurvoPuzzle
+  include Gecode::Mixin
+  
+  # The +clues+ are given as an m*n matrix where 0 represents that the
+  # cell has no clue. The row sums and column sums are specified by the
+  # +rowsums+ array of length m, and the +colsums+ array of length n
+  # respectively.
+  def initialize(clues, rowsums, colsums)
+    r = rowsums.length # Number of rows 
+    c = colsums.length # Number of columns
+
+    # Integer variables representing each cell in the m*n table.
+    cells_is_an int_var_matrix(r, c, 1..r*c)
+
+    # Add the constraints.
+    # Each number must appear only once.
+    cells.must_be.distinct
+
+    # The row sums must be satisfied.
+    cells.row_vectors.each_with_index do |row, i| 
+      row.sum.must == rowsums[i]
+    end
+
+    # The column sums must be satisfied.
+    cells.column_vectors.each_with_index do |column, i| 
+      column.sum.must == colsums[i] 
+    end
+
+    # The clues must be satisfied.
+    cells.row_size.times do |i| 
+      cells.column_size.times do |j|
+        cells[i,j].must == clues[i,j] if clues[i,j] > 0
+      end
+    end
+
+    branch_on cells, :variable => :smallest_size, :value => :min
+  end
+end
+
+class Vector
+  # A helper for summing the contents of a vector.
+  def sum
+    inject{ |sum, element| sum + element }
+  end
+end
+
+# Default problem:
+# Survo puzzle 126/2008 (25) #363-33148
+# From http://www.survo.fi/puzzles/280708.txt
+rowsums = [32,79,60]
+colsums = [24,22,43,35,39,8]
+clues = Matrix[
+         [ 0, 4, 0, 0, 0, 0,32],
+         [12, 0, 0,16,17, 0,79],
+         [ 0, 0,15, 0, 0, 2,60],
+        ]
+
+survo_puzzle = SurvoPuzzle.new(clues, rowsums, colsums)
+num_solutions = 0
+survo_puzzle.each_solution do |s| 
+  num_solutions += 1
+  puts "\nSolution ##{num_solutions}";
+  # Print the solution.
+  s.cells.values.enum_slice(s.cells.column_size).each_with_index do |row,i|
+    row.each{ |element| printf('%3d ', element) }
+    printf ' = %3d ', rowsums[i]
+    puts
+  end
+  colsums.size.times{ printf('%2s= ', '') }
+  puts 
+  colsums.each{ |element| printf('%3d ', element) }
+end
+
+puts "\nNumber of solutions: #{num_solutions}"
+