continued_fractions 0.1.9 → 0.1.10

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.1.10 / 2010-03-16
+
+* Improved documentation and formatting.
+
 === 0.1.9 / 2010-03-15
 
 * Added the lowest term test.

data/README.txt

@@ -13,19 +13,26 @@ Generates quotients and convergents for a given number.
 
 == Synopsis:
 
-require 'continued_fractions'<br/>
-include ContinuedFractions
-
-frac = Rational(3,2)<br/>
-real = Math.log2(frac.to_f)<br/>
-cf = ContinuedFraction.new(real,10)<br/>
-cf.convergents
-
-> [(0/1), (1/1), (1/2), (3/5), (7/12), (24/41), (31/53), (179/306), (389/665), (9126/15601)]
-
-cf.convergent(4)
-
-> (7/12)
+  require 'continued_fractions'  
+  include ContinuedFractions
+  
+  real = Math::PI
+  => 3.14159265358979
+  
+  cf = ContinuedFraction.new(real,10)
+  => #<ContinuedFractions::ContinuedFraction:0x00000101101368 @number=3.14159265358979, @limit=10,
+          @quotients=[3, 7, 15, 1, 292, 1, 1, 1, 2, 1],
+          @convergents=[[0, 1], [1, 0], [3, 1], [22, 7], [333, 106],
+                        [355, 113], [103993, 33102], [104348, 33215], [208341, 66317], [312689, 99532], [833719, 265381], [1146408, 364913]]>
+                       
+  cf.convergents
+  => [(3/1), (22/7), (333/106), (355/113), (103993/33102), (104348/33215), (208341/66317), (312689/99532), (833719/265381), (1146408/364913)]
+  
+  cf.convergent(1)
+  => (22/7)
+  
+  cf.quotients
+  => [3, 7, 15, 1, 292, 1, 1, 1, 2, 1]
 
 == Requirements:
 
@@ -42,23 +49,24 @@ sudo gem install continued_fractions
 
 == License:
 
-Copyright (c) 2010 Jose Hales-Garcia
-
-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.
+  Copyright (c) 2010 Jose Hales-Garcia
+
+  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/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('continued_fractions', '0.1.9') do |config|
+Echoe.new('continued_fractions', '0.1.10') do |config|
   config.summary                  = 'Generate continued fractions.'
   config.author                   = 'Jose Hales-Garcia'
   config.url                      = 'http://bitbucket.org/jolohaga/continued_fractions/'

data/continued_fractions.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{continued_fractions}
-  s.version = "0.1.9"
+  s.version = "0.1.10"
 
   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-15}
+  s.date = %q{2010-03-16}
   s.description = %q{Generate continued fractions.}
   s.email = %q{jolohaga@me.com}
   s.extra_rdoc_files = ["README.txt", "lib/continued_fractions.rb"]

data/lib/continued_fractions.rb

@@ -8,7 +8,7 @@
 # Copyright:: Copyright (c) 2010 Jose Hales-Garcia
 #
 #
-module ContinuedFractions  #:nodoc:
+module ContinuedFractions
   class ContinuedFraction
     attr_accessor :number, :quotients, :limit
     attr_writer :convergents
@@ -18,6 +18,13 @@ module ContinuedFractions  #:nodoc:
     # The quotients and convergents arrays are length 5, by default.  Pass an integer for
     # the second parameter to change the default.
     #
+    # Example:
+    #   cf = ContinuedFraction.new(Math::PI,10)
+    #   => #<ContinuedFractions::ContinuedFraction:0x000001010ed5c8 @number=3.14159265358979, @limit=10,
+    #       @quotients=[3, 7, 15, 1, 292, 1, 1, 1, 2, 1],
+    #       @convergents=[[0, 1], [1, 0], [3, 1], [22, 7], [333, 106],
+    #                     [355, 113], [103993, 33102], [104348, 33215], [208341, 66317], [312689, 99532], [833719, 265381], [1146408, 364913]]>
+    #
     def initialize(n,l=5)
       @number = n  
       @limit = l

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 9
-  version: 0.1.9
+  - 10
+  version: 0.1.10
 platform: ruby
 authors: 
 - Jose Hales-Garcia
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-15 00:00:00 -07:00
+date: 2010-03-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency