skn_utils 3.3.4 → 3.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fc867ac95eebf226b53be3336ddf721265150d4
-  data.tar.gz: a70380b703cd8f20d25b314f7710720788953669
+  metadata.gz: 84cb7bcd483e3369c94109704c491658263a497d
+  data.tar.gz: 0fefb9e19e864638acfeaa605dd315e12db33a0c
 SHA512:
-  metadata.gz: 5a72919f92f6e597edec5bedb80beece8a45b68741471e3c9e422ca6a572b6029e023b226ecd26966f27706653426d772737bdca241c0072f525802145588b07
-  data.tar.gz: b7f22a691d0c272dc4d48ae92713bbf73ededd4666994d04ec3ee1d6e463cbf86598f0833e619007eed81251624baea8c3fe87342987a67ca0a0703b17d1a087
+  metadata.gz: 66f1414ed28fae1ab9e2701c6d21590e9ea463303964c23de9ffd0f3eabe5df701bc18bb6cceb9c98752d353038d79bbffb97909d1dd447c683eeafc88c9cb12
+  data.tar.gz: 3552bd034096bc4c60f339082af9a22f09bfe57e4c53b589507306e3e190e7598a5b765da62f7ad561fa5270df14652f6272d9d939359c32901cc10802c54abe

data/bin/bench_linklists.rb

@@ -0,0 +1,74 @@
+#!/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
+
+# Warming up --------------------------------------
+# LinkedList Ops     2.297k i/100ms
+#      Array Ops    34.468k i/100ms
+# Calculating -------------------------------------
+# 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]
+  cproc  = lambda {|a| a}
+
+  x.report('LinkedList Ops') do
+    ll = SknUtils::Lists::LinkedList.new(*vargs, &cproc)
+    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/bin/{benchmark.rb → bench_nested_result.rb}

@@ -35,6 +35,21 @@ end
 
 suite = GCSuite.new
 
+# Warming up --------------------------------------
+#      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
+#
+
 Benchmark.ips do |x|
   x.config(:suite => suite)
 
@@ -65,54 +80,3 @@ Benchmark.ips do |x|
 
   x.compare!
 end
-
-# Warming up --------------------------------------
-#      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 -------------------------------------
-# 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

@@ -1,3 +1,26 @@
+##
+# File <SknUtils>/lib/skn_utils/lists/circular_linked_list.rb
+#
+#     ll = SknUtils::Lists::CircularLinkedList.new(*vargs, &compare_key_proc)
+# - or -
+#     ll = SknUtils::Lists::CircularLinkedList.new(1,2,3,4,5) {|element| element[:key] }
+# - or -
+#     ll = SknUtils::Lists::CircularLinkedList.new(
+#                     {key: 'Z'}, {key: 'K'}, {key: 'S'}, {key: 'n'}, {key: 's'}
+#          ) {|el| el[:key] }
+# - or -
+#     cmp_proc = lambda { |el| el[:key] }
+#     vargs = [{key: 'Z'}, {key: 'K'}, {key: 'S'}, {key: 'n'}, {key: 's'}]
+#     ll = SknUtils::Lists::CircularLinkedList.new(*vargs, &cmp_proc)
+###
+# value = ll.first
+# value = ll.at_index(4)
+# count = ll.insert({key: 'anyValue'})
+# ...
+# count = ll.sort!           -- defaults to :asc
+# count = ll.sort!(:desc)
+# count = ll.sort!() {|a,b| a[:key] <= b[:key] }
+##
 
 module SknUtils
   module Lists
@@ -29,7 +52,7 @@ module SknUtils
       # return values and position current to last node accessed
       # prevent @current from nil assignment
       def first
-        @current = head if head
+        @current = self.head if self.head
         @current.value rescue nil
       end
 
@@ -48,7 +71,7 @@ module SknUtils
       end
 
       def last
-        @current = tail if tail
+        @current = self.tail if self.tail
         @current.value rescue nil
       end
 
@@ -81,7 +104,7 @@ module SknUtils
       end
 
       def empty?
-        size == 0
+        self.size == 0
       end
 
       #
@@ -96,12 +119,12 @@ module SknUtils
 
       # return new size
       def prepend(value)
-        temp = head.value rescue nil
+        temp = self.head.value rescue nil
         insert_before(temp, value)
       end
       # return new size
       def append(value)
-        temp = tail.value rescue nil
+        temp = self.tail.value rescue nil
         insert_after(temp, value)
       end
 
@@ -109,9 +132,19 @@ module SknUtils
       def insert_before(position_value, value)
         target = find_by_value(position_value)
         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?
+        @current = node
+        if self.size == 0           # only
+          self.head =  node
+          self.tail =  node
+        elsif self.head == target   # new head
+          self.head      =  node
+          node.prev      = self.tail
+          self.tail.next = node
+        elsif self.tail == target
+          self.tail =  node
+          node.next      = self.head
+          self.head.prev = node
+        end
         self.size += 1
       end
 
@@ -120,8 +153,18 @@ module SknUtils
         target = find_by_value(position_value)
         node = LinkNode.new(value, target, :circle_after, &@match_value)
         @current = node
-        self.head = node if head.nil?
-        self.tail = node if tail === target
+        if self.size == 0           # only
+          self.head =  node
+          self.tail =  node
+        elsif self.tail == target
+          self.tail =  node
+          node.next      = self.head
+          self.head.prev = node
+        elsif self.head == target   # new head
+          self.head      =  node
+          node.prev      = self.tail
+          self.tail.next = node
+        end
         self.size += 1
       end
 
@@ -129,25 +172,40 @@ module SknUtils
       def remove(value)
         target_node = find_by_value(value)
         if target_node
-          @current = target_node.prev
-          @current.next = target_node.next
-          @current.next.prev = @current if @current and @current.next and @current.next.prev
+          if self.size == 1                           # will become zero
+            @current = nil
+            self.head = nil
+            self.tail = nil
+          elsif target_node === self.head            # top
+            @current = target_node.next
+            @current.prev = target_node.prev
+            self.tail.next = @current
+            self.head = @current
+          elsif target_node === self.tail            # bottom
+            @current = target_node.prev
+            @current.next = target_node.next
+            self.head.prev = @current
+            self.tail = @current
+          else                                   # middle
+            @current           = target_node.prev
+            @current.next      = target_node.next
+            @current.next.prev = @current
+          end
           target_node.remove!
+          self.size -= 1
         end
-        self.tail = @current if tail === target_node
-        self.head = @current if head === target_node
-        self.size -= 1
       end
 
+
       # return number cleared
       def clear
         rc = 0
-        node = head
-        position = head
+        node = self.head
+        position = node
         while node do
           node = node.remove!
           rc += 1
-          break if position === node
+          break if position.equal?(node)
         end
 
         @current = nil
@@ -163,8 +221,8 @@ module SknUtils
 
       # perform each() or return enumerator
       def each(&block)
-        @current = head
-        position = head
+        @current = self.head
+        position = self.head
         if block_given?
           while position do
             block.call( position.value.dup )
@@ -184,13 +242,13 @@ module SknUtils
 
       # convert self to a value array
       def to_a
-        @current = head
-        position = head
+        @current = self.head
+        position = self.head
         result = []
         while position do
           result << position.value.dup
           position = position.next
-          break if position === @current
+          break if position.equal?(@current)
         end
         result
       end
@@ -206,33 +264,34 @@ module SknUtils
                                        else
                                          @sort_condition
                                      end
-        sorted = merge_sort(to_a)
+        sorted = merge_sort(self.to_a)
         clear
         sorted.each {|item| insert(item) }
-        size
+        self.size
       end
 
-    private
+    protected
 
       attr_accessor :head, :tail
 
       def find_by_value(value)
-        return nil if head.nil? or value.nil? or size == 0
-        prior = head
-        target = prior
-        while target and not target.match_by_value(value)
-          prior = target
-          target = prior.next
-          @current = target if target
+        return nil if value.nil? || self.size == 0
+        stop_node = self.head
+        target = stop_node
+        rtn_node = nil
+        while !target.match_by_value(value)
+          target = target.next
+          break if stop_node.equal?(target)
         end
+        target = nil unless target.match_by_value(value)
         target
       end
 
       def find_by_index(index)
-        return nil if head.nil? or index < 1 or index > size
-        node = head
-        node = node.next while ((index -= 1) > 0 and node.next)
-        @current = node if node
+        return nil if ( index > self.size || index < 1 )
+        node = self.head
+        node = node.next while ( (index -= 1) > 0 )
+        @current = node
         node
       end
 
@@ -240,26 +299,20 @@ module SknUtils
       # arr is Array to be sorted, sort_cond is Proc expecting a/b params returning true/false
       def merge_sort(arr)
         return arr if arr.size < 2
-
         middle = arr.size / 2
-
-        left = merge_sort(arr[0...middle])
-        right = merge_sort(arr[middle..arr.size])
-
+          left = merge_sort(arr[0...middle])
+          right = merge_sort(arr[middle..arr.size])
         merge(left, right)
       end
 
       def merge(left, right)
         sorted = []
-
         while left.any? && right.any?
-
           if @active_sort_condition.call(left.first, right.first)
             sorted.push right.shift
           else
             sorted.push left.shift
           end
-
         end
 
         sorted + left + right

data/lib/skn_utils/lists/doubly_linked_list.rb

@@ -1,3 +1,26 @@
+##
+# File <SknUtils>/lib/skn_utils/lists/doubly_linked_list.rb
+#
+#     ll = SknUtils::Lists::DoublyLinkedList.new(*vargs, &compare_key_proc)
+# - or -
+#     ll = SknUtils::Lists::DoublyLinkedList.new(1,2,3,4,5) {|element| element[:key] }
+# - or -
+#     ll = SknUtils::Lists::DoublyLinkedList.new(
+#                     {key: 'Z'}, {key: 'K'}, {key: 'S'}, {key: 'n'}, {key: 's'}
+#          ) {|el| el[:key] }
+# - or -
+#     cmp_proc = lambda { |el| el[:key] }
+#     vargs = [{key: 'Z'}, {key: 'K'}, {key: 'S'}, {key: 'n'}, {key: 's'}]
+#     ll = SknUtils::Lists::DoublyLinkedList.new(*vargs, &cmp_proc)
+###
+# value = ll.first
+# value = ll.at_index(4)
+# count = ll.insert({key: 'anyValue'})
+# ...
+# count = ll.sort!           -- defaults to :asc
+# count = ll.sort!(:desc)
+# count = ll.sort!() {|a,b| a[:key] <= b[:key] }
+##
 
 module SknUtils
   module Lists
@@ -127,14 +150,26 @@ module SknUtils
       def remove(value)
         target_node = find_by_value(value)
         if target_node
-          @current = target_node.prev if target_node.prev
-          @current.next = target_node.next if target_node.next
-          @current.next.prev = @current if @current and @current.next and @current.next.prev
+          if size == 1                           # will become zero
+            @current = nil
+            self.head = nil
+            self.tail = nil
+          elsif target_node.prev.nil?            # top
+            @current = target_node.next
+            @current.prev = nil
+            self.head = @current
+          elsif target_node.next.nil?            # bottom
+            @current = target_node.prev
+            @current.next = nil
+            self.tail = @current
+          else                                   # middle
+            @current = target_node.prev
+            @current.next = target_node.next
+            target_node.next.prev = @current
+          end
           target_node.remove!
+          self.size -= 1
         end
-        self.tail = @current if tail === target_node
-        self.head = @current if head === target_node
-        self.size -= 1
       end
 
       # return number cleared
@@ -215,13 +250,12 @@ module SknUtils
       attr_accessor :head, :tail
 
       def find_by_value(value)
-        return nil if head.nil? or value.nil?
+        return nil if head.nil? || value.nil? || size == 0
         prior = head
         target = prior
         while target and not target.match_by_value(value)
           prior = target
           target = prior.next
-          @current = target if target
         end
         target
       end

data/lib/skn_utils/lists/link_node.rb

@@ -16,26 +16,26 @@ module SknUtils
 
         case strategy
           when :single # after logic
-            anchor_node.next = self if anchor_node
+            if anchor_node
+              @next = anchor_node.next
+              anchor_node.next = self
+            end
           when :before
             @prev = anchor_node.prev if anchor_node
-            @next = anchor_node
             anchor_node.prev = self if anchor_node
+            @next = anchor_node
           when :after
-            @prev = anchor_node
             @next = anchor_node.next if anchor_node
             anchor_node.next = self if anchor_node
-            @next.prev = self if @next
+            @prev = anchor_node
           when :circle_before
             @prev = anchor_node ? anchor_node.prev : self
-            @next = anchor_node ? anchor_node : self
             anchor_node.prev = self if anchor_node
-            @prev.next = self if anchor_node
+            @next = anchor_node ? anchor_node : self
           when :circle_after
-            @prev = anchor_node ? anchor_node : self
             @next = anchor_node ? anchor_node.next : self
             anchor_node.next = self if anchor_node
-            @next.prev = self if anchor_node
+            @prev = anchor_node ? anchor_node : self
         end
       end
 

data/lib/skn_utils/lists/linked_list.rb

@@ -1,3 +1,26 @@
+##
+# File <SknUtils>/lib/skn_utils/lists/linked_list.rb
+#
+#     ll = SknUtils::Lists::LinkedList.new(*vargs, &compare_key_proc)
+# - or -
+#     ll = SknUtils::Lists::LinkedList.new(1,2,3,4,5) {|element| element[:key] }
+# - or -
+#     ll = SknUtils::Lists::LinkedList.new(
+#                     {key: 'Z'}, {key: 'K'}, {key: 'S'}, {key: 'n'}, {key: 's'}
+#            ) {|el| el[:key] }
+# - or -
+#     cmp_proc = lambda { |el| el[:key] }
+#     vargs = [{key: 'Z'}, {key: 'K'}, {key: 'S'}, {key: 'n'}, {key: 's'}]
+#     ll = SknUtils::Lists::LinkedList.new(*vargs, &cmp_proc)
+###
+# value = ll.first
+# value = ll.at_index(4)
+# count = ll.insert({key: 'anyValue'})
+# ...
+# count = ll.sort!           -- defaults to :asc
+# count = ll.sort!(:desc)
+# count = ll.sort!() {|a,b| a[:key] <= b[:key] }
+##
 
 module SknUtils
   module Lists
@@ -50,7 +73,7 @@ module SknUtils
         @current.value rescue nil
       end
 
-      # -+ int position from current node
+      # +int position from current node
       def nth(index)
         node = @current
         while index > 1 and node and node.next
@@ -60,8 +83,6 @@ module SknUtils
         end
         # no reverse or prev for Single List
         current
-      rescue NoMethodError
-        nil
       end
 
       # return node at positive index from head
@@ -119,10 +140,11 @@ module SknUtils
 
       # return remaining size
       def remove(value)
-        @current, target_node = find_by_value(value)
-        @current.next = target_node.remove!
-        self.tail = @current.next if tail === target_node
-        self.head = @current if head === target_node
+        prior, target_node = find_by_value(value)
+        @current = prior.nil? ? target_node.next : prior
+        @current.next = target_node.remove! if @current && target_node
+        self.tail = @current.next if @current && tail === target_node
+        self.head = @current.next if @current && head === target_node
         self.size -= 1
       end
 
@@ -203,19 +225,19 @@ module SknUtils
       attr_accessor :head, :tail
 
       def find_by_value(value)
-        return [nil,nil] if head.nil? or value.nil?
-        prior = head
+        return [@current, nil] if head.nil? || value.nil?
+        prior  = head
         target = prior
         while target and not target.match_by_value(value)
           prior = target
-          target = prior.next
-          @current = target if target
+          target = target.next
+          @current = prior if target
         end
         [prior, target]
       end
 
       def find_by_index(index)
-        return nil if head.nil? or index < 1 or index > size
+        return nil if head.nil? || index < 1 || index > size
         node = head
         node = node.next while ((index -= 1) > 0 and node.next)
         @current = node if node

data/lib/skn_utils/version.rb

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