congruence_solver 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb92ff33b8d060a03e8a3d7012e4245a39df5583
-  data.tar.gz: b07e0989fc34a3c4126e4dbfff4100b2dc8d9f5f
+  metadata.gz: b0efc553f7421a673f9a66fcb7b3b0940f7f2f82
+  data.tar.gz: 0146a9f00b2bf9f1ec49ae9180f4b82b817e3bf5
 SHA512:
-  metadata.gz: f904157465b3870e19e18b7e5d567a99cd3012a52f9c892eb5ebeaf51eaa08e8cabee1979bb386b1c52be0640b9eac60803f6f562333e4c8232f24b01a9a2d98
-  data.tar.gz: 1c912d27c225d6b9d6cd06d5b0509a406ae336714dbb1f63c3af778f7dc62358afdfbd319891e1745bf455ed66f1f87d795d5d816b5ac3902dd080edf9c8982a
+  metadata.gz: cb9842feb8b1d72d26cfc1b6efbf86dcc357ee1a1c070dedcf6498c6a1c0c33f2cf96a5a9a0db5a224da1a74d751de3d8018dabf5bc9f67ce98126c672ee5e98
+  data.tar.gz: 3c3bae47bde1f4d7d5cdd91b157b6a4b3e345859af280db80a5a311bf503577d56b70b7fa2a38829a909bb1e4f0dba93bad284c257a6cfb6b980cbd8c97220b6

data/.gitignore

@@ -1,6 +1,6 @@
-Gemfile
 Gemfile.lock
 tmp/
 todo
 lib/congruence_solver/congruence_solver.so
-*.gem
+*.gem
+*.html

data/.gitmodules

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in congruence_solver.gemspec
+gemspec

data/README.md

@@ -2,25 +2,34 @@
 
 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
 
-Add this line to your application's Gemfile:
+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 then execute:
+and executing
 
-    $ bundle
-
-Or install it yourself as:
+```shell
+$ bundle
+```
 
-    $ gem install congruence_solver
+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.
+To solve a polynomial congruence at the command line, simply invoke `csolve` and then enter the congruence at the prompt. 
 
 ```
 csolve
@@ -47,9 +56,7 @@ CongruenceSolver.solve_congruence(coeffs, mod).sort  #=> [1, 8, 15, 22, 26, 29,
 
 ## Development
 
-After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests, or rake bench to run the benchmark.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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
 

data/Rakefile

@@ -1,23 +1,13 @@
 #require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require 'rake/extensiontask'
+require "rake/extensiontask"
+require "os"
 
 
-
-
-=begin
-namespace :test do
-	desc "Compile and unit test C extensions"
-	Rspec::Core::RakeTask.new :c => :compile_c do |t|
-		t.rspec_opts = C_SPEC_FILE
-	end
-end
-=end
-
 #exe runs the csolve binary
 task :exe do
-	$LOAD_PATH << "#{Dir.pwd}/lib/"
-	require_relative "bin/csolve.rb"
+  $LOAD_PATH << "#{Dir.pwd}/lib/"
+  require_relative "bin/csolve.rb"
 end
 
 #spec runs all RSpec examples
@@ -26,27 +16,71 @@ 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"
+  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
+  $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_c => :compile do
-	CLEAN_CMD = "rmdir /s /q tmp"
-	system CLEAN_CMD
+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
 
 
 

data/bench/bench_tools.rb

@@ -1,33 +1,33 @@
 
 def polynomial_to_s(coeffs)
-		polynomial = ""
-		is_first_term = true
+    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
+    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 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
+        if exp > 0
+          polynomial << "x"
+          if exp > 1
+            polynomial << "^#{exp}"
+          end
+        end
+      end
+    end
 
-		polynomial
+    polynomial
 end

data/bench/solve_congruence_bm.rb

@@ -14,58 +14,58 @@ SMALL_FACTORED_LARGE_MOD = 510510
 
 
 def solve_congruence_brute_force(coeffs, mod)
-	solutions = []
+  solutions = []
 
-	0.upto(mod) do |x|
-		sum = 0
+  0.upto(mod) do |x|
+    sum = 0
 
-		coeffs.each_with_index do |coe, exp|
-			sum = (sum + coe*x**exp) % mod
-		end
+    coeffs.each_with_index do |coe, exp|
+      sum = (sum + coe*x**exp) % mod
+    end
 
-		if sum == 0 then solutions << x end
-	end
+    if sum == 0 then solutions << x end
+  end
 
-	solutions
+  solutions
 end
 
 
 def bm_solve_congruence(coeffs, mod) 
-		puts "Solving #{polynomial_to_s(coeffs)} = 0 mod #{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
+    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
+    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:"
+    puts "Time measurements:"
 
-		Benchmark.bmbm do |bm|
-			bm.report("Ruby/force") do
-				solve_congruence_brute_force(coeffs, mod)
-			end
+    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
+      bm.report("C/force") do
+        CongruenceSolver.brute_force(coeffs, mod)
+      end
 =end
-			bm.report("C/lifting") do
-				CongruenceSolver.lift(coeffs, mod)
-			end
-		end
+      bm.report("C/lifting") do
+        CongruenceSolver.lift(coeffs, mod)
+      end
+    end
 
-		print "\n\n"
+    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
+  [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

data/bin/csolve.rb

@@ -7,8 +7,8 @@ SOLVE_CONGRUENCE_BENCH_FILE = "../bench/solve_congruence_bm.rb"
 
 
 if ARGV.pop == "bench"
-	require_relative SOLVE_CONGRUENCE_BENCH_FILE
-	exit(0)
+  require_relative SOLVE_CONGRUENCE_BENCH_FILE
+  exit(0)
 end
 
 CONGRUENCE_FORMAT = "(lhs polynomial) = (rhs polynomial) mod (modulus)"
@@ -21,34 +21,34 @@ MOD_INVALID_MSG = "Mod invalid: modulus must be an integer greater than 2"
 puts "Congruence to solve:"
 
 begin
-	coeffs, mod = PolynomialInterpreter.read_congruence(STDIN.gets)
+  coeffs, mod = PolynomialInterpreter.read_congruence(STDIN.gets)
 rescue ArgumentError => e
-	if(e == PolynomialInterpreter::Errors::CONGRUENCE_INVALID)
-		STDERR.puts CONGRUENCE_INVALID_MSG
-		exit(1)
+  if(e == PolynomialInterpreter::Errors::CONGRUENCE_INVALID)
+    STDERR.puts CONGRUENCE_INVALID_MSG
+    exit(1)
 
-	elsif(e == PolynomialInterpreter::Errors::LHS_POLYNOMIAL_INVALID)
-		STDERR.puts LHS_INVALID_MSG
-		exit(1)
+  elsif(e == PolynomialInterpreter::Errors::LHS_POLYNOMIAL_INVALID)
+    STDERR.puts LHS_INVALID_MSG
+    exit(1)
 
-	elsif(e == PolynomialInterpreter::Errors::RHS_POLYNOMIAL_INVALID)
-		STDERR.puts RHS_INVALID_MSG
-		exit(1)
+  elsif(e == PolynomialInterpreter::Errors::RHS_POLYNOMIAL_INVALID)
+    STDERR.puts RHS_INVALID_MSG
+    exit(1)
 
-	elsif(e == PolynomialInterpreter::Errors::MOD_INVALID)
-		STDERR.puts MOD_INVALID_MSG
-		exit(1)
+  elsif(e == PolynomialInterpreter::Errors::MOD_INVALID)
+    STDERR.puts MOD_INVALID_MSG
+    exit(1)
 
-	else
-		raise e
-	end
+  else
+    raise e
+  end
 end
 
 solutions = CongruenceSolver.lift(coeffs, mod).sort
 
 if solutions.empty? 
-	puts "No solution."
+  puts "No solution."
 else
-	puts "Solutions:"
-	solutions.each_with_index {|sol, i| puts "(#{i}) #{sol}"}
+  puts "Solutions:"
+  solutions.each_with_index {|sol, i| puts "(#{i}) #{sol}"}
 end

data/congruence_solver.gemspec

@@ -18,12 +18,11 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split("\n")
   spec.files        += `git submodule --quiet foreach pwd`.split("\n").map do |abs_dir|
                           abs_dir = abs_dir.gsub(/^c:/, "C:")
-                          root = Dir::pwd
-                          dir_in_proj = abs_dir.gsub(/^#{root}\/?/, "")
-                          Dir::chdir(abs_dir)
-                          files = `git ls-files`.split("\n")
-                          Dir::chdir(root)
-                          files.map {|fname| "#{dir_in_proj}/#{fname}"}
+                          dir_in_proj = abs_dir.gsub(/^#{Dir.pwd}\/?/, "")
+                          Dir.chdir(abs_dir) do
+                            files = `git ls-files`.split("\n")
+                            files.map {|fname| "#{dir_in_proj}/#{fname}"}
+                          end
                         end.flatten
   spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -35,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 2.4"
   spec.add_development_dependency "rake-compiler", "~>0.9"
+  spec.add_development_dependency "os", "~>0.9"
 end

data/ext/congruence_solver/arith_utils.c

@@ -3,130 +3,127 @@
 #include "prime_gen.h"
 #include "arith_utils.h"
 
-
+//Expects 0 <= x,y < mod
 int mod_sum(int x, int y, int mod){
-	x %= mod;
-	y %= mod;
-
-	if(y >= mod - x){
-		return y - (mod - x);
-	}
+  if(y >= mod - x){
+    return y - (mod - x);
+  }
 
-	else{
-		return y + x;
-	}
+  else{
+    return y + x;
+  }
 }
 
 
 int mod_inv(int n, int mod){
-	int y, a;
+  int y, a;
 
-	if(n!=0){
+  if(n!=0){
 
-		while(n<0){
-			n+=mod;
-		}
+    while(n<0){
+      n+=mod;
+    }
 
-		for(y = 1; y < mod; y++){
-			a = mod_product(y, n, mod);
+    for(y = 1; y < mod; y++){
+      a = mod_product(y, n, mod);
 
-			if(a == 1){
-				return y;
-			}
-		}
-	}
+      if(a == 1){
+        return y;
+      }
+    }
+  }
 
-	return 0;
+  return 0;
 }
 
 
 int coprime(int n1, int n2){
-	//naive algorithm but efficient when n1 has already been factorized
-	int * n1Factors = prime_factors(n1);
-	int numOfFactors = *n1Factors;
-	int * factors = n1Factors+1;
-	int shareFactor = 0;
-	int i;
-
-	for(i=0; i<numOfFactors; i++){
-		if(n2 % factors[i] == 0){
-			shareFactor = 1;
-			break;
-		}
-	}
-
-	free(n1Factors);
-
-	return !shareFactor;
+  //naive algorithm but efficient when n1 has already been factorized
+  int * n1Factors = prime_factors(n1);
+  int numOfFactors = *n1Factors;
+  int * factors = n1Factors+1;
+  int shareFactor = 0;
+  int i;
+
+  for(i=0; i<numOfFactors; i++){
+    if(n2 % factors[i] == 0){
+      shareFactor = 1;
+      break;
+    }
+  }
+
+  free(n1Factors);
+
+  return !shareFactor;
 }
 
 
 int mod_product(int num1, int num2, int mod){
-	int prod = 0;
-	int i;
+  int prod = 0;
+  int i;
 
-	for(i = 0; i < num1; i++){
-		prod = mod_sum(prod, num2, mod);
-	}
+  for(i = 0; i < num1; i++){
+    prod = mod_sum(prod, num2, mod);
+  }
 
-	return prod;
+  return prod;
 }
 
-
+//expects 0 <= n < mod
 int mod_power(int n, int power, int mod){
-	int product = n;
-	int i;
+  int product = n;
+  int i;
 
-	for(i = 1; i < power; i++){
-		product = mod_product(product, n, mod);
-	}
+  for(i = 1; i < power; i++){
+    product = mod_product(product, n, mod);
+  }
 
-	return product;
+  return product;
 }
 
 
 int totient(int n){
-	int * divisorList = prime_factors(n);
-	int listLength = divisorList[0];
-	int * divisors = divisorList+1;
-	int i;
+  int * divisorList = prime_factors(n);
+  int listLength = divisorList[0];
+  int * divisors = divisorList+1;
+  int i;
 
-	for(i = 0; i < listLength; i++){
-		n *= (divisors[i] - 1);
-		n /= divisors[i];
-	}
+  for(i = 0; i < listLength; i++){
+    n *= (divisors[i] - 1);
+    n /= divisors[i];
+  }
 
-	free(divisorList);
+  free(divisorList);
 
-	return n;
+  return n;
 }
 
 
 
 
 int mod_eval_polynomial(int degree, int coeffs[], int mod, int x){
-	int sum = coeffs[0];
+	int tot = coeffs[degree];
 	int i;
 
-	for(i = 1; i <= degree; i++){
-		sum += mod_power(x, i, mod)*coeffs[i];
-		sum %= mod;
+	for(i = degree - 1; i >= 0; i--){
+		tot = mod_product(tot, x, mod);
+		tot = mod_sum(tot, coeffs[i], mod);
 	}
 
-	return sum;
+	return tot;
 }
 
 
 long  eval_polynomial(int degree, int coeffs[], int x){
-	long int sum = coeffs[0];
- 	long int powx;
-	int i;
+  long int sum = coeffs[0];
+   long int powx;
+  int i;
 
-	for(i = 1, powx = x; i <= degree; i++, powx*=x){
-		sum += powx*coeffs[i];
-	}
+  for(i = 1, powx = x; i <= degree; i++, powx*=x){
+    sum += powx*coeffs[i];
+  }
 
-	return sum;
+  return sum;
 }