factorial-cached 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Yiğitcan UÇUM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+ruby-factorial-cached
+=====================
+
+factorial-cached is a gem which aims to fasten your consecutively made factorial operations with caching. This gem was half-way done because of a little Project Euler adventure of mine. Please make any pull requests that you think will fasten the operations and i will check it out and update the gem on rubygems asap.
+
+Usage
+=====
+
+### Installation
+
+```
+gem install factorial-cached
+```
+
+### Options
+
+You can pass some parameters to factorial method to your needs. Above are the options and their default values.
+
+```ruby
+
+ # Caching
+
+:cache_none # Doesn't caches any calculated factorial.
+:cache_all # Caches all the possible invocation/iteration results. This option is not recommended if you will work with high numbers.
+:cache_one # Caches only the given numbers results. (DEFAULT)
+
+ # Algorithm
+
+:iterative # Iterative implementation of the Factorial Algorithm. Good if you will calculate high numbers.
+:recursive # Recursive implementation of the Factorial Algorithm. Good if you want speed on low numbers.
+:auto # Iterative if number > 100.000, Recursive if below or equal. (DEFAULT)
+
+ # Closest
+
+:value # Returns value of the closest factorial.
+:factorial # Returns closest cached factorial.
+
+```
+
+### Code
+
+```ruby
+require 'factorial-cached'
+
+5.factorial # => 120 - Caches 5 factorial only.
+8.factorial(:cache_all) #=> 40320 - Caches through 6..8 factorial.
+7.factorial #=> 5040 - Returns by Dividing cached 8! / 8
+
+Factorial::factorial(5, :iterative, :cache_all) #=> Same deal as the Integer#factorial
+
+Factorial::closest(5) #=> 5 - Returns closest cached factorial by the given number.
+Factorial::closest(5, :value) #=> 120 - Returns closest cached factorial's value by the given number.
+
+Factorial::empty_cache() # Empties cache if you don't want to have memory issues.
+Factorial::empty_cache(5..8) # Emtpies cache through 5..8 factorial.
+
+Factorial::get_cache() # => { 0 => 1} in this case.
+
+Factorial::toggle(:cache, :cache_none) # Toggles default of caching to none, further factorial calculations will not be cached by default.
+Factorial::toggle(:algorithm, :iterative) # Togglest default algorithm to iterative algorithm.
+Factorial::toggle(:closest, :value) # Closest now returns value of the factorial default.
+
+5.factorial => Returns 5, caches nothing.
+5.factorial(:cache_one) => Calculates 5!, caches 5! only. (This is the default behaviour of this gem)
+5.factorial => Returns 5! from cache.
+
+```
+
+License
+=======
+
+MIT: [External Link to License](http://opensource.org/licenses/MIT)

data/lib/Factorial.rb~

@@ -0,0 +1,69 @@
+class Factorial
+	
+	@@cache = { 
+		0 => 1, 1 => 1, 2 => 2, 3 => 6, 4 => 24, 5 => 120, 6 => 720, 7 => 5040, 8 => 40320, 9 => 3628800, 10 => 36288000, 11 => 39916800, 12 => 479001600, # Below 32 bit
+		14 => 87178291200, 20 => 2432902008176640000, 30 => 265252859812191058636308480000000, 50 => 30414093201713378043612608166064768844377641568960512000000000000, # Below are milestones for 1-100!
+		70 => 11978571669969891796072783721689098736458938142546425857555362864628009582789845319680000000000000000,
+		100 => 93326215443944152681699238856266700490715968264381621468592963895217599993229915608941463976156518286253697920827223758251185210916864000000000000000000000000 
+	};
+	
+	class << self
+		
+		def closest(number, option = :factorial)
+			close = (@@cache.keys.sort{ |x, y| (x - number).abs <=> (y - number).abs })[0];
+			return option == :value	? @@cache[close] : close;
+		end
+
+		def recursive_factorial(number, cache = :cache, close = -1)
+
+			return @@cache[number] if number == close;
+			
+			if close == -1 then
+				close = self.closest(number);
+				puts "Using Cache: " + close.to_s
+			end		
+
+			result = close < number ? number * recursive_factorial(number - 1, cache, close) : recursive_factorial(number + 1, cache, close) / (number + 1);
+			
+			@@cache[number] = result if cache == :cache_all;
+
+			return result;
+
+		end
+
+		def iterative_factorial(number, cache = :cache)	
+
+			closest = self.closest(number);
+			puts "Using Cache: " + close.to_s
+			loopThrough = closest < number ? ((closest + 1)..number) : ((number + 1)..closest);
+			result = @@cache[closest];			
+
+			for i in loopThrough do
+				
+				if closest < number then result *= i; else result /= i; end
+				@@cache[i] = result if cache == :cache_all;
+
+			end
+			
+			return result;
+		end
+
+		def factorial(number, *options)
+				
+			return @@cache[number] if @@cache.has_key?(number);
+			return 1 if number <= 0;			
+
+			factorial = method(options.include?(:iterative) || number > 100000 ? :iterative_factorial : :recursive_factorial);
+			cache = options.include?(:cache_none) ? :cache_none : options.include?(:cache_all) ? :cache_all : :cache;	
+
+			result = factorial.call(number, cache);
+
+			@@cache[number] = result if cache != :cache_none;
+			
+			return factorial;
+
+		end
+
+	end
+
+end

data/lib/Integer.rb~

@@ -0,0 +1,7 @@
+load(File.dirname(__FILE__) + '/Factorial.rb');
+
+class Integer
+	def factorial(*options)
+		return Factorial::factorial(self, *options); 
+	end
+end

data/lib/factorial-cached.rb

@@ -0,0 +1,2 @@
+require 'factorial-cached/Factorial.rb'
+require 'factorial-cached/Integer.rb'

data/lib/factorial-cached/Factorial.rb

@@ -0,0 +1,93 @@
+class Factorial
+	
+	@@cache = { 
+		0 => 1, 1 => 1, 2 => 2, 3 => 6, 4 => 24, 5 => 120, 6 => 720, 7 => 5040, 8 => 40320, 9 => 3628800, 10 => 36288000, 11 => 39916800, 12 => 479001600, # Below 32 bit
+		14 => 87178291200, 20 => 2432902008176640000, 30 => 265252859812191058636308480000000, 50 => 30414093201713378043612608166064768844377641568960512000000000000, # Milestones for 1-100!
+		70 => 11978571669969891796072783721689098736458938142546425857555362864628009582789845319680000000000000000,
+		100 => 93326215443944152681699238856266700490715968264381621468592963895217599993229915608941463976156518286253697920827223758251185210916864000000000000000000000000 
+	};
+
+	@@default = { :cache => :cache_one, :algorithm => :recursive, :closest => :factorial };
+	
+	class << self
+		
+		def empty_cache( range = nil )
+			if range != nil then
+				range.each{ |key| @@cache.delete(key); };
+				@@cache[0] = 1;
+			else @@cache = {0 => 1};  end
+		end
+
+		def get_cache()
+			return @@cache;
+		end
+
+		def toggle(setting, default)
+			if setting == :cache then
+				@@default[:cache] = default;
+			elsif setting == :algorithm then
+				@@default[:algorithm] = default;
+			elsif setting == :closest then
+				@@default[:closest] = default;
+			end
+		end
+	
+		def closest(number, option = @@default[:closest])
+			close = (@@cache.keys.sort{ |x, y| (x - number).abs <=> (y - number).abs })[0];
+			return option == :value	? @@cache[close] : close;
+		end
+
+		def recursive_factorial(number, cache = @@default[:cache], close = -1)
+	
+			return @@cache[number] if close == number;
+
+			if close == -1 then
+				close = self.closest(number, :factorial);
+			end
+
+			result = close < number ? number * recursive_factorial(number - 1, cache, close) : recursive_factorial(number + 1, cache, close) / (number + 1);
+			
+			@@cache[number] = result if cache == :cache_all;
+
+			return result;
+		end
+
+		def iterative_factorial(number, cache = @@default[:cache])
+
+			closest = self.closest(number, :factorial);
+			loopThrough = closest < number ? ((closest + 1)..number) : ((number + 1)..closest);
+			result = @@cache[closest];			
+
+			for i in loopThrough do
+				
+				if closest < number then result *= i; else result /= i; end
+				@@cache[i] = result if cache == :cache_all;
+
+			end
+			
+			return result;
+		end
+
+		def factorial(number, *options)
+				
+			return @@cache[number] if @@cache.has_key?(number);
+			return 1 if (number = number.to_i) <= 0 || !number.is_a?(Integer);			
+				
+			factorial = method(options.include?(:iterative) ? :iterative_factorial : 
+								options.include?(:recursive) ? :recursive_factorial :
+									options.include?(:auto) ? (number > 100000 ? :iterative_factorial : :recursive_factorial) : 
+										@@default[:algorithm] == :recursive ? :recursive_factorial : 
+												@@default[:algorithm] == :auto ? (number > 100000 ? :iterative_factorial : recursive_factorial) : :iterative_factorial);
+			cache = options.include?(:cache_none) ? :cache_none : options.include?(:cache_all) ? :cache_all : options.include?(:cache_one) ? :cache_one : @@default[:cache];	
+			
+			result = factorial.call(number, cache);
+
+			@@cache[number] = result if cache != :cache_none;
+			
+			return result;
+
+		end
+
+	end
+
+end

data/lib/factorial-cached/Integer.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/Factorial.rb'
+
+class Integer
+	def factorial(*options)
+		return Factorial::factorial(self, *options); 
+	end
+end

data/lib/factorial-cached/Integer.rb~

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/Factorial.rb'
+
+class Integer
+	def factorial(*options)
+		return Factorial::factorial(self, *options); 
+	end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: factorial-cached
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yiğitcan UÇUM
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies: []
+description: This gem is specifically made for getting your factorial operations faster.
+  This gem was half made already when i decided to make it because of my needs of
+  factorial operations in Project Euler.
+email: yigitcan@hotmail.com.tr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/factorial-cached.rb~
+- lib/Factorial.rb~
+- lib/factorial-cached/Integer.rb
+- lib/factorial-cached/Factorial.rb
+- lib/factorial-cached/Integer.rb~
+- lib/Integer.rb~
+- lib/factorial-cached.rb
+homepage: http://rubygems.org/gems/factorial-cached
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A gem for making your factorial operations faster.
+test_files: []