skn_utils 3.3.2 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2f654cc636fb8d2694432b991fc8c145dd81d01
-  data.tar.gz: 3f7a28e3be152907b0b25949a371855cb739de2b
+  metadata.gz: 32848790967a49e9c69c81c3cf46744ccc1fde9c
+  data.tar.gz: 5801f319e98845bc7454af452a6df47339e2eb58
 SHA512:
-  metadata.gz: e5e65ca3ada647ad23c5a26d224b025b2e14a00e63e0f15d2ce35823c7df69e77720d43fa53c40af0abf6e5297346c98b321dd2bc244f20ed012b3633296a8bf
-  data.tar.gz: e68c4b224458eb5aa669fd776177c433812705e54006f0fcf12c5b122d1f4a1b9ba1f9fc5744800cb83d158bdb587492ac2eebf88fb4fedf848afe3115afb630
+  metadata.gz: 25c689c0230fc7b07e24b3f2d13a490ee42fa67da69b3a61f0fc4546959abde80241f40004ac0c1548c73a92afdb2fbcb32d5da4f315b3856525d42ea6671d86
+  data.tar.gz: 9d9cd56d940ecf86e0da143286689fc8b3dcaa6161c179f9b60a815dd0ccd26d8508b466c6b68a3cfd7a432f41bd374ab4b86a774fb1d91ca6f145282e866fee

data/README.md

@@ -89,6 +89,9 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
       #clear                       -- removes all elements and return number of elements removed
       #empty?                      -- returns true if list has no elements, otherwise false
       #size                        -- returns total count of elements in the list
+      #sort!(:direction, &block)   -- Sort existing list in place using :direction (:asc,:desc, :default) symbol
+                                      if block is given, overrides :direction and uses custom proc to compare values
+                                      block format is:  {|a,b| a >= b };  example: 'll.sort(:default) {|a,b| a <= b}'
 
     Modification: returns number of elements in the list after the operation
       #insert(value)                        -- inserts value after node at current positon, or appends
@@ -98,8 +101,10 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
       #insert_after(position_value, value)  -- finds node matching position_value, then appends new node
       #remove(value)                        -- finds first node matching value, then destroys it
 
-    Initialization
-      #new(*values=nil)                     -- Instansiates new list and optionally creates nodes for each comma-seperated value.
+    Initialization: optional &block to identify data key
+      #new(*vargs, &block)         -- Instansiates new list and optionally creates nodes from each comma-seperated value;
+                                      also, assigns &block as default value identifier for find and sort operations
+               compare_key_block example:  LinkedList.new({:key=>"Z"},{:key=>"S"},{:key=>"N"}) {|a| a[:key]}  
 
 
 ## Public Methods: SknSettings ONLY

data/bin/benchmark.rb

@@ -1,11 +1,42 @@
 #!/usr/bin/env ruby
 
+#
+# Ref: https://github.com/evanphx/benchmark-ips
+#
+
 require 'bundler/setup'
 require 'skn_utils'
 require 'ostruct'
 require 'benchmark/ips'
 
+class GCSuite
+  def warming(*)
+    run_gc
+  end
+
+  def running(*)
+    run_gc
+  end
+
+  def warmup_stats(*)
+  end
+
+  def add_report(*)
+  end
+
+  private
+
+  def run_gc
+    GC.enable
+    GC.start
+    GC.disable
+  end
+end
+
+suite = GCSuite.new
+
 Benchmark.ips do |x|
+  x.config(:suite => suite)
 
   class RegularClass
     attr_accessor :foo
@@ -31,13 +62,57 @@ Benchmark.ips do |x|
     n.foo = :bar
     n.foo
   end
+
+  x.compare!
 end
 
 # Warming up --------------------------------------
-#      regular class   182.079k i/100ms
-#   OpenStruct class    12.129k i/100ms
-# NestedResult class    11.075k i/100ms
+#      regular class     179.755k i/100ms
+#   OpenStruct class      11.367k i/100ms
+# NestedResult class       9.674k i/100ms
+# Calculating -------------------------------------
+#      regular class       3.674M (±17.4%) i/s -     17.256M in   5.001576s
+#   OpenStruct class     155.394k (±31.2%) i/s -    670.653k in   5.095404s
+# NestedResult class     119.896k (±39.0%) i/s -    493.374k in   5.212147s
+#
+# Comparison:
+#      regular class:   3673640.5 i/s
+#   OpenStruct class:    155394.0 i/s - 23.64x  slower
+# NestedResult class:    119896.1 i/s - 30.64x  slower
+#
+# Warming up --------------------------------------
+# LinkedList Ops     2.297k i/100ms
+#      Array Ops    34.468k i/100ms
 # Calculating -------------------------------------
-#      regular class      4.140M (± 2.2%) i/s -     20.757M in   5.015689s
-#   OpenStruct class    129.418k (± 2.3%) i/s -    654.966k in   5.063580s
-# NestedResult class    115.819k (± 2.3%) i/s -    586.975k in   5.070852s
+# LinkedList Ops     17.015k (±35.2%) i/s -     71.207k in   5.100193s
+#      Array Ops    377.943k (± 7.3%) i/s -      1.896M in   5.048217s
+#
+# Comparison:
+#       Array Ops:   377942.7 i/s
+# LinkedList Ops:    17015.4 i/s - 22.21x  slower
+
+
+Benchmark.ips do |x|
+  x.config(:suite => suite)
+
+  adders = [50, 10, 110, 6, 30, 101, 12, 33, 4]
+  vargs  = [70, 71, 72, 73, 74, 75, 76, 77, 78, 79]
+
+  x.report('LinkedList Ops') do
+    ll = SknUtils::Lists::LinkedList.new(*vargs)
+    adders.each {|x| ll.insert_after(74, x)}
+    value = ll.sort!
+    ll.first
+    ll.clear
+  end
+
+  x.report('Array Ops') do
+    ary = Array.new(vargs)
+    adders.each {|x| ary.insert(5, x)}
+    value = ary.sort!
+    ary.first
+    ary.clear
+  end
+
+  x.compare!
+end

data/lib/skn_utils/lists/circular_linked_list.rb

@@ -7,15 +7,16 @@ module SknUtils
     class CircularLinkedList
       attr_accessor :size
 
-      def initialize(*vargs, &block)
+      def initialize(*vargs, &compare_key_proc)
         @current = nil
         @head = nil
         @tail = nil
         @size = 0
 
-        @sort_ascending  = lambda {|a_obj,b_obj| a_obj >= b_obj}
-        @sort_descending = lambda {|a_obj,b_obj| a_obj <= b_obj}
-        @sort_condition  = block_given? ? block : @sort_ascending
+        @match_value     = block_given? ? compare_key_proc : lambda {|obj| obj }
+        @sort_ascending  = lambda {|a_obj,b_obj| @match_value.call(a_obj) >= @match_value.call(b_obj)}
+        @sort_descending = lambda {|a_obj,b_obj| @match_value.call(a_obj) <= @match_value.call(b_obj)}
+        @sort_condition  = @sort_ascending
 
         vargs.each {|value| insert(value) }
         first if vargs.size > 1
@@ -107,7 +108,7 @@ module SknUtils
       # return new size
       def insert_before(position_value, value)
         target = find_by_value(position_value)
-        node = LinkNode.new(value, target, :circle_before)
+        node = LinkNode.new(value, target, :circle_before, &@match_value)
         @current = node if target
         self.head = node if head === target
         self.tail = node if tail.nil?
@@ -117,7 +118,7 @@ module SknUtils
       # return new size
       def insert_after(position_value, value)
         target = find_by_value(position_value)
-        node = LinkNode.new(value, target, :circle_after)
+        node = LinkNode.new(value, target, :circle_after, &@match_value)
         @current = node
         self.head = node if head.nil?
         self.tail = node if tail === target
@@ -166,12 +167,12 @@ module SknUtils
         position = head
         if block_given?
           while position do
-            yield position.value.dup
+            block.call( position.value.dup )
             position = position.next
             break if position === @current
           end
         else
-          Enumerator.new do |yielder, val|
+          Enumerator.new do |yielder|
             while position do
               yielder << position.value.dup
               position = position.next
@@ -195,19 +196,17 @@ module SknUtils
       end
 
       # block format: sort condition : {|a_obj,b_obj| a_obj >= b_obj}
-      def sort!(direction_sym=:default, &block)
-        active_sort_condition = block_given? ? block :
-                                    (
-                                    case direction_sym
-                                      when :asc
-                                        @sort_ascending
-                                      when :desc
-                                        @sort_descending
-                                      else
-                                        @sort_condition
-                                    end
-                                    )
-        sorted = merge_sort(to_a, active_sort_condition)
+      def sort!(direction_sym=:default, &compare_sort_proc)
+        @active_sort_condition = block_given? ? compare_sort_proc :
+                                     case direction_sym
+                                       when :asc
+                                         @sort_ascending
+                                       when :desc
+                                         @sort_descending
+                                       else
+                                         @sort_condition
+                                     end
+        sorted = merge_sort(to_a)
         clear
         sorted.each {|item| insert(item) }
         size
@@ -218,10 +217,10 @@ module SknUtils
       attr_accessor :head, :tail
 
       def find_by_value(value)
-        return nil if head.nil?
+        return nil if head.nil? or value.nil? or size == 0
         prior = head
         target = prior
-        while not target.match_by_value(value)
+        while target and not target.match_by_value(value)
           prior = target
           target = prior.next
           @current = target if target
@@ -239,23 +238,23 @@ module SknUtils
 
       # Merged Sort via Ref: http://rubyalgorithms.com/merge_sort.html
       # arr is Array to be sorted, sort_cond is Proc expecting a/b params returning true/false
-      def merge_sort(arr, sort_cond)
+      def merge_sort(arr)
         return arr if arr.size < 2
 
         middle = arr.size / 2
 
-        left = merge_sort(arr[0...middle], sort_cond)
-        right = merge_sort(arr[middle..arr.size], sort_cond)
+        left = merge_sort(arr[0...middle])
+        right = merge_sort(arr[middle..arr.size])
 
-        merge(left, right, sort_cond)
+        merge(left, right)
       end
 
-      def merge(left, right, sort_cond)
+      def merge(left, right)
         sorted = []
 
         while left.any? && right.any?
 
-          if sort_cond.call(left.first, right.first)  # replace this condition with a proc
+          if @active_sort_condition.call(left.first, right.first)
             sorted.push right.shift
           else
             sorted.push left.shift

data/lib/skn_utils/lists/doubly_linked_list.rb

@@ -8,15 +8,16 @@ module SknUtils
     class DoublyLinkedList
       attr_accessor :size
 
-      def initialize(*vargs, &block)
+      def initialize(*vargs, &compare_key_proc)
         @current = nil
         @head = nil
         @tail = nil
         @size = 0
 
-        @sort_ascending  = lambda {|a_obj,b_obj| a_obj >= b_obj}
-        @sort_descending = lambda {|a_obj,b_obj| a_obj <= b_obj}
-        @sort_condition  = block_given? ? block : @sort_ascending
+        @match_value     = block_given? ? compare_key_proc : lambda {|obj| obj }
+        @sort_ascending  = lambda {|a_obj,b_obj| @match_value.call(a_obj) >= @match_value.call(b_obj)}
+        @sort_descending = lambda {|a_obj,b_obj| @match_value.call(a_obj) <= @match_value.call(b_obj)}
+        @sort_condition  = @sort_ascending
 
         vargs.each {|value| insert(value) }
         first if vargs.size > 1
@@ -105,7 +106,7 @@ module SknUtils
       # return new size
       def insert_before(position_value, value)
         target = find_by_value(position_value)
-        node = LinkNode.new(value, target, :before)
+        node = LinkNode.new(value, target, :before, &@match_value)
         @current = node if target
         self.head = node if head === target
         self.tail = node if tail.nil?
@@ -115,7 +116,7 @@ module SknUtils
       # return new size
       def insert_after(position_value, value)
         target = find_by_value(position_value)
-        node = LinkNode.new(value, target, :after)
+        node = LinkNode.new(value, target, :after, &@match_value)
         @current = node
         self.head = node if head.nil?
         self.tail = node if tail === target
@@ -164,7 +165,7 @@ module SknUtils
         position = head
         if block_given?
           while position do
-            yield position.value.dup
+            block.call( position.value.dup )
             position = position.next
             break if position === @current
           end
@@ -193,19 +194,17 @@ module SknUtils
       end
 
       # block format: sort condition : {|a_obj,b_obj| a_obj >= b_obj}
-      def sort!(direction_sym=:default, &block)
-        active_sort_condition = block_given? ? block :
-                                    (
-                                    case direction_sym
-                                      when :asc
-                                        @sort_ascending
-                                      when :desc
-                                        @sort_descending
-                                      else
-                                        @sort_condition
-                                    end
-                                    )
-        sorted = merge_sort(to_a, active_sort_condition)
+      def sort!(direction_sym=:default, &compare_sort_proc)
+        @active_sort_condition = block_given? ? compare_sort_proc :
+                                     case direction_sym
+                                       when :asc
+                                         @sort_ascending
+                                       when :desc
+                                         @sort_descending
+                                       else
+                                         @sort_condition
+                                     end
+        sorted = merge_sort(to_a)
         clear
         sorted.each {|item| insert(item) }
         size
@@ -216,10 +215,10 @@ module SknUtils
       attr_accessor :head, :tail
 
       def find_by_value(value)
-        return nil if head.nil?
+        return nil if head.nil? or value.nil?
         prior = head
         target = prior
-        while not target.match_by_value(value)
+        while target and not target.match_by_value(value)
           prior = target
           target = prior.next
           @current = target if target
@@ -237,23 +236,23 @@ module SknUtils
 
       # Merged Sort via Ref: http://rubyalgorithms.com/merge_sort.html
       # arr is Array to be sorted, sort_cond is Proc expecting a/b params returning true/false
-      def merge_sort(arr, sort_cond)
+      def merge_sort(arr)
         return arr if arr.size < 2
 
         middle = arr.size / 2
 
-        left = merge_sort(arr[0...middle], sort_cond)
-        right = merge_sort(arr[middle..arr.size], sort_cond)
+        left = merge_sort(arr[0...middle])
+        right = merge_sort(arr[middle..arr.size])
 
-        merge(left, right, sort_cond)
+        merge(left, right)
       end
 
-      def merge(left, right, sort_cond)
+      def merge(left, right)
         sorted = []
 
         while left.any? && right.any?
 
-          if sort_cond.call(left.first, right.first)  # replace this condition with a proc
+          if @active_sort_condition.call(left.first, right.first)
             sorted.push right.shift
           else
             sorted.push left.shift

data/lib/skn_utils/lists/link_node.rb

@@ -8,10 +8,11 @@ module SknUtils
     class LinkNode
       attr_accessor :prev, :next, :value
 
-      def initialize(val, anchor_node=nil, strategy=:after)
+      def initialize(val, anchor_node=nil, strategy=:after, &cmp_key)
         @value = val
         @prev = nil
         @next = nil
+        @cmp_proc = block_given? ? cmp_key : lambda {|a| a }
 
         case strategy
           when :single # after logic
@@ -39,7 +40,7 @@ module SknUtils
       end
 
       def match_by_value(other_value)
-        self.value === other_value
+        @cmp_proc.call(value) === @cmp_proc.call(other_value)
       end
 
       # returns next node

data/lib/skn_utils/lists/linked_list.rb

@@ -8,16 +8,19 @@ module SknUtils
     class LinkedList
       attr_accessor :size
 
-      def initialize(*vargs, &block)
+      # &compare_key_proc supplies an method to identify
+      # the key of an object for comparison purposes
+      def initialize(*vargs, &compare_key_proc)
         @sort_condition = nil
         @current = nil
         @head = nil
         @tail = nil
         @size = 0
 
-        @sort_ascending  = lambda {|a_obj,b_obj| a_obj >= b_obj}
-        @sort_descending = lambda {|a_obj,b_obj| a_obj <= b_obj}
-        @sort_condition  = block_given? ? block : @sort_ascending
+        @match_value     = block_given? ? compare_key_proc : lambda {|obj| obj }
+        @sort_ascending  = lambda {|a_obj,b_obj| @match_value.call(a_obj) >= @match_value.call(b_obj)}
+        @sort_descending = lambda {|a_obj,b_obj| @match_value.call(a_obj) <= @match_value.call(b_obj)}
+        @sort_condition  = @sort_ascending
 
         vargs.each {|value| insert(value) }
         first if vargs.size > 1
@@ -96,7 +99,7 @@ module SknUtils
       # return new size
       def insert_before(position_value, value)
         prior, target = find_by_value(position_value)
-        node = LinkNode.new(value, prior, :single)
+        node = LinkNode.new(value, prior, :single, &@match_value)
         node.next = target if target
         self.head = node if head === target
         self.tail = node if tail.nil?
@@ -107,7 +110,7 @@ module SknUtils
       # return new size
       def insert_after(position_value, value)
         prior, target = find_by_value(position_value)
-        node = LinkNode.new(value, target, :single)
+        node = LinkNode.new(value, target, :single, &@match_value)
         self.head = node if head.nil?
         self.tail = node if tail === target
         @current = node
@@ -118,8 +121,8 @@ module SknUtils
       def remove(value)
         @current, target_node = find_by_value(value)
         @current.next = target_node.remove!
-        tail = @current.next if tail === target_node
-        head = @current if head === target_node
+        self.tail = @current.next if tail === target_node
+        self.head = @current if head === target_node
         self.size -= 1
       end
 
@@ -151,7 +154,7 @@ module SknUtils
         position = head
         if block_given?
           while position do
-            yield position.value.dup
+            block.call(position.value.dup )
             position = position.next
           end
         else
@@ -178,8 +181,8 @@ module SknUtils
       end
 
       # block format: sort condition : {|a_obj,b_obj| a_obj >= b_obj}
-      def sort!(direction_sym=:default, &block)
-        active_sort_condition = block_given? ? block :
+      def sort!(direction_sym=:default, &compare_sort_proc)
+        @active_sort_condition = block_given? ? compare_sort_proc :
                                      case direction_sym
                                        when :asc
                                          @sort_ascending
@@ -189,7 +192,7 @@ module SknUtils
                                          @sort_condition
                                      end
 
-        sorted = merge_sort(to_a, active_sort_condition)
+        sorted = merge_sort(to_a)
         clear
         sorted.each {|item| insert(item) }
         size
@@ -200,10 +203,10 @@ module SknUtils
       attr_accessor :head, :tail
 
       def find_by_value(value)
-        return [nil,nil] if head.nil?
+        return [nil,nil] if head.nil? or value.nil?
         prior = head
         target = prior
-        while not target.match_by_value(value)
+        while target and not target.match_by_value(value)
           prior = target
           target = prior.next
           @current = target if target
@@ -221,23 +224,23 @@ module SknUtils
 
       # Merged Sort via Ref: http://rubyalgorithms.com/merge_sort.html
       # arr is Array to be sorted, sort_cond is Proc expecting a/b params returning true/false
-      def merge_sort(arr, sort_cond)
+      def merge_sort(arr)
         return arr if arr.size < 2
 
         middle = arr.size / 2
 
-        left = merge_sort(arr[0...middle], sort_cond)
-        right = merge_sort(arr[middle..arr.size], sort_cond)
+        left = merge_sort(arr[0...middle])
+        right = merge_sort(arr[middle..arr.size])
 
-        merge(left, right, sort_cond)
+        merge(left, right)
       end
 
-      def merge(left, right, sort_cond)
+      def merge(left, right)
         sorted = []
 
         while left.any? && right.any?
 
-          if sort_cond.call(left.first, right.first)  # replace this condition with a proc
+          if @active_sort_condition.call(left.first, right.first)
             sorted.push right.shift
           else
             sorted.push left.shift

data/lib/skn_utils/version.rb

@@ -3,7 +3,7 @@ module SknUtils
   class Version
     MAJOR = 3
     MINOR = 3
-    PATCH = 2
+    PATCH = 3
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/lib/skn_utils/lists/Circular_linked_list_spec.rb

@@ -243,7 +243,7 @@ RSpec.describe SknUtils::Lists::CircularLinkedList, "Circular LinkedList " do
     let(:alpha_list) { described_class.new('Z', 'K', 'S', 'n', 's', 'z', 'k', 'N', 'o', 'A') }
     let(:hash_list)  { described_class.new({key: 'Z'}, {key: 'K'}, {key: 'S'}, {key: 'n'}, {key: 's'},
                                            {key: 'z'}, {key: 'k'}, {key: 'N'}, {key: 'o'}, {key: 'A'}
-    ) {|a,b| a[:key] >= b[:key] }
+                                          ) {|a| a[:key]}
     }
 
     it "#sort! redefines numeric list in asending order" do

data/spec/lib/skn_utils/lists/doubly_linked_list_spec.rb

@@ -243,7 +243,7 @@ RSpec.describe SknUtils::Lists::DoublyLinkedList, "Double-Ended LinkedList " do
     let(:alpha_list) { described_class.new('Z', 'K', 'S', 'n', 's', 'z', 'k', 'N', 'o', 'A') }
     let(:hash_list)  { described_class.new({key: 'Z'}, {key: 'K'}, {key: 'S'}, {key: 'n'}, {key: 's'},
                                            {key: 'z'}, {key: 'k'}, {key: 'N'}, {key: 'o'}, {key: 'A'}
-    ) {|a,b| a[:key] >= b[:key] }
+                                          ) {|a| a[:key]}
     }
 
     it "#sort! redefines numeric list in asending order" do

data/spec/lib/skn_utils/lists/linked_list_spec.rb

@@ -236,7 +236,7 @@ RSpec.describe SknUtils::Lists::LinkedList, "Singular LinkedList " do
     let(:alpha_list) { described_class.new('Z', 'K', 'S', 'n', 's', 'z', 'k', 'N', 'o', 'A') }
     let(:hash_list)  { described_class.new({key: 'Z'}, {key: 'K'}, {key: 'S'}, {key: 'n'}, {key: 's'},
                                            {key: 'z'}, {key: 'k'}, {key: 'N'}, {key: 'o'}, {key: 'A'}
-    ) {|a,b| a[:key] >= b[:key] }
+                                          ) {|a| a[:key]}
     }
 
     it "#sort! redefines numeric list in asending order" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.3.3
 platform: ruby
 authors:
 - James Scott Jr