continued_fractions 0.1.11 → 1.2.0

data/History.txt

@@ -1,3 +1,22 @@
+=== 1.2.0 / 2010-03-18
+
+* Changed parameter signature of ContinuedFraction#convergents_as_rationals.  Added a nth parameter to select the length of the convergents to return.
+
+=== 1.1.0 / 2010-03-18
+
+* Changed the public class representation of convergents from an array of Rationals to an array of arrays.
+* Removed convergents_array (unnecessary since ContinuedFraction#convergents now returns an array).
+* Added ContinuedFraction#convergents_as_rationals which facilitate returning convergents as Rationals.
+* Changed names of index variables to be more descriptive.
+* Changed documentation to reflect change of class type returned by ContinuedFraction#convergents.
+* Changed tests to deal with new class type returned by ContinuedFraction#convergents.
+
+=== 0.1.12 / 2010-03-18
+
+* Added examples in the documentation.
+* Moved convergents to the Class level to make it accessible to use with any quotient array passed to it.
+
+
 === 0.1.11 / 2010-03-16
 
 * Changed names of some variable to provide better in-code documentation.

data/README.txt

@@ -45,6 +45,7 @@ sudo gem install continued_fractions
 == Developers:
 
 * Ruby 1.9+
+* RSpec required to run tests.
 * Echoe required to run rake tasks.
 
 == License:

data/Rakefile

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('continued_fractions', '0.1.11') do |config|
+Echoe.new('continued_fractions', '1.2.0') do |config|
   config.summary                  = 'Generate continued fractions.'
   config.author                   = 'Jose Hales-Garcia'
   config.url                      = 'http://bitbucket.org/jolohaga/continued_fractions/'
   config.email                    = 'jolohaga@me.com' 
   config.ignore_pattern           = ["tmp/*",".hg/*", ".pkg/*"]
-  config.development_dependencies = ['rspec']
+  config.development_dependencies = ['rspec >=1.3.0','echoe >=4.3']
 end
 
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each{|ext| load ext}

data/continued_fractions.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{continued_fractions}
-  s.version = "0.1.11"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jose Hales-Garcia"]
-  s.date = %q{2010-03-16}
+  s.date = %q{2010-03-18}
   s.description = %q{Generate continued fractions.}
   s.email = %q{jolohaga@me.com}
   s.extra_rdoc_files = ["README.txt", "lib/continued_fractions.rb"]
@@ -23,11 +23,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<echoe>, [">= 4.3"])
     else
-      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<echoe>, [">= 4.3"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<echoe>, [">= 4.3"])
   end
 end

data/lib/continued_fractions.rb

@@ -31,27 +31,56 @@ module ContinuedFractions
       @convergents = calculate_convergents
     end
     
-    # Return nth (pre-calculated) convergent.
+    # Return nth convergent.
     #
-    def convergent(n)
-      convergents[n]
+    # Example:
+    #   cf = ContinuedFraction.new(Math::PI,10)
+    #   cf.convergent(3)
+    #   => [355,113]
+    #
+    def convergent(nth)
+      convergents[nth]
     end
     
-    # Return array of convergents as Rationals.
+    # Return array of convergents of the continued fraction instance up to the nth convergent as an array
+    # comprising of numerators in [i,0] and denominators in [i,1].
+    # If nth is nil, then return the entire list.
+    #
+    # Example:
+    #   cf = ContinuedFraction.new(Math::PI,10)
+    #   cf.convergents
+    #   => [[3,1], [22,7], [333,106], [355,113], [103993,33102],
+    #       [104348,33215], [208341,66317], [312689,99532], [833719,265381], [1146408,364913]]
+    #
+    # Or:
+    #   cf.convergents(3)
+    #   => [[3,1], [22,7], [333,106]]
     #
-    def convergents
-      _convergents.map{|c| Rational(c[0],c[1])}
+    def convergents(nth=nil)
+      _convergents(nth)
     end
     
-    # Return array of convergents, each as a two-element array with the numerator in [i,0] and denominator in [i,1].
+    # Return array of convergents of the continued fraction instance converted as Rationals.
+    # If nth is nil, then return the entire list.
     #
-    def convergents_array
-      _convergents
+    # Example:
+    #   cf = ContinuedFraction.new(Math::PI,10)
+    #   cf.convergents_as_rationals
+    #   => [(3/1), (22/7), (333/106), (355/113), (103993/33102),
+    #       (104348/33215), (208341/66317), (312689/99532), (833719/265381), (1146408/364913)]
+    #
+    # Or:
+    #   cf.convergents_as_rationals(3)
+    #   => [(3/1), (22/7), (333/106)]
+    #
+    def convergents_as_rationals(nth=nil)
+      ContinuedFractions.convergents_array_to_rationals(convergents,nth)
     end
 
     private
-    def _convergents
-      @convergents[2..@convergents.length]
+    def _convergents(nth=nil)
+      nth ||= @convergents.length
+      @convergents[0...nth]
     end
 
     def calculate_quotients
@@ -65,13 +94,7 @@ module ContinuedFractions
     end
 
     def calculate_convergents
-      convs = ContinuedFractions.convergence_matrix(@limit+2,2,1)
-      2.upto(@limit+1) do |i|
-        i_1,i_2 = i-1,i-2
-        convs[i][0] = convs[i_1][0]*quotients[i_2]+convs[i_2][0]
-        convs[i][1] = convs[i_1][1]*quotients[i_2]+convs[i_2][1]
-      end
-      convs
+      ContinuedFractions.convergents(quotients)
     end
   end
 
@@ -81,5 +104,40 @@ module ContinuedFractions
       conv_mat[0][0],conv_mat[1][1] = 0,0
       conv_mat
     end
+    
+    # Given an array of quotients return the array of convergents up to the nth convergent.
+    # If nth is nil, return the entire list.
+    #
+    # Example:
+    #   ContinuedFractions.convergents([3,7,15,1])
+    #   => [[3, 1], [22, 7], [333, 106], [355, 113]]
+    #
+    # Or:
+    #   ContinuedFractions.convergents([3,7,15,1], 3)
+    #   => [[3, 1], [22, 7], [333, 106]]
+    #
+    def convergents(quotients,nth=nil)
+      convs = ContinuedFractions.convergence_matrix(quotients.length+2,2,1)
+      nth ||= convs.length
+      2.upto(quotients.length+1) do |i|
+        i_minus1,i_minus2 = i-1,i-2
+        convs[i][0] = convs[i_minus1][0]*quotients[i_minus2]+convs[i_minus2][0]
+        convs[i][1] = convs[i_minus1][1]*quotients[i_minus2]+convs[i_minus2][1]
+      end
+      convs[2...nth+2]
+    end
+    
+    # Convert the convergents array to Rationals
+    #
+    def convergents_array_to_rationals(convergents,nth=nil) #:nodoc:
+      nth ||= convergents.length
+      convergents[0...nth].map{|convergent| convergent_to_rational(convergent)}
+    end
+    
+    # Convert a convergent element to a Rational
+    #
+    def convergent_to_rational(convergent) #:nodoc:
+      Rational(convergent[0],convergent[1])
+    end
   end
 end

data/spec/continued_fractions/continued_fraction_spec.rb

@@ -6,7 +6,7 @@ module ContinuedFractions
       # First 10 convergents of PI are...
       convs = ['3/1', '22/7', '333/106', '355/113', '103993/33102', '104348/33215', '208341/66317', '312689/99532', '833719/265381', '1146408/364913'].map{|c| Rational(c)}
       @cf = ContinuedFraction.new(Math::PI,10)
-      (@cf.convergents - convs).empty?.should == true
+      (ContinuedFractions.convergents_array_to_rationals(@cf.convergents) - convs).empty?.should == true
     end
     
     before(:each) do
@@ -24,13 +24,15 @@ module ContinuedFractions
     
     it "should contain convergents approaching the number" do
       0.upto(@cf.convergents.length-2) do |i|
-        ((@cf.convergents[i+1] - @cf.number).abs <= (@cf.convergents[i] - @cf.number).abs).should == true
+        convergent_rational_i_plus1, convergent_rational_i = ContinuedFractions.convergent_to_rational(@cf.convergents[i+1]), ContinuedFractions.convergent_to_rational(@cf.convergents[i])
+        ((convergent_rational_i_plus1 - @cf.number).abs <= (convergent_rational_i - @cf.number).abs).should == true
       end
     end
     
     it "should contain convergents which are expressed in lowest terms" do
       1.upto(@cf.convergents.length-1) do |i|
-         (@cf.convergent(i-1).numerator*@cf.convergent(i).denominator - @cf.convergent(i).numerator*@cf.convergent(i-1).denominator).should == (-1)**(i)
+        convergent_rational_i_minus1, convergent_rational_i = ContinuedFractions.convergent_to_rational(@cf.convergent(i-1)), ContinuedFractions.convergent_to_rational(@cf.convergent(i))
+        (convergent_rational_i_minus1.numerator*convergent_rational_i.denominator - convergent_rational_i.numerator*convergent_rational_i_minus1.denominator).should == (-1)**(i)
       end
     end
   end

metadata

@@ -3,10 +3,10 @@ name: continued_fractions
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
   - 1
-  - 11
-  version: 0.1.11
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Jose Hales-Garcia
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 -07:00
+date: 2010-03-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +25,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
+        - 3
         - 0
-        version: "0"
+        version: 1.3.0
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 4
+        - 3
+        version: "4.3"
+  type: :development
+  version_requirements: *id002
 description: Generate continued fractions.
 email: jolohaga@me.com
 executables: []