continued_fractions 1.8.5 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7aa696a6a061c921c1513ffeb7d17ce641a4936e89174e61accd3cf0615ca9f
-  data.tar.gz: 46d89b9a7a7242ec10bd5074858b443ea2b4e01101c6a1f005e512aceb4f880e
+  metadata.gz: 3fc86b49a35fff8bfffba3ee95a21ee8f2c09e30e4bba04a25aac57a49cacfef
+  data.tar.gz: 27b47d0bd7c4e75bb89741bf383dad99c2bd5f4919d7fb5c47936f8de442e175
 SHA512:
-  metadata.gz: 3388b0c412ace93cc15958c11afa99e4e08059e2be6f4726c37121c6eded00a725406218b14f8679ab252d6c565c5ccbdb4c9e276cef5c1bd8d6a26cc6edf8c5
-  data.tar.gz: fd8308ba053a0e2c09d146e720b5fd195b76fc78903236bb7335f6520e17551a4598905f6f667f35d046f41486e99969b599de16b96b0feb1a204945857f44b0
+  metadata.gz: e915584d227d3fd295ff5ad5a09a11e0dbfa1073e61761d5edcb6ab229a6b7b3b855260265fcb816c5847e4304c2463b85927b9bfb2a7ac3076b4bd8dd75b778
+  data.tar.gz: 1756e4b64ad3a71db1852db5c8faa6a42cbc99f0223a771e870cc19ec1f2135f0eafd5d1ad35f4235c8f56696f45cd6e27c818696392441ae10f4dae716ac0d2

data/LICENSE

@@ -1,6 +1,6 @@
 == License:
 
-  Copyright (c) 2021 Jose Hales-Garcia
+  Copyright (c) 2023 Jose Hales-Garcia
 
   Permission is hereby granted, free of charge, to any person obtaining
   a copy of this software and associated documentation files (the

data/README.md

@@ -14,29 +14,22 @@ Generates quotients and convergents for a given number.
     => 3.14159265358979
     
     cf = ContinuedFraction.new(pi,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]]>
+    => 3.141592653589793, quotients: [3, 7, 15, 1, 292, 1, 1, 1, 2, 1], convergents: [(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]]
-    
-    # Convergents can be output as an array of Rationals too
-    cf.convergents_as_rationals
-    [(3/1), (22/7), (333/106), (355/113), (103993/33102), (104348/33215), (208341/66317), (312689/99532), (833719/265381), (1146408/364913)]
-    
+    => [(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]
+    => (22/7)
     
     cf.quotients
     => [3, 7, 15, 1, 292, 1, 1, 1, 2, 1]
     
     # Add, subtract, multiply and divide continued fractions.  The limit of the result is the max limit of the operands.
     cf2 = ContinuedFraction.new(rand,20)
-    => #<ContinuedFractions::ContinuedFraction:0x000001009dde50 @number=0.03834175394982653, @limit=20, @quotients=[0, 26, 12, 3, 4, 1, 2, 24, 5, 1, 1, 1, 2, 1, 2, 2, 1, 7, 1, 5], @convergents=[[0, 1], [1, 26], [12, 313], [37, 965], [160, 4173], [197, 5138], [554, 14449], [13493, 351914], [68019, 1774019], [81512, 2125933], [149531, 3899952], [231043, 6025885], [611617, 15951722], [842660, 21977607], [2296937, 59906936], [5436534, 141791479], [7733471, 201698415], [59570831, 1553680384], [67304302, 1755378799], [396092341, 10330574379]]>
+    => 0.9465929215086878, quotients: [0, 1, 17, 1, 2, 1, 1, 1, 1, 1, 41, 1, 1, 2, 22, 1, 1, 11, 1, 3], convergents: [(0/1), (1/1), (17/18), (18/19), (53/56), (71/75), (124/131), (195/206), (319/337), (514/543), (21393/22600), (21907/23143), (43300/45743), (108507/114629), (2430454/2567581), (2538961/2682210), (4969415/5249791), (57202526/60429911), (62171941/65679702), (243718349/257469017)]
     cf + cf2
-    => #<ContinuedFractions::ContinuedFraction:0x000001009d2708 @number=3.1799344075396196, @limit=20, @quotients=[3, 5, 1, 1, 3, 1, 5, 3, 7, 25, 1, 2, 15, 6, 1, 1, 2, 3, 1, 2], @convergents=[[3, 1], [16, 5], [19, 6], [35, 11], [124, 39], [159, 50], [919, 289], [2916, 917], [21331, 6708], [536191, 168617], [557522, 175325], [1651235, 519267], [25326047, 7964330], [153607517, 48305247], [178933564, 56269577], [332541081, 104574824], [844015726, 265419225], [2864588259, 900832499], [3708603985, 1166251724], [10281796229, 3233335947]]>
+    => 4.088185575098481, quotients: [4, 11, 2, 1, 16, 1, 2, 1, 1, 1, 1, 25, 7, 1, 3, 1, 3], convergents: [(4/1), (45/11), (94/23), (139/34), (2318/567), (2457/601), (7232/1769), (9689/2370), (16921/4139), (26610/6509), (43531/10648), (1114885/272709), (7847726/1919611), (8962611/2192320), (34735559/8496571), (43698170/10688891), (165830069/40563244)]
 
 ## Install
 
@@ -44,14 +37,14 @@ sudo gem install continued_fractions
 
 ## Requirements/Dependencies
 
-* Ruby 2.2+
+* Ruby 3.1+
 * Depends on Ruby's Rational class
 
 ## Developers
 
 * RSpec required to run tests
+* Yard to compile documentation
 
 ## Contributors
 
-* [Jose Hales-Garcia](https://github.com/jolohaga)
-* [Eoin Kelly](https://github.com/eoinkelly)
+* [Jose Hales-Garcia](https://github.com/jolohaga)

data/lib/continued_fractions/include.rb

@@ -1,9 +1,15 @@
 module ContinuedFractions
   module Numeric
+
+    # @return [ContinuedFraction]
+    # @example
+    #   1.5.to_cf
+    #   => 1.5, quotients: [1, 2], convergents: [(1/1), (3/2)]
+    # @param limit [Float]
+    #
     def to_cf(limit: ContinuedFraction::DEFAULT_LIMIT)
       ContinuedFraction.new(self, limit)
     end
-    alias :to_continued_fraction :to_cf
   end
 end
 

data/lib/continued_fractions.rb

@@ -4,101 +4,67 @@ require 'continued_fractions/include'
 #
 # Generates quotients and convergents for a given number
 #
-# Author:: Jose Hales-Garcia (mailto:jolohaga@me.com)
-# Copyright:: Copyright (c) 2022 Jose Hales-Garcia
+# @author Jose Hales-Garcia
 #
+# @attr_reader number [Numeric]
+#   The number who's continued fraction is being calculated
+# @attr_reader quotients [Array]
+#   The array of quotients of the continued fraction
+# @attr_reader convergents [Array]
+#   The convergents of the continued fraction
+# @attr_reader limit [Integer]
+#   The limit to calculate. Practical for real numbers, although they're limited by the system.
 #
 class ContinuedFraction
-  include ::Comparable
+  include Comparable
 
-  attr_accessor :number, :quotients, :limit
+  attr_reader :number, :quotients, :convergents, :limit
 
   DEFAULT_LIMIT = 5
 
-  # For a given number calculate its continued fraction quotients and convergents up to limit.
-  #
-  # The limit is 5 by default. Pass an integer in the second parameter to change it.
-  #
-  # 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]]>
+  # @return [ContinuedFraction] the quotients and convergents of a continued fraction for a given number.
+  # @example
+  #   ContinuedFraction.new(Math::PI,10)
+  #   => 3.141592653589793, quotients: [3, 7, 15, 1, 292, 1, 1, 1, 2, 1], convergents: [(3/1), (22/7), (333/106), (355/113), (103993/33102), (104348/33215), (208341/66317), (312689/99532), (833719/265381), (1146408/364913)]
+  # @param number [Numeric]
+  # @param limit [Integer]
   #
   def initialize(number, limit=DEFAULT_LIMIT)
     @number = number
     @ratioed_number = number.to_r
-    @quotients, @convergents, @limit = calculate_quotients_and_convergents(number, limit)
-  end
-
-  # Return nth convergent.
-  #
-  # Example:
-  #   cf = ContinuedFraction.new(Math::PI,10)
-  #   cf.convergent(3)
-  #   => [355,113]
-  #
-  def convergent(nth)
-    raise(IndexError, "Convergent index must be greater than zero.") unless nth > 0
-    convergents[nth-1]
+    @quotients, @convergents, @limit = calculate_quotients_and_convergents(limit)
   end
 
-  # 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(nth=nil)
-    nth ||= @convergents.length
-    @convergents[0...nth]
-  end
-
-  # Return array of convergents of the continued fraction instance converted as Rationals.
-  # If nth is nil, then return the entire list.
-  #
-  # 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)]
+  # @return [ContinuedFraction] the CF sum of self and another CF
+  # @param other [ContinuedFraction]
   #
-  # Or:
-  #   cf.convergents_as_rationals(3)
-  #   => [(3/1), (22/7), (333/106)]
-  #
-  def convergents_as_rationals(nth=nil)
-    nth ||= convergents.length
-    convergents[0...nth].map{|convergent| convergent_to_rational(convergent)}
-  end
-
   def +(other)
     number_of(other) do |num,prec|
       evaluate("#{number} + #{num}",prec)
     end
   end
 
+  # @return [ContinuedFraction] the CF difference of self and another CF
+  # @param other [ContinuedFraction]
+  #
   def -(other)
     number_of(other) do |num,prec|
       evaluate("#{number} - #{num}",prec)
     end
   end
 
+  # @return [ContinuedFraction] the CF quotient of self and another CF
+  # @param other [ContinuedFraction]
+  #
   def /(other)
     number_of(other) do |num,prec|
       evaluate("#{number} / #{num}",prec)
     end
   end
 
+  # @return [ContinuedFraction] the CF product of self and another CF
+  # @param other [ContinuedFraction]
+  #
   def *(other)
     number_of(other) do |num,prec|
       evaluate("#{number} * #{num}",prec)
@@ -109,8 +75,8 @@ class ContinuedFraction
     number <=> other.number
   end
 
-  def convergent_to_rational(convergent) #:nodoc:
-    Rational(convergent[0],convergent[1])
+  def inspect
+    "#{number}, quotients: #{quotients}, convergents: #{convergents[0..-1]}"
   end
 
   private
@@ -132,43 +98,44 @@ class ContinuedFraction
     yield(num,prec)
   end
 
-  def calculate_quotients_and_convergents(x, limit)
+  def calculate_quotients_and_convergents(limit)
+    x = @number
+
     _quotients = []
-    _convergents = []
+    _convergents = [] #Convergents.new
 
     # Initialize the initial values for p and q
     p_minus_1, q_minus_1 = 0, 1
     p_0, q_0 = 1, 0
 
-    n = x.to_i
+    q = x.to_i
 
     # Loop for maximum specified terms or until the fractional part becomes zero
     limit.times do
-      _quotients << n
+      _quotients << q
 
       # Calculate the new p and q
-      p_n = n * p_0 + p_minus_1
-      q_n = n * q_0 + q_minus_1
+      p_n = q * p_0 + p_minus_1
+      q_n = q * q_0 + q_minus_1
+
+      convergent = Rational(p_n, q_n)
+      _convergents << convergent
+
+      break if ((@number - convergent).to_f).zero?
 
-      _convergents << [p_n, q_n]
+      x_rem = x - q
+      break if x_rem.zero?
 
       # Recalculate the fractional part
-      x = 1.0 / (x - n)
+      x = 1/1r / x_rem
       break if x.infinite? || _convergents.include?([@ratioed_number.numerator, @ratioed_number.denominator])
 
       # Update the old values
       p_minus_1, q_minus_1 = p_0, q_0
       p_0, q_0 = p_n, q_n
-      n = x.to_i
+      q = x.to_i
     end
 
     return _quotients, _convergents, _quotients.length
   end
 end
-
-# @return [ContinuedFraction] new instance
-# @see ContinuedFraction#initialize
-#
-def ContinuedFraction(number,limit=ContinuedFraction::DEFAULT_LIMIT)
-  ContinuedFraction.new(number,limit)
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: continued_fractions
 version: !ruby/object:Gem::Version
-  version: 1.8.5
+  version: 2.0.1
 platform: ruby
 authors:
 - Jose Hales-Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -69,14 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '1.2'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Generate continued fractions