congruence_solver 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0efc553f7421a673f9a66fcb7b3b0940f7f2f82
-  data.tar.gz: 0146a9f00b2bf9f1ec49ae9180f4b82b817e3bf5
+  metadata.gz: d41325020ecfa40cc46d234828df89bc2fb40f49
+  data.tar.gz: acde70a6f821e7ec7952ab6db97a7c0fe4d61484
 SHA512:
-  metadata.gz: cb9842feb8b1d72d26cfc1b6efbf86dcc357ee1a1c070dedcf6498c6a1c0c33f2cf96a5a9a0db5a224da1a74d751de3d8018dabf5bc9f67ce98126c672ee5e98
-  data.tar.gz: 3c3bae47bde1f4d7d5cdd91b157b6a4b3e345859af280db80a5a311bf503577d56b70b7fa2a38829a909bb1e4f0dba93bad284c257a6cfb6b980cbd8c97220b6
+  metadata.gz: fd914b02d0bb19bec1f30558d3fde308225eafbebc11029d0d2fe0ef6f1c91f31cfb03896596cdbd8da194a176bb5cad7bcf5cf339f21fed0ba1377afaeeff62
+  data.tar.gz: af76d6607a3acf0c327c1d60e9daf7fbbca921bc1877dde9803928d49a4131bd62975766ac8f7a2f3452153da5a6be4b8c6549de4a55c4292c3edcf0aaac5422

data/.gitignore

@@ -1,6 +1,9 @@
-Gemfile.lock
-tmp/
-todo
-lib/congruence_solver/congruence_solver.so
-*.gem
-*.html
+Gemfile.lock
+tmp/
+todo
+lib/congruence_solver/congruence_solver.bundle
+*.gem
+*.html
+ext/congruence_solver/*
+!ext/congruence_solver/extconf.rb
+!ext/congruence_solver/congruence_solver.c

data/.gitmodules

@@ -1,4 +0,0 @@
-[submodule "ext/congruence_solver"]
-  path = ext/congruence_solver
-  url = https://github.com/laneb/congruence_solver_ext.git
-  branch = master

data/.rspec

@@ -1,2 +1,2 @@
---color
---require spec_helper
+--color
+--require spec_helper

data/README.md

@@ -1,64 +1,51 @@
-# CongruenceSolver
-
-CongruenceSolver is a gem for solving polynomial congruences. Should you ever need to solve polynomial congruences and have Ruby installed, this is the gem for you!
-
-## Polynomial Congruences
-
-Polynomial congruences are the central topic of most elementary number theory and abstract algebra curricula. Similar to an equation, a [congruence](https://en.wikipedia.org/wiki/Modular_equation) is an [equivalence relation](https://en.wikipedia.org/wiki/Equivalence_relation) arising from [modular arithmetic](https://en.wikipedia.org/wiki/Modular_arithmetic) (also knowsn as "clock arithmetic"). For example, the idea "5 hours past 8 is 1" is expressed in the congruence ```8 + 5 = 1 mod 12```. A polynomial congruence is simply a congruence involving a polynomial, like ```x + 5 = 1 mod 12```. The problem of solving a congruence is to find all inputs satisfying the congruence, much like solving an equation (in this case, ```x = 8```). Generally speaking, congruences become more difficult to solve as the degree of the polynomial and the modulus grow. Elementary number theory develops tools like [Hensel Lifting](https://en.wikipedia.org/wiki/Hensel%27s_lemma#Hensel_Lifting) for solving polynomial congruences and the [Chinese Remainder Theorem](https://en.wikipedia.org/wiki/Chinese_remainder_theorem) for solving systems of polynomial congruences. This gem leverages these methods as implemented in C in [congruence_solver_ext](https://github.com/laneb/congruence_solver_ext).
-
-## Installation
-
-With [RubyGems](https://rubygems.org/) on your machine, installation is as easy as 
-```shell
-gem install congruence_solver
-```
-
-You may also install via [bundler](http://bundler.io/), by adding this line to your application's Gemfile:
-
-```ruby
-gem 'congruence_solver'
-```
-
-and executing
-
-```shell
-$ bundle
-```
-
-in the project directory.
-
-## Usage
-
-To solve a polynomial congruence at the command line, simply invoke `csolve` and then enter the congruence at the prompt. 
-
-```
-csolve
-Congruence to solve:
-x^2 + 2x + 1 = x^3 + 3x^5 mod 49
-(0) 1
-(1) 8
-(2) 15
-(3) 22
-(4) 26
-(5) 29
-(6) 36
-(7) 43
-```
-
-To use the CongruenceSolver in a Ruby program, use CongruenceSolve::solve_congruence(coeffs, mod), where coeffs is the ascending list of coefficients of the polynomial (congruent to 0) and mod is the modulus of the congruence.
-
-```
-#solve -3x^5 - x^3 + x^2 + 2x + 1 = 0 mod 49
-coeffs = [1, 2, 1, 1, 0, 3]
-mod = 49
-CongruenceSolver.solve_congruence(coeffs, mod).sort  #=> [1, 8, 15, 22, 26, 29, 36, 43]
-``` 
-
-## Development
-
-After checking out the repo, run `bundle install` to install dependencies and `bundle exec rake update_ext` to pull and compile the extension. Then, run `bundle exec rake spec` to run the tests, or `bundle exec rake bench` to run the benchmark. To build and install this gem onto your local machine, run `bundle exec rake install`.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/laneb/congruence_solver.
-
+# CongruenceSolver
+
+CongruenceSolver is a gem for solving polynomial congruences. Should you ever need to solve polynomial congruences, this is the gem for you!
+
+## Polynomial Congruences
+
+Polynomial congruences are the central topic of most elementary number theory and abstract algebra curricula. Similar to an equation, a [congruence](https://en.wikipedia.org/wiki/Modular_equation) is an [equivalence relation](https://en.wikipedia.org/wiki/Equivalence_relation) arising from [modular arithmetic](https://en.wikipedia.org/wiki/Modular_arithmetic) (also knowsn as "clock arithmetic"). For example, the idea "5 hours past 8 is 1" is expressed in the congruence ```8 + 5 = 1 mod 12```. A polynomial congruence is simply a congruence involving a polynomial, like ```x + 5 = 1 mod 12```. The problem of solving a congruence is to find all inputs satisfying the congruence, much like solving an equation (in this case, ```x = 8```). Generally speaking, congruences become more difficult to solve as the degree of the polynomial and the modulus grow. Elementary number theory develops tools like [Hensel Lifting](https://en.wikipedia.org/wiki/Hensel%27s_lemma#Hensel_Lifting) for solving polynomial congruences and the [Chinese Remainder Theorem](https://en.wikipedia.org/wiki/Chinese_remainder_theorem) for solving systems of polynomial congruences. This gem leverages these methods as implemented in C in [congruence_solver_ext](https://github.com/laneb/congruence_solver_ext).
+
+## Installation
+
+With [RubyGems](https://rubygems.org/) on your machine, installation is as easy as
+```shell
+gem install congruence_solver
+```
+
+You may also include this gem in a project with [bundler](http://bundler.io/) or by adding it to your Gemfile.
+
+## Usage
+
+To solve a polynomial congruence at the command line, simply invoke `csolve` and then enter the congruence at the prompt.
+
+```
+csolve
+Congruence to solve:
+x^2 + 2x + 1 = x^3 + 3x^5 mod 49
+(0) 1
+(1) 8
+(2) 15
+(3) 22
+(4) 26
+(5) 29
+(6) 36
+(7) 43
+```
+
+To use the CongruenceSolver in a Ruby program, use CongruenceSolve::solve_congruence(coeffs, mod), where coeffs is the ascending list of coefficients of the polynomial (congruent to 0) and mod is the modulus of the congruence.
+
+```
+#solve -3x^5 - x^3 + x^2 + 2x + 1 = 0 mod 49
+coeffs = [1, 2, 1, 1, 0, 3]
+mod = 49
+CongruenceSolver.solve_congruence(coeffs, mod).sort  #=> [1, 8, 15, 22, 26, 29, 36, 43]
+```
+
+## Development
+
+First, install bundler (`gem install bundler`). Then install this project's dependencies with `bundle install`. Use `bundle exec rake update_ext` to pull and compile the extension. Use `bundle exec rake spec` to run the tests and `bundle exec rake bench` to run the benchmark. To build and install this gem locally, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/laneb/congruence_solver.

data/Rakefile

@@ -1,87 +1,107 @@
-#require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rake/extensiontask"
-require "os"
-
-
-#exe runs the csolve binary
-task :exe do
-  $LOAD_PATH << "#{Dir.pwd}/lib/"
-  require_relative "bin/csolve.rb"
-end
-
-#spec runs all RSpec examples
-RSpec::Core::RakeTask.new :spec
-
-#uses task template provided by rake-compiler to run the extension compilation
-#workflow. Task name: compile (do not use task name: ext)
-Rake::ExtensionTask.new 'congruence_solver' do |ext|
-  ext.lib_dir = "lib/congruence_solver"
-end
-
-task :bench do
-  $LOAD_PATH << "#{Dir.pwd}/lib/"
-  Dir.foreach("bench") do |bm_file|
-    path = "bench/#{bm_file}"
-    if File.file? path and path =~ "_bm.rb^"
-      require_relative path
-    end
-  end
-end
-
-#update submodule containing extension. 
-
-task :fetch_ext do
-  EXT_DIR = "ext/congruence_solver"
-  `git submodule update --init --remote #{EXT_DIR}`
-end
-
-
-#executes compile task defined above, then cleans up the tmp directory that
-#rake-compiler leaves behind for some reason
-task :compile_ext => :compile do
-  if OS.windows? then 
-    `rmdir /s /q tmp` 
-  else 
-    `rm -rf tmp` 
-  end
-end
-
-
-task :update_ext => [:fetch_ext, :compile_ext]
-
-
-task :clean do
-  FILES_TO_RM_ARY = %w[congruence_solver-*.gem 
-            lib/congruence_solver/congruence_solver.so]
-
-  file_to_rm_str = FILES_TO_RM_ARY.inject("") {|file_list, file| file_list += file + " "}
-
-  if OS.windows?
-    `rm -f #{file_to_rm_str}`
-  else
-    `rm -f #{file_to_rm_str}`
-  end
-end
-
-
-task :build => [:compile_ext] do
-  GEMSPEC = "congruence_solver.gemspec"
-  `gem build #{GEMSPEC}`
-end
-
-
-task :install => [:clean, :build] do
-  dot_gem_files = Dir.entries(Dir.pwd).select {|f| f =~ /congruence_solver\-.*\.gem/}
-  if dot_gem_files.empty?  
-    STDERR.puts "Failed to build gem. Exiting."
-  elsif dot_gem_files.length > 1
-    STDERR.puts "Error: conflicting .gem files in directory. Exiting."
-  else
-    `gem install #{dot_gem_files.first}`
-  end
-end
-
-
-
-
+#require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rake/extensiontask"
+require "os"
+
+def verbose_sh_exec(cmd)
+  puts cmd
+  `#{cmd}`
+end
+
+def verbose_rm_files(files_to_rm_ary)
+  if OS.windows?
+    rm_cmd = "rm /s /q"
+  else
+    rm_cmd = "rm -rf"
+  end
+
+  files_to_rm_ary.each {|fname| verbose_sh_exec "#{rm_cmd} #{fname}"}
+end
+
+# runs the csolve binary
+task :exe do
+  $LOAD_PATH << "#{Dir.pwd}/lib/"
+  require_relative "bin/csolve.rb"
+end
+
+#spec runs all RSpec examples
+RSpec::Core::RakeTask.new :spec
+
+# run the tests shipped the extension
+task :ctest => [:compile_ext] do
+  verbose_sh_exec "(cd ext/congruence_solver && make test)"
+end
+
+task :test => [:ctest, :spec]
+
+# uses task template provided by rake-compiler to run the extension compilation
+# workflow
+Rake::ExtensionTask.new 'congruence_solver' do |ext|
+  ext.lib_dir = "lib/congruence_solver"
+end
+
+# runs benchmarks
+task :bench do
+  $LOAD_PATH << "#{Dir.pwd}/lib/"
+  Dir.foreach("bench") do |bm_file|
+    path = "bench/#{bm_file}"
+    if File.file? path and path =~ "_bm.rb^"
+      require_relative path
+    end
+  end
+end
+
+# download source files for the extension
+task :download_ext do
+  congruences_lib_url="https://github.com/laneb/congruences/archive/master.zip"
+  ext_dir = "ext/congruence_solver"
+  verbose_sh_exec "(cd #{ext_dir} && wget #{congruences_lib_url} && unzip master.zip && cp -r congruences-master/* . && rm -rf master.zip congruences-master )"
+end
+
+
+# executes compile task defined by RSpec, then cleans up the tmp directory that
+# rake-compiler for some reason leaves behind
+task :compile_ext => [:compile] do
+  verbose_rm_files ["./tmp"]
+end
+
+# remove all the source files for the extension
+task :purge_ext do
+  ext_files = `ls ext/congruence_solver`.split("\n").map {|fname| "ext/congruence_solver/" + fname}
+  perm_ext_files = `git ls-files ext/congruence_solver`.split("\n")
+  files_to_rm = ext_files - perm_ext_files
+
+  verbose_rm_files files_to_rm
+end
+
+task :update_ext => [:purge_ext, :download_ext, :compile_ext]
+
+# remove files generated or left behind by build
+task :clean do
+  files_to_rm = `find ext/congruence_solver/* -not -path "*.[ch]" -not -path *Makefile -not -path *extconf.rb`.split("\n")
+  verbose_rm_files files_to_rm
+end
+
+# build Ruby gem
+task :build => [:compile_ext] do
+  gemspec = "congruence_solver.gemspec"
+  verbose_sh_exec "gem build #{gemspec}"
+end
+
+# install gem locally
+task :install => [:clean, :update_ext, :test, :build] do
+  dot_gem_files = Dir.entries(Dir.pwd).select {|f| f =~ /congruence_solver\-.*\.gem/}
+  if dot_gem_files.empty?
+    STDERR.puts "Failed to build gem. Exiting."
+  elsif dot_gem_files.length > 1
+    STDERR.puts "Error: conflicting .gem files in directory. Exiting."
+  else
+    verbose_sh_exec "gem install #{dot_gem_files.first}"
+  end
+end
+
+task :publish => [:clean, :update_ext, :build] do
+  cmd = "gem push *.gem"
+  p cmd
+  system cmd
+end

data/bench/bench_tools.rb

@@ -1,33 +1,33 @@
-
-def polynomial_to_s(coeffs)
-    polynomial = ""
-    is_first_term = true
-
-    coeffs.reverse.each_with_index do |coe, idx|
-      exp = coeffs.length - idx - 1
-      if coe != 0
-        if is_first_term
-          is_first_term = false
-        else
-          if coe < 0
-            polynomial << " - "
-          else
-            polynomial << " + "
-          end
-        end
-
-        if coe.abs > 1 or (coe.abs == 1 and exp < 2)
-          polynomial << coe.abs.to_s
-        end
-
-        if exp > 0
-          polynomial << "x"
-          if exp > 1
-            polynomial << "^#{exp}"
-          end
-        end
-      end
-    end
-
-    polynomial
+
+def polynomial_to_s(coeffs)
+    polynomial = ""
+    is_first_term = true
+
+    coeffs.reverse.each_with_index do |coe, idx|
+      exp = coeffs.length - idx - 1
+      if coe != 0
+        if is_first_term
+          is_first_term = false
+        else
+          if coe < 0
+            polynomial << " - "
+          else
+            polynomial << " + "
+          end
+        end
+
+        if coe.abs > 1 or (coe.abs == 1 and exp < 2)
+          polynomial << coe.abs.to_s
+        end
+
+        if exp > 0
+          polynomial << "x"
+          if exp > 1
+            polynomial << "^#{exp}"
+          end
+        end
+      end
+    end
+
+    polynomial
 end

data/bench/solve_congruence_bm.rb

@@ -1,71 +1,71 @@
-require "congruence_solver"
-require "benchmark"
-require_relative "./bench_tools.rb"
-
-
-SMALL_DEG_POLYNOMIAL_COEFFS = [1, -4, 4] 
-LARGE_DEG_POLYNOMIAL_COEFFS = [-11, 0, 0, 3, 0, 0, 0, 0, 0, 10]
-SMALL_MOD = 49
-MED_MOD = 5104
-LARGE_MOD = 94122
-XTRA_LARGE_MOD = 401249
-XTRA_LARGE_PRIME_MOD = 306893
-SMALL_FACTORED_LARGE_MOD = 510510
-
-
-def solve_congruence_brute_force(coeffs, mod)
-  solutions = []
-
-  0.upto(mod) do |x|
-    sum = 0
-
-    coeffs.each_with_index do |coe, exp|
-      sum = (sum + coe*x**exp) % mod
-    end
-
-    if sum == 0 then solutions << x end
-  end
-
-  solutions
-end
-
-
-def bm_solve_congruence(coeffs, mod) 
-    puts "Solving #{polynomial_to_s(coeffs)} = 0 mod #{mod}"
-
-    rb_bf_solutions = solve_congruence_brute_force(coeffs, mod).sort
-    #c_bf_solutions = CongruenceSolver.brute_force(coeffs, mod).sort
-    c_lifting_solutions = CongruenceSolver.lift(coeffs, mod).sort
-
-    unless rb_bf_solutions == c_lifting_solutions #and c_bf_solutions c_lift_solutions
-      puts "Solutions do not match:"
-      puts "Ruby/force solutions #{rb_bf_solutions.inspect}"
-      #puts "C/force solutions #{c_bf_solutions}"
-      puts "C/lifting solutions: #{c_lifting_solutions.inspect}"
-    end
-
-    puts "Time measurements:"
-
-    Benchmark.bmbm do |bm|
-      bm.report("Ruby/force") do
-        solve_congruence_brute_force(coeffs, mod)
-      end
-=begin
-      bm.report("C/force") do
-        CongruenceSolver.brute_force(coeffs, mod)
-      end
-=end
-      bm.report("C/lifting") do
-        CongruenceSolver.lift(coeffs, mod)
-      end
-    end
-
-    print "\n\n"
-end
-
-
-[SMALL_DEG_POLYNOMIAL_COEFFS, LARGE_DEG_POLYNOMIAL_COEFFS].each do |coeffs|
-  [SMALL_MOD, MED_MOD, LARGE_MOD, XTRA_LARGE_MOD, XTRA_LARGE_PRIME_MOD, SMALL_FACTORED_LARGE_MOD].each do |mod|
-    bm_solve_congruence(coeffs, mod)
-  end
+require "congruence_solver"
+require "benchmark"
+require_relative "./bench_tools.rb"
+
+
+SMALL_DEG_POLYNOMIAL_COEFFS = [1, -4, 4] 
+LARGE_DEG_POLYNOMIAL_COEFFS = [-11, 0, 0, 3, 0, 0, 0, 0, 0, 10]
+SMALL_MOD = 49
+MED_MOD = 5104
+LARGE_MOD = 94122
+XTRA_LARGE_MOD = 401249
+XTRA_LARGE_PRIME_MOD = 306893
+SMALL_FACTORED_LARGE_MOD = 510510
+
+
+def solve_congruence_brute_force(coeffs, mod)
+  solutions = []
+
+  0.upto(mod) do |x|
+    sum = 0
+
+    coeffs.each_with_index do |coe, exp|
+      sum = (sum + coe*x**exp) % mod
+    end
+
+    if sum == 0 then solutions << x end
+  end
+
+  solutions
+end
+
+
+def bm_solve_congruence(coeffs, mod) 
+    puts "Solving #{polynomial_to_s(coeffs)} = 0 mod #{mod}"
+
+    rb_bf_solutions = solve_congruence_brute_force(coeffs, mod).sort
+    #c_bf_solutions = CongruenceSolver.brute_force(coeffs, mod).sort
+    c_lifting_solutions = CongruenceSolver.lift(coeffs, mod).sort
+
+    unless rb_bf_solutions == c_lifting_solutions #and c_bf_solutions c_lift_solutions
+      puts "Solutions do not match:"
+      puts "Ruby/force solutions #{rb_bf_solutions.inspect}"
+      #puts "C/force solutions #{c_bf_solutions}"
+      puts "C/lifting solutions: #{c_lifting_solutions.inspect}"
+    end
+
+    puts "Time measurements:"
+
+    Benchmark.bmbm do |bm|
+      bm.report("Ruby/force") do
+        solve_congruence_brute_force(coeffs, mod)
+      end
+=begin
+      bm.report("C/force") do
+        CongruenceSolver.brute_force(coeffs, mod)
+      end
+=end
+      bm.report("C/lifting") do
+        CongruenceSolver.lift(coeffs, mod)
+      end
+    end
+
+    print "\n\n"
+end
+
+
+[SMALL_DEG_POLYNOMIAL_COEFFS, LARGE_DEG_POLYNOMIAL_COEFFS].each do |coeffs|
+  [SMALL_MOD, MED_MOD, LARGE_MOD, XTRA_LARGE_MOD, XTRA_LARGE_PRIME_MOD, SMALL_FACTORED_LARGE_MOD].each do |mod|
+    bm_solve_congruence(coeffs, mod)
+  end
 end