ds 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d82d8b78c713c1df3c2a90ffba31fbb3cc0ec832
-  data.tar.gz: 852f880007ed7ea444aeed7754793510f39c370b
+  metadata.gz: 28bf2a3cbdf0ab712586b7ff90baf472f0375077
+  data.tar.gz: 676f9c0d70b61cae0f139231bdb67dab74dcce6f
 SHA512:
-  metadata.gz: dbfa87fdd20983378f200df765f5f5b9869539d4e5bf038cabe90e746b7b897b24d48d917d5e85980bb6494748b46d3424af903e530aee61a69fd271c2c4a334
-  data.tar.gz: f9fa767205e56d6424dbe304db426dd19673716cf2335cdde7c7f960128f65fece05208dd24d79f69dcf6b548f1189e412aa409eb41601275b83aa8adf222cee
+  metadata.gz: 813d6d229876d8381509fcacb9343e1509366fab0c9892e8583a684bcb41a7e0f9e4c6314105548025d720d750a18b8876504b4dd9902fc71cce38baa8094363
+  data.tar.gz: eb40a6f12a53432b67afa580c9db20de3a11d066b6d5eeec5ce82d7491e6c0167c126dcccd1c9921929f807da1be57433291d79cdfa3919d7a35f19a67b2b9c6

data/README.rdoc

@@ -160,6 +160,32 @@ Examples:
   q.peek  #=> :nevermind
 
 
+==== Indexed Priority Queue
+
+Indexed Priority Queue is special form of PriorityQueue with constant access to any element.
+Additionaly you can easily change priority of any element stored on queue.
+
+Creating new Indexed Priority Queue
+  q = IndexedPriorityQueue.new
+or
+  IndexedPriorityQueue.new { |a, b| a.key < b.key }
+
+IndexedPriorityQueue inherits from PriorityQueue so all methods from PriorityQueue are available.
+
+Examples:
+  q.push(:important, 3)
+  q.push(:very_important, 5)
+  q.push(:nevermind, 1)
+
+  q.peek #=> :very_important
+
+  q.change(:nevermind, 10)
+  q.peek #=> :nevermind
+
+Elements stored on priority queue are wrapped in Pair object, when you call get method this object is returned:
+  q.get(:very_important) #=> Pair.new(5, :very_important)
+  q.include?(:very_important) #=> true
+
 === Lists
 
 === List

data/ds.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = DS::VERSION
   s.authors     = ['knife']
   s.email       = ['satre@o2.pl']
-  s.homepage    = ''
+  s.homepage    = 'https://github.com/knife/ds'
   s.summary     = 'Some common data structures.'
   s.description = 'Data structures (lists, stacks, trees, heaps, graphs..) in pure Ruby.'
   s.rubyforge_project = 'ds'

data/lib/ds.rb

@@ -6,6 +6,7 @@ require 'ds/arrays/expandable_array'
 require 'ds/arrays/array_2d'
 require 'ds/arrays/tri_matrix'
 require 'ds/arrays/heap_store'
+require 'ds/arrays/indexed_heap_store'
 
 require 'ds/sets/indexed_set'
 
@@ -15,11 +16,13 @@ require 'ds/lists/list'
 require 'ds/stacks/stack'
 require 'ds/queues/simple_queue'
 require 'ds/queues/priority_queue'
+require 'ds/queues/indexed_priority_queue'
 
 require 'ds/trees/tree'
 require 'ds/trees/tree_walker'
 require 'ds/trees/binary_tree'
 require 'ds/trees/binary_heap'
+require 'ds/trees/indexed_binary_heap'
 require 'ds/trees/red_black_tree'
 require 'ds/trees/red_black_tree/node'
 require 'ds/trees/trie'

data/lib/ds/arrays/heap_store.rb

@@ -28,5 +28,11 @@ module DS
     def to_a
       @store[1..-1]
     end
+
+    def swap(x, y)
+      temp = self[y]
+      self[y] = self[x]
+      self[x] = temp
+    end
   end
 end

data/lib/ds/arrays/indexed_heap_store.rb

@@ -0,0 +1,49 @@
+module DS
+  # HeapStore with constant access to any element
+  class IndexedHeapStore < HeapStore
+
+    def_delegators :@store, :[]
+
+    def initialize(*args)
+      args = args.to_a
+      @map = {}
+      args.each_with_index do |e, i|
+        raise ArgumentError, 'Duplicates are not allowed' if @map[e.value]
+        @map[e.value] = i + 1
+      end
+      @store = [nil] + args
+    end
+
+    def pop
+      x = @store.pop
+      @map.delete(x)
+      x
+    end
+
+    def []=(i, x)
+      @map[x.value] = i
+      @store[i] = x
+    end
+
+    def push(x)
+      return if @map[x.value]
+      last = @store.size
+      @store.push x
+      @map[x.value] = last
+    end
+
+    def index(x)
+      @map[x]
+    end
+
+    def get(x)
+      self[index(x)] if index(x)
+    end
+
+    def swap(x, y)
+      super
+      @map[self[x].value] = x
+      @map[self[y].value] = y
+    end
+  end
+end

data/lib/ds/queues/indexed_priority_queue.rb

@@ -0,0 +1,32 @@
+module DS
+  # Indexed Priority Queue
+  class IndexedPriorityQueue < PriorityQueue
+    attr_reader :store
+    private :store
+
+    # Creates new IndexedPriorityQueue from args.
+    # This is special form of PriorityQueue where you can
+    # access any element and update its priority
+    def initialize(*args)
+      @store = if block_given?
+                 IndexedBinaryHeap.new(*args) do |parent, child|
+                   yield parent.key, child.key
+                 end
+               else
+                 IndexedBinaryHeap.new(*args) { |parent, child| parent.key >= child.key }
+               end
+    end
+
+    def update(x, priority)
+      store.change_priority(x, priority)
+    end
+
+    def get(x)
+      store.get(x)
+    end
+
+    def include?(x)
+      store.include?(x)
+    end
+  end
+end

data/lib/ds/queues/priority_queue.rb

@@ -12,6 +12,10 @@ module DS
                end
     end
 
+    def self.min(*args)
+      new(*args) { |parent, child| parent < child }
+    end
+
     # Adds element to queue with given priority.
     def enqueue(x, priority)
       pair = Pair.new(priority, x)

data/lib/ds/stacks/stack.rb

@@ -3,8 +3,9 @@ module DS
   # Internaly uses array or linked list to store elements.
   class Stack
     def initialize(*args)
-      @store = if args.first.is_a? List
-                 args.first
+      first = args.first
+      @store = if first.is_a? List
+                 first
                else
                  args || []
                end

data/lib/ds/trees/indexed_binary_heap.rb

@@ -0,0 +1,46 @@
+module DS
+  # Indexed BinaryHeap
+  class IndexedBinaryHeap < BinaryHeap
+    # Create new IndexedHeap from args.
+    # Given block is used to set heap relation.
+    # Default heap relation is Max Heap.
+    def initialize(*args, &block)
+      @relation = if block_given?
+                    block
+                  else
+                    -> (parent, child) { parent.key >= child.key }
+                  end
+      @store = IndexedHeapStore.new(*args)
+      heapify!
+    end
+
+    def change_priority(x, priority)
+      node = get(x)
+      old_priority = node.key
+      return if old_priority == priority
+
+      node.key = priority
+      index = store.index(node.value)
+
+      if higher?(priority, old_priority)
+        swim(index)
+      else
+        sink(index)
+      end
+    end
+
+    def get(x)
+      store.get(x)
+    end
+
+    def include?(x)
+      get(x) ? true : false
+    end
+
+    private
+
+    def higher?(new_priority, old_priority)
+      @relation.call(Pair.new(new_priority, nil), Pair.new(old_priority, nil))
+    end
+  end
+end

data/lib/ds/version.rb

@@ -1,4 +1,4 @@
 # Main module namespace
 module DS
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.7'.freeze
 end

data/test/test_heap_store.rb

@@ -31,4 +31,9 @@ describe HeapStore do
     @store.to_a.must_equal [1, 2, 3, 4, 5, 6, 7]
     @store.to_a.must_be_kind_of Array
   end
+
+  it '#swap swaps elements in store' do
+    @store.swap(1, 7)
+    @store.to_a.must_equal [7, 2, 3, 4, 5, 6, 1]
+  end
 end

data/test/test_indexed_binary_heap.rb

@@ -0,0 +1,45 @@
+require 'help'
+
+describe IndexedBinaryHeap do
+  before do
+    @nine = Pair.new(9, :nine)
+    @eight = Pair.new(8, :eight)
+    @four = Pair.new(4, :four)
+    @five = Pair.new(5, :five)
+    @eleven = Pair.new(11, :eleven)
+    @six = Pair.new(6, :six)
+
+    @arr = [@nine, @eight, @four, @five, @eleven, @six]
+    @heap = IndexedBinaryHeap.new(*@arr)
+  end
+
+  it 'creates heap from array.' do
+    @heap.to_a.must_equal [@eleven, @nine, @six, @five, @eight, @four]
+  end
+
+  it '#change_priority changes priority for given heap element.' do
+    @heap.change_priority(:five, 20)
+    @heap.top.value.must_equal :five
+  end
+
+  it '#insert adds new element maintaining heap relation.' do
+    @heap.size.must_equal 6
+    fourteen = Pair.new(14, :fourteen)
+    @heap.insert(fourteen).to_a.must_equal [fourteen, @nine, @eleven, @five, @eight, @four, @six]
+    @heap.size.must_equal 7
+  end
+
+  it '#top returns max or min heap element.' do
+    @heap.top.must_equal @eleven
+    @heap.shift
+    @heap.top.must_equal @nine
+  end
+
+  it '#shift removes element from heap maintaining heap relation.' do
+    @heap.shift.must_equal @eleven
+    @heap.to_a.must_equal [@nine, @eight, @six, @five, @four]
+    @heap.shift.must_equal @nine
+    @heap.to_a.must_equal [@eight, @five, @six, @four]
+    @heap.shift.must_equal @eight
+  end
+end

data/test/test_indexed_heap_store.rb

@@ -0,0 +1,78 @@
+require 'help'
+
+describe IndexedHeapStore do
+  before do
+    @first  = Pair.new(1, 1)
+    @second = Pair.new(2, 2)
+    @third  = Pair.new(3, 3)
+    @fourth = Pair.new(4, 4)
+    @store = IndexedHeapStore.new(@first, @second, @third, @fourth)
+  end
+
+  it '#new raises error if arguments contains duplicates' do
+    proc { IndexedHeapStore.new(Pair.new(1, 9), Pair.new(2, 9)) }
+      .must_raise ArgumentError
+  end
+
+  it '#size returns store size.' do
+    @store.size.must_equal 4
+  end
+
+  it 'indexing starts form one.' do
+    @store[1].must_equal @first
+  end
+
+  it '#first returns element at index 1.' do
+    @store.first.must_equal @first
+  end
+
+  describe '#pop' do
+    it 'removes last element.' do
+      @store.pop.must_equal @fourth
+      @store.size.must_equal 3
+    end
+
+    it 'updates store index' do
+      last = @store.pop
+      @store.index(last).must_be_nil
+      @store.get(last).must_be_nil
+    end
+  end
+
+  describe '#push' do
+    it 'adds element to store.' do
+      fifth = Pair.new(5, 5)
+      @store.push fifth
+      @store.size.must_equal 5
+    end
+
+    it 'ignores duplicates.' do
+      @store.push(@first).must_be_nil
+      @store.size.must_equal 4
+
+      @store.push(Pair.new(1, 1)).must_be_nil
+      @store.size.must_equal 4
+    end
+  end
+
+  it '#index returns heap index for given element' do
+    @store.index(@first.value).must_equal 1
+    @store.index(@third.value).must_equal 3
+    @store.index(:not_in_store).must_be_nil
+  end
+
+  it '#get returns element from store' do
+    @store.get(1).value.must_equal 1
+    @store.get(9).must_be_nil
+  end
+
+  it '#to_a returns array representation.' do
+    @store.to_a.must_equal [@first, @second, @third, @fourth]
+    @store.to_a.must_be_kind_of Array
+  end
+
+  it '#swap swaps elements in store' do
+    @store.swap(1, 4)
+    @store.to_a.must_equal [@fourth, @second, @third, @first]
+  end
+end

data/test/test_indexed_priority_queue.rb

@@ -0,0 +1,139 @@
+require 'help'
+
+describe IndexedPriorityQueue do
+  describe 'Empty indexed priority queue' do
+    before do
+      @empty_queue = IndexedPriorityQueue.new
+    end
+
+    it 'is empty.' do
+      @empty_queue.must_be_empty
+    end
+
+    it 'has zero elements.' do
+      @empty_queue.length.must_equal 0
+    end
+  end
+
+  describe 'Not empty indexed priority queue' do
+    before do
+      @queue = IndexedPriorityQueue.new
+      @queue.enqueue :important, 2
+      @queue.enqueue :not_important, 1
+    end
+
+    it 'is not empty.' do
+      @queue.wont_be_empty
+      @queue.length.must_equal 2
+    end
+
+    it '#update changes element priority' do
+      @queue.update(:important, 0)
+      @queue.peek.must_equal :not_important
+    end
+
+    it '#get returns element from queue' do
+      x = @queue.get(:important)
+      x.must_be_kind_of Pair
+      x.value.must_equal :important
+      @queue.peek.must_equal :important
+    end
+
+    it '#include? returns true if element is stored on queue.' do
+      @queue.include?(:important).must_equal true
+      @queue.include?(:bar).must_equal false
+    end
+
+    it '#peek returns element with highest priority.' do
+      @queue.peek.must_equal :important
+    end
+
+    it '#enqueue and #push should add element to priority queue.' do
+      @queue.enqueue :very_important, 5
+      @queue.push :nevermind, 0
+      @queue.length.must_equal 4
+    end
+
+    it '#dequeue and #shift should remove element with highest priority.' do
+      x = @queue.dequeue
+      @queue.length.must_equal 1
+      x.must_equal :important
+      @queue.dequeue.must_equal :not_important
+      @queue.length.must_equal 0
+      @queue.dequeue.must_be_nil
+    end
+  end
+
+  describe 'Not empty indexed priority queue with custom order' do
+    before do
+      @queue = IndexedPriorityQueue.new { |a, b| a < b }
+      @queue.enqueue 'gamma', 'g'
+      @queue.enqueue 'alpha', 'a'
+      @queue.enqueue 'beta', 'b'
+    end
+
+    it 'should not be empty.' do
+      refute @queue.empty?
+      @queue.length.must_equal 3
+    end
+
+    it '#peek should return element with highest priority.' do
+      @queue.peek.must_equal 'alpha'
+    end
+
+    it '#change should change element priority.' do
+      @queue.update('alpha', 'l')
+      @queue.peek.must_equal('beta')
+    end
+
+    it '#dequeue and #shift should remove element with highest priority.' do
+      x = @queue.dequeue
+      @queue.length.must_equal 2
+      x.must_equal 'alpha'
+      @queue.dequeue.must_equal 'beta'
+      @queue.length.must_equal 1
+    end
+  end
+
+  describe 'IndexedPriorityQueue with duplications' do
+    before do
+      @dup_queue = IndexedPriorityQueue.new(Pair.new(2, :same_important))
+      @dup_queue.enqueue :important, 2
+      @dup_queue.enqueue :not_important, 1
+    end
+
+    it 'is not empty.' do
+      @dup_queue.wont_be_empty
+      @dup_queue.length.must_equal 3
+    end
+
+    it '#peek returns element with highest priority.' do
+      [:important, :same_important].must_include @dup_queue.peek
+      @dup_queue.dequeue
+      [:important, :same_important].must_include @dup_queue.peek
+      @dup_queue.dequeue
+      @dup_queue.peek.must_equal :not_important
+    end
+
+    it '#enqueue and #push adds element to priority queue.' do
+      @dup_queue.push :nevermind, 0
+      @dup_queue.push :another_important, 2
+      @dup_queue.length.must_equal 5
+    end
+
+    it '#enqueue does\'t add elements that are already in queue.' do
+      @dup_queue.dequeue
+      @dup_queue.length.must_equal 2
+      @dup_queue.enqueue :important, 2
+      @dup_queue.length.must_equal 2
+      @dup_queue.dequeue.must_equal :important
+      @dup_queue.dequeue.must_equal :not_important
+    end
+
+    it '#dequeue and #shift removes element with highest priority.' do
+      x = @dup_queue.dequeue
+      [:important, :same_important].must_include x
+      @dup_queue.length.must_equal 2
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ds
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - knife
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,16 +71,19 @@ files:
 - lib/ds/arrays/array_2d.rb
 - lib/ds/arrays/expandable_array.rb
 - lib/ds/arrays/heap_store.rb
+- lib/ds/arrays/indexed_heap_store.rb
 - lib/ds/arrays/tri_matrix.rb
 - lib/ds/lists/list.rb
 - lib/ds/lists/list_element.rb
 - lib/ds/pair.rb
+- lib/ds/queues/indexed_priority_queue.rb
 - lib/ds/queues/priority_queue.rb
 - lib/ds/queues/simple_queue.rb
 - lib/ds/sets/indexed_set.rb
 - lib/ds/stacks/stack.rb
 - lib/ds/trees/binary_heap.rb
 - lib/ds/trees/binary_tree.rb
+- lib/ds/trees/indexed_binary_heap.rb
 - lib/ds/trees/red_black_tree.rb
 - lib/ds/trees/red_black_tree/node.rb
 - lib/ds/trees/tree.rb
@@ -100,6 +103,9 @@ files:
 - test/test_binary_tree.rb
 - test/test_expandable_array.rb
 - test/test_heap_store.rb
+- test/test_indexed_binary_heap.rb
+- test/test_indexed_heap_store.rb
+- test/test_indexed_priority_queue.rb
 - test/test_indexed_set.rb
 - test/test_list.rb
 - test/test_list_element.rb
@@ -112,7 +118,7 @@ files:
 - test/test_tree_walker.rb
 - test/test_tri_matrix.rb
 - test/test_trie.rb
-homepage: ''
+homepage: https://github.com/knife/ds
 licenses: []
 metadata: {}
 post_install_message: 
@@ -131,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ds
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Some common data structures.
@@ -142,3 +148,4 @@ test_files:
 - test/performance/rbt_performance_test.rb
 - test/performance/simple_queue_performance_test.rb
 - test/performance/stack_test.rb
+has_rdoc: