rooted_tree 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fb0517447c09795b818f9918deab292ff76b693
-  data.tar.gz: 9828b9590b6a2e98df0d956e5c316bde85cc982b
+  metadata.gz: bf70759dc7a2bf845496a1eb2291a91a4a60e5e2
+  data.tar.gz: 6e7365e5d05e9f8daa1b34e5c726f0d2d8865d1b
 SHA512:
-  metadata.gz: 2f4290bf9357d919e8d92da2724366a405080fddf4e91878b74849f003986de6eddc42a68bd8038fb57ce3afb5106eb23226d049a84f902e5f6b32d6d35e36ec
-  data.tar.gz: 4aaddad4f3f6f8c7f5a771889dae2a9ea5c3f4c6568a8500eb0a2f8f36fc1ee16c2f7d6d240ec117507ed40f1997ac30e1fb46c8069e995b70f27b809c8269d0
+  metadata.gz: 10622361191c35e83775a11d129245eaebc2ce0b69f970e24195dd20bba065784a53a29295446c733d7bd3179b74302a29fe83fd5da6b48fbcfd8c573310db86
+  data.tar.gz: 1e9c114ae888537459a66f2c7b1f27212c2d20160c35a9e84c7a111916c14d20f6042feb585e6430e18cce600a79b0177b7cb0f932e59b26c6f020f8d3ef25f7

data/lib/rooted_tree/node.rb

@@ -2,8 +2,12 @@
 
 # Node
 #
+# Nodes are mutable by default, since creating anyting but simple leafs would
+# otherwise be imposible. Calling #freeze on a node makes the entire subtree
+# immutable. This is used by the Tree class which only operates on frozen node
+# structures.
 #
-# The following is an example of a rooted tree of height 3.
+# The following is an example of a rooted tree with maximum depth 2.
 #
 #       r         - r, a, b, c, and d are internal vertices
 #    +--+---+     - vertices e, f, g, h, i, and j are leaves
@@ -18,9 +22,14 @@
 
 module RootedTree
   class Node
-    attr_accessor :first_child, :last_child
+    include Enumerable
+    
+    attr_accessor :first_child, :last_child, :degree
     attr_writer :next, :prev, :parent
-    protected :next=, :prev=, :parent=, :first_child=, :last_child=
+    
+    protected :next=, :prev=, :parent=, :first_child=, :last_child=, :degree=
+    
+    alias arity degree
 
     def initialize
       @parent = nil
@@ -28,6 +37,7 @@ module RootedTree
       @prev = nil
       @first_child = nil
       @last_child = nil
+      @degree = 0
     end
 
     def initialize_copy(*)
@@ -49,7 +59,7 @@ module RootedTree
     # A node is a leaf if it has no children.
 
     def leaf?
-      @first_child.nil?
+      @degree == 0
     end
 
     # Internal?
@@ -106,16 +116,24 @@ module RootedTree
     end
 
     alias level depth
+    
+    # Max Depth
+    #
+    # Returns the maximum node depth under this node.
+    
+    def max_depth offset = depth
+      return offset if leaf?
+      
+      children.map {|c| c.max_depth offset + 1 }.max
+    end
 
-    # Degree
+    # Max Degree
     #
-    # Returns the number of children of the node.
+    # Returns the highest child count of the nodes in the subtree.
 
-    def degree
-      children.count
+    def max_degree
+      children.map(&:degree).push(degree).max
     end
-    
-    alias arity degree
 
     # Size
     #
@@ -167,6 +185,8 @@ module RootedTree
       node.next = @next
       node.prev = self
       node.parent = @parent
+      @parent.degree += 1
+      
       if @next
         @next.prev = node
       else
@@ -185,6 +205,8 @@ module RootedTree
       node.next = self
       node.prev = @prev
       node.parent = @parent
+      @parent.degree += 1
+      
       if @prev
         @prev.next = node
       else
@@ -192,6 +214,13 @@ module RootedTree
       end
       @prev = node
     end
+    
+    private def add_child_to_leaf(child)
+      @first_child = @last_child = child
+      child.next = child.prev = nil
+      @degree = 1
+      child.parent = self
+    end
 
     # Append Child
     #
@@ -199,9 +228,7 @@ module RootedTree
 
     def append_child(child)
       if leaf?
-        @first_child = @last_child = child
-        child.next = child.prev = nil
-        child.parent = self
+        add_child_to_leaf child
       else
         @last_child.append_sibling child
       end
@@ -214,9 +241,7 @@ module RootedTree
 
     def prepend_child(child)
       if leaf?
-        @first_child = @last_child = child
-        child.next = child.prev = nil
-        child.parent = self
+        add_child_to_leaf child
       else
         @first_child.prepend_sibling child
       end
@@ -243,6 +268,7 @@ module RootedTree
         @prev.next = @next
       end
 
+      @parent.degree -= 1
       @prev = @next = @parent = nil
       self
     end
@@ -276,11 +302,11 @@ module RootedTree
 
     # Children
     #
-    # Returns an enumerator that will iterate over each of the node children.
-    # The default order is left-to-right, but by passing rtl: true the order can
-    # be reversed.
+    # Yields to each of the node children. The default order is left-to-right,
+    # but by passing rtl: true the order can be reversed. If a block is not given an enumerator is returned.
     #
-    # If a block is given it will be yielded to.
+    # Note that the block will catch any StopIteration that is raised and
+    # terminate early, returning the value of the exception.
 
     def children(rtl: false)
       return to_enum(__callee__, rtl: rtl) unless block_given?
@@ -300,7 +326,8 @@ module RootedTree
 
     # Each
     #
-    #
+    # Yields first to self and then to each child. If a block is not given an
+    # enumerator is returned.
 
     def each(&block)
       return to_enum(__callee__) unless block_given?
@@ -351,7 +378,7 @@ module RootedTree
 
     def ==(other)
       return false unless other.is_a? self.class
-      return other.leaf? if leaf?
+      return false unless degree == other.degree
 
       children.to_a == other.children.to_a
     end

data/lib/rooted_tree/tree.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RootedTree
   class Tree
     attr_reader :root
@@ -7,15 +9,24 @@ module RootedTree
       @root.freeze
     end
     
+    def tree
+      self
+    end
+    
     # Degree
     #
     # Returns the maximum degree (number of children) in the tree.
     
     def degree
-      max_degree_node = root.each.max_by do |node|
-        node.degree
-      end
-      max_degree_node.degree
+      @degree ||= root.max_degree
+    end
+    
+    # Depth
+    #
+    # Returns the maximum depth of the tree.
+    
+    def depth
+      @depth ||= root.max_depth
     end
   end
 end

data/lib/rooted_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RootedTree
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rooted_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sebastian Lindberg