sudokuhandler 0.1.2 → 0.1.3

data/README.md

@@ -7,143 +7,134 @@ Le Sudoku "classique" (9x9) est optimisé au maximum en temps et en mémoire (41
 
 ### Création d'un sudoku de 9x9 en diagonale
 
-    $ irb -r sudoku
-		ruby-1.9.2-p290 :000 > s = Sudoku.new 3
-		 => #<Sudoku::S3 9x9 0,0, ... , 0, 0> 
-  	ruby-1.9.2-p290 :001 > s = Sudoku[3].new
-  	 => #<Sudoku::S3 9x9 0,0, ... , 0, 0> 
-  	ruby-1.9.2-p290 :002 > s.each{|x,y,v| s.set x, x, x+1 if x == y}
-  	 => #<Sudoku::S3 9x9 1,0, ... , 0, 9> 
-  	ruby-1.9.2-p290 :003 > puts s
+	$ irb -r sudoku
+	ruby-1.9.2-p290 :000 > s = Sudoku.new 3
+	 => #<Sudoku::S3 9x9 0,0, ... , 0, 0> 
+	ruby-1.9.2-p290 :001 > s = Sudoku[3].new
+	 => #<Sudoku::S3 9x9 0,0, ... , 0, 0> 
+	ruby-1.9.2-p290 :002 > s.each{|x,y,v| s.set x, x, x+1 if x == y}
+	 => #<Sudoku::S3 9x9 1,0, ... , 0, 9> 
+	ruby-1.9.2-p290 :003 > puts s
 	
-    1 . .  . . .  . . . 
-  	. 2 .  . . .  . . . 
-  	. . 3  . . .  . . . 
-  
-  	. . .  4 . .  . . . 
-  	. . .  . 5 .  . . . 
-  	. . .  . . 6  . . . 
-  
-  	. . .  . . .  7 . . 
-  	. . .  . . .  . 8 . 
-  	. . .  . . .  . . 9 
-  	 => nil 
+	1 . .  . . .  . . . 
+	. 2 .  . . .  . . . 
+	. . 3  . . .  . . . 
+	
+	. . .  4 . .  . . . 
+	. . .  . 5 .  . . . 
+	. . .  . . 6  . . . 
+	
+	. . .  . . .  7 . . 
+	. . .  . . .  . 8 . 
+	. . .  . . .  . . 9 
+ 	=> nil 
 
 ###Exportation du sudoku
 
-    ruby-1.9.2-p290 :004 > s.to_sutxt
-     => "3: 1 0 0 0 0 0 0 0 0 0 2 0 0 0 0 0 0 0 0 0 3 0 0 0 0 0 0 0 0 0 4 0 0 0 0 0 0 0 0 0 5 0 0 0 0 0 0 0 0 0 6 0 0 0 0 0 0 0 0 0 7 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 9;" 
-    ruby-1.9.2-p290 :005 > s2 = Sudoku.parse s.to_sutxt
-     => #<Sudoku::S3 9x9 1,0, ... , 0, 9> 
+	ruby-1.9.2-p290 :004 > s.to_sutxt
+	 => "3: 1 0 0 0 0 0 0 0 0 0 2 0 0 0 0 0 0 0 0 0 3 0 0 0 0 0 0 0 0 0 4 0 0 0 0 0 0 0 0 0 5 0 0 0 0 0 0 0 0 0 6 0 0 0 0 0 0 0 0 0 7 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 9;" 
+	ruby-1.9.2-p290 :005 > s2 = Sudoku.parse s.to_sutxt
+	 => #<Sudoku::S3 9x9 1,0, ... , 0, 9> 
 
 ### Un peu de logique
 
-    ruby-1.9.2-p290 :006 > s.possibilities 0, 1
-     => [4, 5, 6, 7, 8, 9] 
-    ruby-1.9.2-p290 :007 > s.valid? 1, 0, 3
-     => false 
-    ruby-1.9.2-p290 :008 > s.valid? 1, 0, 5
-     => true 
-		ruby-1.9.2-p290 :009 > s.col 2
-		 => [3] 
-		ruby-1.9.2-p290 :010 > s.row 3
-		 => [4] 
-		ruby-1.9.2-p290 :011 > s.square 3,3
-		 => [4, 5, 6]
+	ruby-1.9.2-p290 :006 > s.possibilities 0, 1
+	 => [4, 5, 6, 7, 8, 9] 
+	ruby-1.9.2-p290 :007 > s.valid? 1, 0, 3
+	 => false 
+	ruby-1.9.2-p290 :008 > s.valid? 1, 0, 5
+	 => true 
+	ruby-1.9.2-p290 :009 > s.col 2
+	 => [3] 
+	ruby-1.9.2-p290 :010 > s.row 3
+	 => [4] 
+	ruby-1.9.2-p290 :011 > s.square 3,3
+	 => [4, 5, 6]
 
 ### Generateur
 		
-		class MySudoku < Sudoku::S4_15
-			include Sudoku::Generator
-		end
-		
-		s = MySudoku.new 5
-		s.make_valid
-		puts s
-		
-		=begin     =>>
-		1  2  3  4  5   6  7  8  9  10  11 12 13 14 15  16 17 18 19 20  21 22 23 24 25 
-		6  7  8  9  10  11 12 13 14 15  16 17 18 19 20  21 22 23 24 25  1  2  3  4  5  
-		11 12 13 14 15  16 17 18 19 20  21 22 23 24 25  1  2  3  4  5   6  7  8  9  10 
-		16 17 18 19 20  21 22 23 24 25  1  2  3  4  5   6  7  8  9  10  11 12 13 14 15 
-		21 22 23 24 25  1  2  3  4  5   6  7  8  9  10  11 12 13 14 15  16 17 18 19 20 
-
-		2  3  4  5  6   7  8  9  10 11  12 13 14 15 16  17 18 19 20 21  22 23 24 25 1  
-		7  8  9  10 11  12 13 14 15 16  17 18 19 20 21  22 23 24 25 1   2  3  4  5  6  
-		12 13 14 15 16  17 18 19 20 21  22 23 24 25 1   2  3  4  5  6   7  8  9  10 11 
-		17 18 19 20 21  22 23 24 25 1   2  3  4  5  6   7  8  9  10 11  12 13 14 15 16 
-		22 23 24 25 1   2  3  4  5  6   7  8  9  10 11  12 13 14 15 16  17 18 19 20 21 
+	Sudoku.new(5).make_valid
 
-		3  4  5  6  7   8  9  10 11 12  13 14 15 16 17  18 19 20 21 22  23 24 25 1  2  
-		8  9  10 11 12  13 14 15 16 17  18 19 20 21 22  23 24 25 1  2   3  4  5  6  7  
-		13 14 15 16 17  18 19 20 21 22  23 24 25 1  2   3  4  5  6  7   8  9  10 11 12 
-		18 19 20 21 22  23 24 25 1  2   3  4  5  6  7   8  9  10 11 12  13 14 15 16 17 
-		23 24 25 1  2   3  4  5  6  7   8  9  10 11 12  13 14 15 16 17  18 19 20 21 22 
+donne (par exemple)
 
-		4  5  6  7  8   9  10 11 12 13  14 15 16 17 18  19 20 21 22 23  24 25 1  2  3  
-		9  10 11 12 13  14 15 16 17 18  19 20 21 22 23  24 25 1  2  3   4  5  6  7  8  
-		14 15 16 17 18  19 20 21 22 23  24 25 1  2  3   4  5  6  7  8   9  10 11 12 13 
-		19 20 21 22 23  24 25 1  2  3   4  5  6  7  8   9  10 11 12 13  14 15 16 17 18 
-		24 25 1  2  3   4  5  6  7  8   9  10 11 12 13  14 15 16 17 18  19 20 21 22 23 
-
-		5  6  7  8  9   10 11 12 13 14  15 16 17 18 19  20 21 22 23 24  25 1  2  3  4  
-		10 11 12 13 14  15 16 17 18 19  20 21 22 23 24  25 1  2  3  4   5  6  7  8  9  
-		15 16 17 18 19  20 21 22 23 24  25 1  2  3  4   5  6  7  8  9   10 11 12 13 14 
-		20 21 22 23 24  25 1  2  3  4   5  6  7  8  9   10 11 12 13 14  15 16 17 18 19 
-		25 1  2  3  4   5  6  7  8  9   10 11 12 13 14  15 16 17 18 19  20 21 22 23 24
-		=end
 		
-		s.valid? 		   # => true
-		s.complete? 	 # => true
-		s.completable? # => true
+	1  2  3  4  5   6  7  8  9  10  11 12 13 14 15  16 17 18 19 20  21 22 23 24 25 
+	6  7  8  9  10  11 12 13 14 15  16 17 18 19 20  21 22 23 24 25  1  2  3  4  5  
+	11 12 13 14 15  16 17 18 19 20  21 22 23 24 25  1  2  3  4  5   6  7  8  9  10 
+	16 17 18 19 20  21 22 23 24 25  1  2  3  4  5   6  7  8  9  10  11 12 13 14 15 
+	21 22 23 24 25  1  2  3  4  5   6  7  8  9  10  11 12 13 14 15  16 17 18 19 20 
+	
+	2  3  4  5  6   7  8  9  10 11  12 13 14 15 16  17 18 19 20 21  22 23 24 25 1  
+	7  8  9  10 11  12 13 14 15 16  17 18 19 20 21  22 23 24 25 1   2  3  4  5  6  
+	12 13 14 15 16  17 18 19 20 21  22 23 24 25 1   2  3  4  5  6   7  8  9  10 11 
+	17 18 19 20 21  22 23 24 25 1   2  3  4  5  6   7  8  9  10 11  12 13 14 15 16 
+	22 23 24 25 1   2  3  4  5  6   7  8  9  10 11  12 13 14 15 16  17 18 19 20 21 
+	
+	3  4  5  6  7   8  9  10 11 12  13 14 15 16 17  18 19 20 21 22  23 24 25 1  2  
+	8  9  10 11 12  13 14 15 16 17  18 19 20 21 22  23 24 25 1  2   3  4  5  6  7  
+	13 14 15 16 17  18 19 20 21 22  23 24 25 1  2   3  4  5  6  7   8  9  10 11 12 
+	18 19 20 21 22  23 24 25 1  2   3  4  5  6  7   8  9  10 11 12  13 14 15 16 17 
+	23 24 25 1  2   3  4  5  6  7   8  9  10 11 12  13 14 15 16 17  18 19 20 21 22 
+	
+	4  5  6  7  8   9  10 11 12 13  14 15 16 17 18  19 20 21 22 23  24 25 1  2  3  
+	9  10 11 12 13  14 15 16 17 18  19 20 21 22 23  24 25 1  2  3   4  5  6  7  8  
+	14 15 16 17 18  19 20 21 22 23  24 25 1  2  3   4  5  6  7  8   9  10 11 12 13 
+	19 20 21 22 23  24 25 1  2  3   4  5  6  7  8   9  10 11 12 13  14 15 16 17 18 
+	24 25 1  2  3   4  5  6  7  8   9  10 11 12 13  14 15 16 17 18  19 20 21 22 23 
+	
+	5  6  7  8  9   10 11 12 13 14  15 16 17 18 19  20 21 22 23 24  25 1  2  3  4  
+	10 11 12 13 14  15 16 17 18 19  20 21 22 23 24  25 1  2  3  4   5  6  7  8  9  
+	15 16 17 18 19  20 21 22 23 24  25 1  2  3  4   5  6  7  8  9   10 11 12 13 14 
+	20 21 22 23 24  25 1  2  3  4   5  6  7  8  9   10 11 12 13 14  15 16 17 18 19 
+	25 1  2  3  4   5  6  7  8  9   10 11 12 13 14  15 16 17 18 19  20 21 22 23 24
 		
 ### Utiliser son propre adapteur
 
-#### Un adapteur doit au moins définir les méthodes suivantes:
+#### Interface minimale d'un adapteur
 
-* get(x, y)
-* set(x, y, val)
-* each(){|x, y, val| ... }
-* size()
-* initialize(base)
+* get(x, y)                => Fixnum
+* set(x, y, val)           => Fixnum
+* each(){|x, y, val| ... } => self
+* size()                   => Fixnum
+* initialize(base)         => self
 * initialize_copy(parent) (automatique si on n'utilise que des objets ruby)
 
 #### Exemple:
 
 NB: cet exemple ne tient pas compte de la gestion des erreurs
 		
-		class MonSuperAdapteur
-			attr_reader :size
-			
-			include Sudoku::Generator #methodes de generation automatique
-			include Sudoku::Grid      #methodes communes a tous les sudokus
-			
-			def initialize base
-				@size = base*base
-				@data = Array.new(@size*@size){0}
-			end
-			
-			def get x, y
-				@data[x+y*size]
-			end
-			
-			def set x, y, val
-				@data[x+y*size] = val
-			end
-			
-			def each
-				@data.each_with_index do |val, i|
-					yield i%size, i/size, val
-				end
-				self
-			end
+	class MonSuperAdapteur
+		attr_reader :size
+		
+		include Sudoku::Generator #methodes de generation automatique
+		include Sudoku::Grid      #methodes communes a tous les sudokus
+		
+		def initialize base
+			@size = base*base
+			@data = Array.new(@size*@size){0}
+		end
+		
+		def get x, y
+			@data[x+y*size]
+		end
+		
+		def set x, y, val
+			@data[x+y*size] = val
 		end
 		
-		Sudoku[4..7] = MonSuperAdapteur #Tous les sudokus de base 4 à 7 créés automatiquement
-																		#seront des MonSuperAdapteur
-		Sudoku.new(3).class	# => Sudoku::S3
-		Sudoku.new(4).class	# => MonSuperAdapteur					
+		def each
+			@data.each_with_index do |val, i|
+				yield i%size, i/size, val
+			end
+			self
+		end
+	end
 		
-		Sudoku[0]    = MonSuperAdapteur #Tous les sudokus, par defaut
+	Sudoku[4..7] = MonSuperAdapteur #Tous les sudokus de base 4 à 7 créés automatiquement
+	                                #seront des MonSuperAdapteur
+	Sudoku.new(3).class	# => Sudoku::S3
+	Sudoku.new(4).class	# => MonSuperAdapteur					
+	
+	Sudoku[0] = MonSuperAdapteur #Tous les sudokus, par defaut
 		
-		Sudoku.new(3).class # => MonSuperAdapteur
+	Sudoku.new(3).class # => MonSuperAdapteur

data/Rakefile

@@ -1,22 +1,30 @@
 require 'rubygems'
 require 'rake/gempackagetask'
-require 'rake/extensiontask'
+begin
+  require 'rake/extensiontask'
+rescue LoadError => e
+  sh "gem install rake-compiler"
+  exec %{rake "#{ARGV*'" "'}"}
+end
 require 'rake/testtask.rb'
 require './lib/sudoku/version'
 
 spec = Gem::Specification.new do |s|
-  s.name        = 'sudokuhandler'
-  s.version     = Sudoku::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.summary     = "Ruby Sudoku handler"
-  s.description = "Highly optimised Sudoku objects and mixins for Ruby"
-  s.author      = "Titouan Christophe"
-  s.email       = 'titouanchristophe@gmail.com'
-  s.files       = FileList["lib/*.rb", "lib/sudoku/*.rb", "ext/sudoku.c", "Rakefile", "README.md"]
-  s.homepage    = 'http://github.com/titouanc/rb-sudoku'
-  s.extensions << 'ext/extconf.rb'
-  s.license     = 'Creative Commons BY-NC-SA 3.0'
-  s.test_files  = FileList["tests/*"]
+  s.name          = 'sudokuhandler'
+  s.version       = Sudoku::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.summary       = "Ruby Sudoku handler"
+  s.description   = "Highly optimised Sudoku objects and mixins for Ruby"
+  s.author        = "Titouan Christophe"
+  s.email         = 'titouanchristophe@gmail.com'
+  s.files         = FileList["lib/*.rb", "lib/sudoku/*.rb", "ext/sudoku.c", "Rakefile", "README.md"]
+  s.homepage      = 'http://github.com/titouanc/rb-sudoku'
+  s.extensions   << 'ext/extconf.rb'
+  s.license       = 'Creative Commons BY-NC-SA 3.0'
+  s.test_files    = FileList["tests/*"]
+  s.rdoc_options += ['--title', 'Sudoku for Ruby', '--main',  'README']
+  s.add_development_dependency 'rake-compiler'
+  s.add_development_dependency 'yard'
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
@@ -34,6 +42,16 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = FileList["lib/sudoku.rb", "lib/sudoku/*.rb"]
+    t.options = ['--readme', 'README.md', '--charset', 'UTF-8']
+  end
+rescue LoadError => e
+  puts "No doc task (YARD required)"
+end
+
 desc "Build gem & install"
 task :install => FileList["pkg/#{spec.full_name}.gem"] do |t|
   sh "gem install #{t.prerequisites.first}"
@@ -54,4 +72,6 @@ task :console => :compile do |t|
   sh "irb -I ./lib -r sudoku"
 end
 
-task :default => [:clobber, :repackage, :compile, :test]
+task :doc => :yard
+
+task :default => [:clobber, :repackage, :compile, :test, :yard]

data/ext/sudoku.c

@@ -74,13 +74,17 @@ static VALUE S4_15_initCopy(VALUE copy, VALUE orig){
   S4_15 *this, *parent;
   int len;
   
+  if (copy == orig)
+    return copy;
+  
   Data_Get_Struct(copy, S4_15, this);
   Data_Get_Struct(orig, S4_15, parent);
   
   this->size = parent->size;
+  len = this->size * this->size;
   
   S4_15_alloc_data(this);
-  memcpy(this->ptr, parent->ptr, parent->size*sizeof(char));
+  memcpy(this->ptr, parent->ptr, len*sizeof(char));
   
   return copy;
 }
@@ -94,7 +98,7 @@ static VALUE S4_15_get(VALUE self, VALUE col, VALUE row){
   if (x<0 || x>=this->size || y<0 || y>=this->size)
     rb_raise(rb_eArgError, "Are you sure thre's a %d,%d cell in a %dx%d Sudoku ?", x, y, this->size, this->size);
     
-  return INT2NUM(this->ptr[x+y*this->size]);
+  return INT2FIX(this->ptr[x+y*this->size]);
 }
 
 static VALUE S4_15_set(VALUE self, VALUE col, VALUE row, VALUE value){
@@ -150,6 +154,9 @@ static void Init_S4_15(VALUE module){
 
 /* ############################################ */
 
+#define S3_offset(x, y) ((size_t) (x)+((y)*9))
+#define S3_valAtOffset(ptr, i) (((i)%2 == 0) ? (((ptr)[(i)/2] >> 4) & 0x0f) : ((ptr)[(i)/2] & 0x0f))
+
 static void S3_dealloc(void *ptr){
   free(ptr);
 }
@@ -179,6 +186,9 @@ static VALUE S3_initCopy(VALUE copy, VALUE orig){
   unsigned char *this, *parent;
   char i;
   
+  if (copy == orig)
+    return copy;
+  
   Data_Get_Struct(copy, unsigned char, this);
   Data_Get_Struct(orig, unsigned char, parent);
   if (this == parent)
@@ -190,7 +200,7 @@ static VALUE S3_initCopy(VALUE copy, VALUE orig){
 }
 
 static VALUE S3_get(VALUE self, VALUE col, VALUE row){
-  unsigned char *this, x, y, i;
+  unsigned char *this, x, y;
   
   Data_Get_Struct(self, unsigned char, this);
   x = NUM2UINT(col)&0xff;
@@ -199,11 +209,7 @@ static VALUE S3_get(VALUE self, VALUE col, VALUE row){
   if (x>=9 || y>=9)
     rb_raise(rb_eArgError, "Are you sure thre's a %d,%d cell in a 9x9 Sudoku ?", x, y);
   
-  i = x + y*9;  
-  if (i%2 == 0)
-    return INT2FIX((this[i/2] >> 4) & 0x0f);
-  else
-    return INT2FIX(this[i/2] & 0x0f);
+  return INT2FIX(S3_valAtOffset(this, S3_offset(x, y)));
 }
 
 static VALUE S3_set(VALUE self, VALUE col, VALUE row, VALUE value){
@@ -218,7 +224,7 @@ static VALUE S3_set(VALUE self, VALUE col, VALUE row, VALUE value){
   if (x>=9 || y>=9 || val > 9)
     rb_raise(rb_eArgError, "%d,%d => %d not allowed in a 9x9 Sudoku", x, y, val);
     
-  i = x + y*9;
+  i = S3_offset(x, y);
   if (i%2 == 0)
     this[i/2] = (this[i/2]&0x0f) | (val<<4);
   else
@@ -248,6 +254,48 @@ static VALUE S3_each(VALUE self){
   return self;
 }
 
+static VALUE S3_column(VALUE self, VALUE col){
+  unsigned char x = NUM2UINT(col)&0xff, y, val;
+  unsigned char i = x;
+  VALUE res;
+  unsigned char *this;
+  
+  if (x>=9)
+    rb_raise(rb_eArgError, "Are you sure thre's a %d column in a 9x9 Sudoku ?", x);
+  
+  Data_Get_Struct(self, unsigned char, this);
+  res = rb_ary_new();
+  for (y=0; y<9; y++){
+    val = S3_valAtOffset(this, i);
+    if (val != 0)
+      rb_ary_push(res, INT2FIX(val));
+    i += 9;
+  }
+  
+  return res;
+}
+
+static VALUE S3_line(VALUE self, VALUE row){
+  unsigned char y = NUM2UINT(row)&0xff, x, val;
+  unsigned char i = 9*y;
+  VALUE res;
+  unsigned char *this;
+  
+  if (y>=9)
+    rb_raise(rb_eArgError, "Are you sure thre's a %d row in a 9x9 Sudoku ?", y);
+  
+  Data_Get_Struct(self, unsigned char, this);
+  res = rb_ary_new();
+  for (x=0; x<9; x++){
+    val = S3_valAtOffset(this, i);
+    if (val != 0)
+      rb_ary_push(res, INT2FIX(val));
+    i ++;
+  }
+  
+  return res;
+}
+
 static VALUE S3_isComplete(VALUE self){
   char i, val;
   unsigned char *this;
@@ -260,6 +308,31 @@ static VALUE S3_isComplete(VALUE self){
   return Qtrue;
 }
 
+static VALUE S3_isValidCell(VALUE self, VALUE col, VALUE row, VALUE val){
+  unsigned char x = NUM2UINT(col)&0xff, xx;
+  unsigned char y = NUM2UINT(row)&0xff, yy;
+  unsigned char v = NUM2UINT(val)&0xff;
+  unsigned char     i;
+  unsigned char *this;
+  
+  if (x>=9 || y>=9 || v>9)
+    rb_raise(rb_eArgError, "%d,%d => %d not allowed in a 9x9 Sudoku", x, y, v);
+  
+  if (v==0)
+    return Qtrue;
+  
+  Data_Get_Struct(self, unsigned char, this);
+  for (i=0; i<9; i++){
+    if (S3_valAtOffset(this, S3_offset(x, i)) == v && i != y) return Qfalse;
+    if (S3_valAtOffset(this, S3_offset(i, y)) == v && i != x) return Qfalse;
+    xx = 3*(x/3) + (i%3);
+    yy = 3*(y/3) + (i/3);
+    if (S3_valAtOffset(this, S3_offset(xx, yy))==v && xx!=x && yy!=y) return Qfalse;
+  }
+  
+  return Qtrue;
+}
+
 static VALUE S3_dump(VALUE self){
   char string[83] = {'\0'};
   int i;
@@ -283,8 +356,11 @@ static void Init_S3(VALUE module){
     rb_define_method(class_S3, "get", S3_get, 2);
     rb_define_method(class_S3, "set", S3_set, 3);
     rb_define_method(class_S3, "each", S3_each, 0);
+    rb_define_method(class_S3, "col", S3_column, 1);
+    rb_define_method(class_S3, "row", S3_line, 1);
     rb_define_method(class_S3, "complete?", S3_isComplete, 0);
     rb_define_method(class_S3, "dump", S3_dump, 0);
+    rb_define_method(class_S3, "valid_cell?", S3_isValidCell, 3);
 }
 
 /* ############################################ */