dgoldhirsch-cs 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 dgoldhirsch
+
+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.rdoc

@@ -0,0 +1,7 @@
+= cs
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 dgoldhirsch. See LICENSE for details.

data/lib/cs.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+
+# Title:: Computer Science Library for Ruby
+# Author:: David C. Goldhirsch
+# Copyright (c) 2009, David C. Goldhirsch
+class CS
+  # Fibonacci number generator.
+  # Return integer value of F(n) for any integer n >= 1,
+  # where F(n) is defined as F(n - 1) + F(n - 2) for n > 2, F(2) = 1
+  # and F(1) = 0.
+  #
+  # E.g., the sequence (F(1), ..., F(7)) is (0, 1, 1, 2, 3, 5, 8).
+  #
+  # Values of n less than 1 are equivalent to n = 1.
+  def self.fibonacci n
+    return 0 if n <= 1
+    return (FibonacciSecondOrHigher.advanced_by n - 2).result
+  end
+
+  private
+
+  # The class 'new' method is privatized, because users should not be
+  # instantiating this class.
+  def self.new
+    super.new
+  end
+end
+
+private
+
+# Fibonacci generating class, each of whose instances represents F(2 + k)
+# for some given k. To obtain the integer value of F(w), use the 'result' method, e.g.:
+# - f = FibonacciSecondOrHigher.new
+# - f.result # the integer 1 = F(2)
+# - f.advance
+# - f.result # the integer 2 = F(3)
+# - etc.
+class FibonacciSecondOrHigher
+  attr_accessor :result
+  attr_accessor :previous
+  attr_accessor :second_previous  # non-nil only for F(3) and higher
+
+  # This is the proper way to create an instance
+  # representing F(2 + k).  Please use this instead of 'new'.
+  # Return an instance representing F(2 + k) for given k.
+  # E.g., if k is 0, the result is F(2);  if k is 1, the
+  # result is F(3);  if k is 4 the result is F(6)
+  def self.advanced_by k
+    return (1..k).inject(FibonacciSecondOrHigher.new) do |f, i|
+      f.advance
+    end
+  end
+
+  # Change internal state such that if the receiver currently
+  # represents F(k) it will be advanced to represent F(k + 1).
+  def advance
+    self.second_previous = self.previous
+    self.previous = self.result
+    self.result += self.second_previous # i.e., second_previous + previous
+    return self
+  end
+
+  def to_s
+    return second_previous.to_s + "," + previous.to_s + "," + "=>" + result.to_s
+  end
+
+  private
+
+  # Instances represent F(2), unless/until they are advanced
+  def initialize
+    self.previous = 0 # F(<= 1)
+    self.result = 1 # F(2)
+  end
+end

data/test/cs_test.rb

@@ -0,0 +1,57 @@
+require "test_helper"
+
+class FibonacciTest  < Test::Unit::TestCase
+
+  # Basic test of CS::fibonacci.  Verify correctness of F(1, ...)
+  # as (0, 1, 1, 2, 3, 5, 8...).
+  def test_basic
+    assert_equal 0, CS::fibonacci(1)
+    assert_equal 1, CS::fibonacci(2)
+    assert_equal 1, CS::fibonacci(3)
+    assert_equal 2, CS::fibonacci(4)
+    assert_equal 3, CS::fibonacci(5)
+    assert_equal 5, CS::fibonacci(6)
+    assert_equal 8, CS::fibonacci(7)
+  end
+
+  # The assertion in this test is meaningless.  The point of running this test
+  # is to be sure that Fibonacci numbers up to some large number can be computed
+  # within a reasonable CPU/memory footprint.  For example, if a recursive rather
+  # than a linear algorithm were used, this test case would require 2**10,000 recursive
+  # calls, and the test would probably run out of memory.
+  def test_raw_performance
+    x = CS::fibonacci(10000);
+    assert x > 0
+  end
+
+  #The following function will take a massive amount of CPU time and an impossible amount of memory,
+  #because it uses the 2**n recursive algorithm to compute Fibonacci number n.  If you want
+  #proof that the recursive algorithm is intractible, rename this function 'test_something', and
+  #watch your test runner run out of memory (slowly......)
+  def zzz_test_recursive  # rename test_recursive, if you want to run it
+    assert_equal 0, recursive_fibonacci(1)
+    assert_equal 1, recursive_fibonacci(2)
+    assert_equal 1, recursive_fibonacci(3)
+    assert_equal 2, recursive_fibonacci(4)
+    assert_equal 3, recursive_fibonacci(5)
+    assert_equal 5, recursive_fibonacci(6)
+    assert_equal 8, recursive_fibonacci(7)
+    x = recursive_fibonacci(1000); # gonna take a loooooonnnnnngggggg time.....
+    assert x > 0
+  end
+
+  private
+  
+  # Seemingly innocent, recursive algorithm that computes the nth Fibonacci number.
+  # Requires 2**n recursive calls, requiring an obscene amount of memory and CPU time.
+  # Try it for n = 1000, and then twiddle your thumbs while waiting for the "out of memory"
+  # exception... 
+  def recursive_fibonacci(n)
+    if(n == 1)
+      return 0
+    elsif(n == 2 || n == 3)
+      return 1
+    end
+    return recursive_fibonacci(n - 2) + recursive_fibonacci(n - 1)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cs'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: dgoldhirsch-cs
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- dgoldhirsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-06 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dgoldhirsch@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/cs.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/dgoldhirsch/cs
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Computer Science Library for Ruby
+test_files: 
+- test/cs_test.rb
+- test/test_helper.rb