continued_fractions 0.1.7 → 0.1.8

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.1.8 / 2010-03-15
+
+* Add Rdoc comments.
+
 === 0.1.7 / 2010-03-15
 
 * Including spec files in distribution (forgot to add them to the manifest).

data/Rakefile

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('continued_fractions', '0.1.7') do |config|
-  config.description              = 'Generate continued fractions.'
+Echoe.new('continued_fractions', '0.1.8') 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/*"]
-  config.development_dependencies = []
+  config.ignore_pattern           = ["tmp/*",".hg/*", ".pkg/*"]
+  config.development_dependencies = ['rspec']
 end
 
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each{|ext| load ext}

data/continued_fractions.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{continued_fractions}
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jose Hales-Garcia"]
@@ -23,8 +23,11 @@ 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"])
     else
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end

data/lib/continued_fractions.rb

@@ -1,24 +1,41 @@
+# ContinuedFractions
+#
+# Generates quotients and convergents for a given number.
+#
+# Requires Ruby 1.9+
+#
+# Author:: Jose Hales-Garcia (mailto:jolohaga@me.com)
+# Copyright:: Copyright (c) 2010 Jose Hales-Garcia
+#
+#
 module ContinuedFractions  #:nodoc:
-# Requires Ruby 1.9
   class ContinuedFraction
     attr_accessor :number, :quotients, :limit
     attr_writer :convergents
-
+    
+    # For a given number, n, calculate its continued fraction quotients and convergents.
+    #
     def initialize(n,l=5)
       @number = n  
       @limit = l
       @quotients = calculate_quotients
       @convergents = calculate_convergents
     end
-
+    
+    # Return nth (pre-calculated) convergent.
+    #
     def convergent(n)
       convergents[n]
     end
-
+    
+    # Return array of convergents as Rationals.
+    #
     def convergents
       _convergents.map{|c| Rational(c[0],c[1])}
     end
-
+    
+    # Return array of convergents, each as a two-element array with the numerator in [i,0] and denominator in [i,1].
+    #
     def convergents_array
       _convergents
     end
@@ -49,7 +66,7 @@ module ContinuedFractions  #:nodoc:
     end
   end
 
-  class << self # :nodoc:
+  class << self #:nodoc:
     def convergence_matrix(n,m,fill=nil)
       conv_mat = Array.new(n).map!{Array.new(m,fill)}
       conv_mat[0][0],conv_mat[1][1] = 0,0

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Jose Hales-Garcia
@@ -16,8 +16,19 @@ cert_chain: []
 
 date: 2010-03-15 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
 description: Generate continued fractions.
 email: jolohaga@me.com
 executables: []