fraction-tree 0.1.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e5c17d5e199e69dfaa28379a41f7bfb66dfdd5b815b2560114ae17cbb4fb38c
-  data.tar.gz: 5f4839d243055f151b64035ea6a03ce0eb73c6a6307658f4e176955d5fd92eb0
+  metadata.gz: d13b1fb1ddd328714a431288ee0ec04205fb9001ce4a2d1b339e62bef0ed8e4c
+  data.tar.gz: 55260283f52cfa95dd50ecb02f83baaa436752d85b6fd53b3505d6f752ebb600
 SHA512:
-  metadata.gz: 1b49285eb42d3f0387e100dba29c643673d2fdee05586d29b356f3d7eba1dbb7013dce772cd6ea82df73f9852f1c7ff7444867145ed0149c9b910bde52cd3fee
-  data.tar.gz: 60c2204c9869a8a5cd98fb0b3aff522c735701c90f450fb005bbfb08f3a483d31a576689eececf31eee816491736a6740a3f671b5b9c0f06640af1a7a87909e6
+  metadata.gz: df04fd1122e08f92ff5bb611f82d9ac582ac26c30e02542f02b9030b2ee248a5ba4f9e9080239fed64587bb55f74db80ec6dcb726e5550d881e61a6f54f616ce
+  data.tar.gz: db61b0ede817e7b8c1bac18ec4ab07627c20efaef739d01a8fb06bc49db80b7c3cd9243d79a5cdc873085cc0e8482b07eb528ad7ca1c2fb3c0dcceb6761bb402

data/lib/fraction_tree.rb

@@ -1,5 +1,7 @@
 require "continued_fractions"
 
+# @author Jose Hales-Garcia
+#
 class FractionTree
   DEFAULT_TREE_DEPTH = 20
 
@@ -47,8 +49,8 @@ class FractionTree
     #   FractionTree.sequence(3)
     #     => [(0/1), (1/3), (1/2), (2/3), (1/1), (3/2), (2/1), (3/1), (1/0)]
     #
-    # @param depth the number of iterations of the algorithm to run. The number of nodes returned will be greater
-    # @param segment a tuple array defining the segment of the tree to collect nodes. The elements of the tuple must be instances of FractionTree::Node
+    # @param depth [Integer] the number of iterations of the algorithm to run. The number of nodes returned will be greater
+    # @param segment [Array] a tuple array of [FractionTree::Node] defining the segment of the tree to collect nodes.
     #
     def sequence(depth=5, segment: base_segment)
       [segment.first]+_sequence(depth, segment:)+[segment.last]
@@ -58,7 +60,9 @@ class FractionTree
     # @example 
     #    FractionTree.path_to(7/4r) => [(1/1), (2/1), (3/2), (5/3), (7/4)]
     #
-    # @param number the target the fraction path leads to
+    # @param number [Rational] the target the fraction path leads to
+    # @param find_parents [Boolean] list all ancestors or only immediate parents
+    # @param segment [Array] a tuple of [FractionTree::Node], defining the segment's starting left and right boundaries
     #
     def path_to(number, find_parents: false, segment: base_segment)
       return Node.new(number.numerator, number.denominator) if number.zero?
@@ -89,7 +93,7 @@ class FractionTree
     #   FractionTree.parents_of(15/13r) => [(8/7), (7/6)]
     #   FractionTree.parents_of(Math::PI) => [(447288330638589/142376297616907), (436991388364966/139098679093749)]
     #
-    # @param num the child number whose parents are being sought
+    # @param number [Rational] the child number whose parents are being sought
     #
     def parents_of(number)
       path_to(number, find_parents: true)
@@ -100,8 +104,8 @@ class FractionTree
     #   FractionTree.common_ancestors_between(4/3r, 7/4r)
     #   => [(1/1), (2/1), (3/2)]
     #
-    # @param number1 one of two descendants
-    # @param number2 two of two descendants
+    # @param number1 [Rational] one of two descendants
+    # @param number2 [Rational] two of two descendants
     #
     def common_ancestors_between(number1, number2)
       path_to(number1) & path_to(number2)
@@ -112,8 +116,8 @@ class FractionTree
     #   FractionTree.descendancy_from(5/4r, 3)
     #   => [(1/1), (7/6), (6/5), (11/9), (5/4), (14/11), (9/7), (13/10), (4/3)]
     #
-    # @param number around which descendancy is focused
-    # @param depth how many nodes to collect
+    # @param number [Rational] around which descendancy is focused
+    # @param depth [Integer] how many nodes to collect
     #
     def descendancy_from(number, depth=5)
       parent1, parent2 = parents_of(number)
@@ -126,8 +130,9 @@ class FractionTree
     #   FractionTree.child_of(1/1r, 4/3r) => (5/4)
     #   FractionTree.child_of(7/4r, 4/3r) => nil
     #
-    # @param number1 one of two parents
-    # @param number2 two of two parents
+    # @param number1 [Rational] one of two parents
+    # @param number2 [Rational] two of two parents
+    # @param strict_neighbors [Boolean] whether to apply the strict Farey tree neighbor requirement
     #
     def child_of(number1, number2, strict_neighbors: true)
       return nil unless farey_neighbors?(number1, number2) || !strict_neighbors
@@ -140,8 +145,10 @@ class FractionTree
     #   FractionTree.descendants_of(1/1r, 4/3r, 3)
     #   => [(1/1), (7/6), (6/5), (11/9), (5/4), (14/11), (9/7), (13/10), (4/3)]
     #
-    # @param parent1 one of two parents
-    # @param parent2 two of two parents
+    # @param parent1 [Rational] one of two parents
+    # @param parent2 [Rational] two of two parents
+    # @param depth [Integer] the depth to collect
+    # @param strict_neighbors [Boolean] whether to apply the strict Farey tree neighbor requirement
     #
     def descendants_of(parent1, parent2, depth=5, strict_neighbors: true)
       return [] unless farey_neighbors?(parent1, parent2) || !strict_neighbors
@@ -154,8 +161,9 @@ class FractionTree
     #   FractionTree.quotient_walk(15/13r)
     #   => [(1/1), (2/1), (3/2), (4/3), (5/4), (6/5), (7/6), (8/7), (15/13)]
     #
-    # @param number to walk toward
-    # @param limit the depth of the walk. Useful for irrational numbers
+    # @param number [Numeric] to walk toward
+    # @param limit [Integer] the depth of the walk. Useful for irrational numbers
+    # @param segment [Array] the tuple of [FractionTree::Node] defining the segment of the tree
     #
     def quotient_walk(number, limit: 10, segment: computed_base_segment(number))
       iterating_quotients = ContinuedFraction.new(number, limit).quotients.drop(1)
@@ -212,10 +220,17 @@ class FractionTree
     end
   end
 
+  # @attr_reader numerator [Integer]
+  #   The numerator of the node
+  # @attr_reader denominator [Integer]
+  #   The denominator of the node
+  # @attr_reader weight [Rational|Infinity]
+  #   The value of the node
+  #
   class Node
     include Comparable
 
-    attr_accessor :numerator, :denominator, :weight
+    attr_reader :numerator, :denominator, :weight
 
     def initialize(n,d)
       @numerator = n

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fraction-tree
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Jose Hales-Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: continued_fractions
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,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: '0'
+      version: '3.1'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Fraction tree