algorithmix 0.0.0.4.1 → 0.0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d842f0aaccbd42b0b889d9eb1f3e8c7dac5d84a
-  data.tar.gz: 7908a79a6005b07d6aa97f50ece276b0d4a33650
+  metadata.gz: 975f3659a8220362ddb0e074ad0f9c826615e31a
+  data.tar.gz: 450f70a7bb070aae708b3112122c2fb0cc823957
 SHA512:
-  metadata.gz: d3ce32ef804f089f1db22aed4749e953fa643156dd8d482af0dffd9670bf74aa3fa066a0b36862d12ea69c0849e0d30e3501051ff6e25c94cb9f74f0d6cefec8
-  data.tar.gz: 66983d3763e7d7b29c0562b7a2ad6df3289c0664b769d13e21013443dfc26ea3ab8589f091d2e77733bfffa5e048886aa529d6d5ad01cfc98bb28c7e41b45b80
+  metadata.gz: 5b63a0d62dee71d7b3da52450a8fccb6b945fcdb99117d72f727099aa0e86114ae945ec9b7107c1bd2ad772a3e9cb78f559edf3327cdfa64c1be857da69c9951
+  data.tar.gz: 3302c670ade851248a144a0c39504c00309fd7325bb12debe71f0ca2e4182d167484b8f4ea20559b5d7ab02a5cfbc5f370bdebd5d10d3b2d8de6c6684a0fdfb0

data/README.md

@@ -9,6 +9,8 @@ The gem contains various implementations of known and unknown data structures an
 :construction: Because the gem is still not ready, with each new implementation of a data structure or an algorithm, a new
 minor version will be released.
 
+![Gem](https://img.shields.io/badge/min-0.0.0.4.1-green.svg) Fix couple of bugs in BinaryHeap
+
 ![Gem](https://img.shields.io/badge/min-0.0.0.4-green.svg) [**BinaryHeap**](https://github.com/monzita/algorithmix/wiki/BinaryHeap)
 
 ![Gem](https://img.shields.io/badge/min-0.0.0.3-green.svg) [**Deque**](https://github.com/monzita/algorithmix/wiki/Deque)

data/algorithmix.gemspec

@@ -10,12 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["*@*.*"]
   spec.summary       = %q{The gem contains various implementations of known and uknown data structures and algorithms}
   spec.description   = <<-DOC
-                          Currently the gem contains:\n
-                          1. Stack\n
-                          2. Queue\n
-                          3. Deque\n
-                          4. Binary heap\n
-
+                          The gem contains various implementations of known and uknown data structures and algorithms. 
+                          /Currently the gem contains: #stack, #queue, #deque, #binary_heap, #priority_queue/
                         DOC
   spec.homepage      = "https://github.com/monzita/algorithmix/wiki"
   spec.license       = "MIT"

data/lib/algorithmix/data_structure/generic/deque.rb

@@ -93,6 +93,11 @@ module Algorithmix
           @container.size
         end
 
+        # (see #size)
+        def length
+          @container.size
+        end
+
         # Returns the element at given index.
         #
         # @param idx

data/lib/algorithmix/data_structure/generic/priority_queue.rb

@@ -0,0 +1,354 @@
+# Documentation: https://github.com/monzita/algorithmix/wiki/PriorityQueue
+
+module Algorithmix
+  module DataStructure
+    module Generic
+
+      class PriorityQueue
+        attr_reader :binary_heap
+
+        # Creates a new priority queue.
+        #
+        # @param obj [#to_a] can be any object, which responds to #to_a method
+        # @kwarg copy [true, false] if set to true, makes a copy of content of the given object
+        # @kwarg min [true, false] sets the main property of the new priority queue. By default max priority queue is created.
+        # @raise ArgumentError, if given object doesn't respond to to_a method.
+        # @return [PriorityQueue]
+        def initialize(obj = nil, copy: false, min: false)
+          @binary_heap = Heap::BinaryHeap.new(obj, copy: copy, min: min)
+          @max = min ? false : true
+        end
+
+        # Assigns content of an object, to content of the queue.
+        #
+        # @param obj [#to_a]
+        # @kwarg copy [true, false]
+        # @raise ArgumentError
+        # @return self object [PriorityQeue]
+        def assign(obj, copy: false)
+          @binary_heap.assign(obj, copy: copy)
+          self
+        end
+
+        # Inserts a value in the queue.
+        #
+        # @param value
+        # @return [PriorityQueue] self object
+        def push(value)
+          @binary_heap.insert(value)
+          self
+        end
+
+        # (see #push)
+        def <<
+          push(value)
+        end
+
+        # Removes the element with highest or lowest priority of the queue.
+        #
+        # @raise Algorithmix::EmptyContainerError, if the queue is empty.
+        # @return element with the highest or lowest priority
+        def pop
+          raise EmptyContainerError, "The priority queue is empty." if @binary_heap.empty?
+          @binary_heap.extract
+        end
+
+        # Returns the element with the highest or lowest priority without removing it from the queue.
+        def front
+          @binary_heap.top
+        end
+
+        # Returns number of elements in the queue.
+        def size
+          @binary_heap.size
+        end
+
+        # (see #size)
+        def length
+          @binary_heap.size
+        end
+
+        # Returns information for the content of the queue - are there any elements, or no.
+        def empty?
+          @binary_heap.empty?
+        end
+
+        # Comapres contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a PriorityQueue.
+        # @return [true, false] true if contents are equal, false otherwise
+        def ==(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#== for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          to_a == priority_queue.to_a
+        end
+
+        # (see #==)
+        def eql?(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#eql? for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          self == priority_queue
+        end
+
+        # Comapres contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a PriorityQueue.
+        # @return [true, false] true if contents are different, false otherwise
+        def !=(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#!= for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          to_a != priority_queue.to_a
+        end
+
+        # (see #!=)
+        def diff?(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#diff? for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          self != priority_queue
+        end
+
+        # Comapres contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a PriorityQueue.
+        # @return 1 if content of the queue is > content of the given queue, 0 if contents are euqal, -1 if content of the given queue is > content of the queue
+        def <=>(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#<=> for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          to_a <=> priority_queue.to_a
+        end
+
+        # Converts content of the queue to an array.
+        #
+        # @return array with elements of the queue
+        def to_a
+          @binary_heap.to_a
+        end
+
+        # Clears content of the queue.
+        #
+        # @return [PriorityQueue] self object
+        def clear
+          @binary_heap.clear
+          self
+        end
+
+        # Concatenates contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] a new priority queue
+        def +(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#+ for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          PriorityQueue.new(@binary_heap + priority_queue.send(:binary_heap), min: !@max)
+        end
+
+        # (see #+)
+        def concat(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#concat for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          self + priority_queue
+        end
+
+        # (see #+)
+        def merge(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#merge for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          self + priority_queue
+        end
+
+        # Concatenates contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] self object
+        def concat!(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#concat! for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          @binary_heap.concat!(priority_queue.send(:binary_heap))
+          self
+        end
+
+        # Concatenates contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] self object
+        def merge!(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#merge! for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          @binary_heap.merge!(priority_queue.send(:binary_heap))
+          self
+        end
+
+        # Unites contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] a new priority queue
+        def |(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#| for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          PriorityQueue.new(@binary_heap | priority_queue.send(:binary_heap), min: !@max)
+        end
+
+        # (see #|)
+        def union(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#union for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          self | priority_queue
+        end
+
+        # Unites contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] self object
+        def union!(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#union! for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+           @binary_heap = @binary_heap | priority_queue.send(:binary_heap)
+          self
+        end
+
+        # Finds the intersection of contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] a new priority queue
+        def &(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#& for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          PriorityQueue.new(@binary_heap & priority_queue.send(:binary_heap), min: !@max)
+        end
+
+        # (see #&)
+        def intersect(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#intersect for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          self & priority_queue
+        end
+
+        # Finds the intersection contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] self object
+        def intersect!(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#intersect! for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          @binary_heap.intersect!(priority_queue.send(:binary_heap))
+          self
+        end
+
+        # Finds the difference of contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] a new priority queue
+        def -(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#- for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          PriorityQueue.new(@binary_heap - priority_queue.send(:binary_heap), min: !@max)
+        end
+
+        # (see #-)
+        def difference(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#difference for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          self - priority_queue
+        end
+
+        # Finds the difference of contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] self object
+        def difference!(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#difference! for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          @binary_heap.difference!(priority_queue.send(:binary_heap))
+          self
+        end
+
+        # Finds the symmetric difference of contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] a new priority queue
+        def ^(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#^ for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          PriorityQueue.new(@binary_heap ^ priority_queue.send(:binary_heap), min: !@max)
+        end
+
+        # (see #^)
+        def symmetric_difference(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#symmetric_difference for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          self ^ priority_queue
+        end
+
+        # Finds the symmetric difference of contents of the queue and a queue given as argument.
+        #
+        # @param priority_queue [PriorityQueue]
+        # @raise ArgumentError, if given object is not a priority queue
+        # @return [PriorityQueue] self object
+        def symmetric_difference!(priority_queue)
+          raise ArgumentError, "Undefined method PriorityQueue#symmetric_difference! for #{priority_queue}:#{priority_queue.class}" unless priority_queue.is_a?(PriorityQueue)
+          @binary_heap.symmetric_difference!(priority_queue.send(:binary_heap))
+          self
+        end
+
+        # Filters elements of the queue by given condition.
+        #
+        # @param &block
+        # @return [PriorityQueue] a new priority queue
+        def select(&block)
+          PriorityQueue.new(@binary_heap.select { |e| block.call(e) }, min: !@max)
+        end
+
+        # Filters elements of the queue by given condition.
+        #
+        # @param &block
+        # @return [PriorityQueue] self object
+        def select!(&block)
+          @binary_heap.select! { |e| block.call(e) }
+          self
+        end
+
+        # (see #select)
+        def filter(&block)
+          select(&block)
+        end
+
+        # (see #select!)
+        def filter!(&block)
+          select!(&block)
+        end
+
+        # (see #select)
+        def find_all(&block)
+          select(&block)
+        end
+
+        # (see #select!)
+        def find_all!(&block)
+          select!(&block)
+        end
+
+        # Applies a function to each element of the queue.
+        #
+        # @param &block
+        # @return [PriorityQueue] a new priority queue
+        def map(&block)
+          PriorityQueue.new(@binary_heap.map { |e| block.call(e)}, min: !@max)
+        end
+
+        # Applies a function to each element of the queue.
+        #
+        # @param &block
+        # @return [PriorityQueue] self object
+        def map!(&block)
+          @binary_heap.map! { |e| block.call(e) }
+          self
+        end
+
+        # (see #map)
+        def apply(&block)
+          map(&block)
+        end
+
+        # (see #map!)
+        def apply!(&block)
+          map!(&block)
+        end
+
+        private :binary_heap
+
+      end
+    end
+  end
+end

data/lib/algorithmix/data_structure/generic/queue.rb

@@ -58,6 +58,11 @@ module Algorithmix
           @container.size
         end
 
+        # (see #size)
+        def length
+          @container.size
+        end
+
         # Checks if the queue is empty.
         def empty?
           @container.empty?

data/lib/algorithmix/data_structure/generic/stack.rb

@@ -53,6 +53,11 @@ module Algorithmix
           @container.size
         end
 
+        # (see #size)
+        def length
+          @container.size
+        end
+
         # Returns the top element of the stack, without removing it. 
         # If the stack is empty, returns nil.
         def top

data/lib/algorithmix/data_structure/heap/binary_heap.rb

@@ -70,6 +70,11 @@ module Algorithmix
           @container.size
         end
 
+        # (see #size)
+        def length
+          @container.size
+        end
+
         # Returns information for current ...
         def empty?
           @container.empty?

data/lib/algorithmix/version.rb

@@ -1,3 +1,3 @@
 module Algorithmix
-  VERSION = "0.0.0.4.1"
+  VERSION = "0.0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algorithmix
 version: !ruby/object:Gem::Version
-  version: 0.0.0.4.1
+  version: 0.0.0.5
 platform: ruby
 authors:
 - Monika Ilieva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-14 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,18 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-description: |2+
-                            Currently the gem contains:
-
-                            1. Stack
-
-                            2. Queue
-
-                            3. Deque
-
-                            4. Binary heap
-
-
+description: "                          The gem contains various implementations of
+  known and uknown data structures and algorithms. \n                          /Currently
+  the gem contains: #stack, #queue, #deque, #binary_heap, #priority_queue/\n"
 email:
 - "*@*.*"
 executables: []
@@ -97,6 +88,7 @@ files:
 - bin/setup
 - lib/algorithmix.rb
 - lib/algorithmix/data_structure/generic/deque.rb
+- lib/algorithmix/data_structure/generic/priority_queue.rb
 - lib/algorithmix/data_structure/generic/queue.rb
 - lib/algorithmix/data_structure/generic/stack.rb
 - lib/algorithmix/data_structure/heap/binary_heap.rb