unified-queues 0.1.0

data/lib/unified-queues/single/driver/depq.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "unified-queues/single/driver"
+
+##
+# Base +Unified Queues+ module.
+#
+
+module UnifiedQueues
+  
+    ##
+    # Universal single queue interface.
+    #
+    
+    class Single
+      
+        ##
+        # Abstract single driver class.
+        # @abstract
+        #
+        
+        class Driver
+          
+            ##
+            # Implicit heap queue driver. Uses the +Depq+ class from +depq+ gem
+            # for queueing. Priority is supported.
+            #
+            
+            class DepqDriver < Driver
+                
+                ##
+                # Pushes the value into the queue. Priority is supported.
+                #
+                # @param [Object] value  value for push
+                # @param [Object] key  key for priority queues
+                #
+                
+                def push(value, key = value)
+                    @native.insert(value, key)
+                end
+                
+                ##
+                # Pops value out of the queue. Note, value with minimal 
+                # priority will be popped out. Blocking isn'ŧ supported.
+                #
+                # @param [Boolean|Integer] blocking  +true+ or timeout if it should block, +false+ otherwise
+                # @return [Object] queued value
+                #
+                
+                def pop(blocking = false)
+                    @native.delete_min
+                end
+                
+                ##
+                # Indicates queue is empty.
+                # @param [Boolean] +true+ if it's, +false+ otherwise
+                #
+                
+                def empty?
+                    @native.empty?
+                end
+                
+                ##
+                # Clears the queue.
+                #
+              
+                def clear!
+                    @native.clear
+                end
+                
+                ##
+                # Returns length of the queue.
+                # @return [Integer]
+                #
+                
+                def length
+                    @native.size
+                end
+                
+                ##
+                # Returs type of the queue.
+                # @return [:linear]
+                #
+                
+                def type
+                    :linear
+                end
+                
+            end
+        end
+        
+    end
+    
+end

data/lib/unified-queues/single/driver/evented-queue.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "unified-queues/single/driver"
+
+##
+# Base +Unified Queues+ module.
+#
+
+module UnifiedQueues
+  
+    ##
+    # Universal single queue interface.
+    #
+    
+    class Single
+      
+        ##
+        # Abstract single driver class.
+        # @abstract
+        #
+        
+        class Driver
+          
+            ##
+            # EventedQueue queue driver. Uses the +EventedQueue+ class
+            # from the +evented-queue+ gem. Priority is supported 
+            # depending to arguments.
+            #
+            
+            class EventedQueueDriver < Driver
+                
+                ##
+                # Pushes the value into the queue. Priority is supported 
+                # depending to arguments.
+                #
+                # @param [Object] value  value for push
+                # @param [Object] key  key for priority queues
+                #
+                
+                def push(value, key = value, &block)
+                    @native.push(value, key, &block)
+                end
+                
+                ##
+                # Pops value out of the queue.
+                #
+                # @param [Boolean|Integer] blocking  +true+ or timeout if it should block, +false+ otherwise
+                # @param [Object] queue value
+                #
+                
+                def pop(blocking = false, &block)
+                    @native.pop(&block)
+                end
+                
+                ##
+                # Indicates queue is empty.
+                # @param [Boolean] +true+ if it's, +false+ otherwise
+                #
+                
+                def empty?(&block)
+                    @native.empty?(&block)
+                end
+                
+                ##
+                # Clears the queue.
+                #
+              
+                def clear!(&block)
+                    @native.clear(&block)
+                end
+                
+                ##
+                # Returns length of the queue.
+                # @return [Integer]
+                #
+                
+                def length(&block)
+                    @native.length(&block)
+                end
+                
+                ##
+                # Returs type of the queue.
+                # @return [:linear]
+                #
+                
+                def type
+                    :linear
+                end
+                
+            end
+        end
+        
+    end
+    
+end

data/lib/unified-queues/single/driver/priority_queue.rb

@@ -0,0 +1,221 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "unified-queues/single/driver"
+require "abstract"
+
+##
+# Base +Unified Queues+ module.
+#
+
+module UnifiedQueues
+  
+    ##
+    # Universal single queue interface.
+    #
+    
+    class Single
+      
+        ##
+        # Abstract single driver class.
+        # @abstract
+        #
+        
+        class Driver
+          
+            ##
+            # Fibonacci heap queue driver. Uses the +CPriorityQueue+ class
+            # from +PriorityQueue+ gem. Priority is supported.
+            #
+            # It isn't implement equivalent of the +#clear+ method, so
+            # it falls backs to naive "popping" style clearing.
+            #
+            
+            class CPriorityQueueDriver < Driver
+                
+                ##
+                # Pushes the value into the queue. Priority is supported.
+                #
+                # @param [Object] value  value for push
+                # @param [Object] key  key for priority queues
+                #
+                
+                def push(value, key = value)
+                    key = (key.kind_of? Integer) ? key : 0
+                    @native.push(value, key)
+                end
+                
+                ##
+                # Pops value out of the queue. Note, value with minimal 
+                # priority will be popped out. Blocking isn'ŧ supported.
+                #
+                # @param [Boolean|Integer] blocking  +true+ or timeout if it should block, +false+ otherwise
+                # @return [Object] queued value
+                #
+                
+                def pop(blocking = false)
+                    @native.delete_min_return_key
+                end
+                
+                ##
+                # Indicates queue is empty.
+                # @param [Boolean] +true+ if it's, +false+ otherwise
+                #
+                
+                def empty?
+                    @native.empty?
+                end
+                
+                ##
+                # Returns length of the queue.
+                #
+                # @return [Integer]
+                #
+                
+                def length
+                    @native.length
+                end
+                
+                ##
+                # Returs type of the queue.
+                # @return [:linear]
+                #
+                
+                def type
+                    :linear
+                end
+                
+            end
+
+            ##
+            # Minimal priority queue driver. Uses the +PoorPriorityQueue+ class
+            # from +PriorityQueue+ gem. Priority is supported.
+            #
+            # It isn't implement equivalent of the +#clear+ method, so
+            # it falls backs to naive "popping" style clearing.
+            #
+            # Also note, it's very minimalistic implementation, so both calls
+            # to {PoorPriorityQueue#length} and {PoorPriorityQueue#empty?}
+            # will throw an exception.
+            #
+            
+            class PoorPriorityQueueDriver < Driver
+                
+                ##
+                # Pushes the value into the queue. Priority is supported.
+                #
+                # @param [Object] value  value for push
+                # @param [Object] key  key for priority queues
+                #
+                
+                def push(value, key = value)
+                    @native.push(value, key)
+                end
+                
+                ##
+                # Pops value out of the queue. Note, value with minimal 
+                # priority will be popped out. Blocking isn't supported.
+                #
+                # @param [Boolean|Integer] blocking  +true+ or timeout if it should block, +false+ otherwise
+                # @return [Object] queued value
+                #
+                
+                def pop(blocking = false)
+                    @native.delete_min_return_key
+                end
+                
+                ##
+                # Indicates queue is empty. Note, it isn't implemented
+                # in this implementation.
+                #
+                # @param [Boolean] +true+ if it's, +false+ otherwise
+                #
+                
+                def empty?
+                    not_implemented
+                end
+                
+                ##
+                # Returns length of the queue. Note, it isn't implemented
+                # in this implementation.
+                #
+                # @return [Integer]
+                #
+                
+                def length
+                    not_implemented
+                end
+                
+            end
+
+            ##
+            # Ruby fibonacci heap priority queue driver. Uses the +RubyPriorityQueue+ class
+            # from +PriorityQueue+ gem. Priority is supported.
+            #
+            # It isn't implement equivalent of the +#clear+ method, so
+            # it falls backs to naive "popping" style clearing.
+            #
+            
+            class RubyPriorityQueueDriver < Driver
+                
+                ##
+                # Pushes the value into the queue. Priority is supported.
+                #
+                # @param [Object] value  value for push
+                # @param [Object] key  key for priority queues
+                #
+                
+                def push(value, key = value)
+                    @native.push(value, key)
+                end
+                
+                ##
+                # Pops value out of the queue. Note, value with minimal 
+                # priority will be popped out. Blocking isn't supported.
+                #
+                # @param [Boolean|Integer] blocking  +true+ or timeout if it should block, +false+ otherwise
+                # @return [Object] queued value
+                #
+                
+                def pop(blocking = false)
+                    @native.delete_min_return_key
+                end
+                
+                ##
+                # Indicates queue is empty. Note, it isn't implemented
+                # in this implementation.
+                #
+                # @param [Boolean] +true+ if it's, +false+ otherwise
+                #
+                
+                def empty?
+                    @native.empty?
+                end
+                
+                ##
+                # Returns length of the queue. Note, it isn't implemented
+                # in this implementation.
+                #
+                # @return [Integer]
+                #
+                
+                def length
+                    @native.length
+                end
+                
+                ##
+                # Returs type of the queue.
+                # @return [:linear]
+                #
+                
+                def type
+                    :linear
+                end
+                
+            end
+            
+        end
+        
+    end
+    
+end

data/lib/unified-queues/single/driver/queue.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "unified-queues/single/driver"
+require "hash-utils"
+
+##
+# Base +Unified Queues+ module.
+#
+
+module UnifiedQueues
+  
+    ##
+    # Universal single queue interface.
+    #
+    
+    class Single
+      
+        ##
+        # Abstract single driver class.
+        # @abstract
+        #
+        
+        class Driver
+          
+            ##
+            # Queue queue driver. Uses standard library +Queue+ class
+            # for thread synchronized queueing. Priority isn't supported.
+            #
+            
+            class QueueDriver < Driver
+                
+                ##
+                # Pushes the value into the queue. Priority isn't supported.
+                #
+                # @param [Object] value  value for push
+                # @param [Object] key  key for priority queues
+                #
+                
+                def push(value, key = value)
+                    @native.push(value)
+                end
+                
+                ##
+                # Pops value out of the queue.
+                #
+                # @param [Boolean|Integer] blocking  +true+ or timeout if it should block, +false+ otherwise
+                # @param [Object] queue value
+                #
+                
+                def pop(blocking = false)
+                    if blocking.boolean?
+                        timeout = !blocking
+                    else
+                        timeout = blocking                        
+                    end
+
+                    begin
+                        @native.pop(blocking)
+                    rescue ThreadError
+                        nil
+                    end
+                end
+                
+                ##
+                # Indicates queue is empty.
+                # @param [Boolean] +true+ if it's, +false+ otherwise
+                #
+                
+                def empty?
+                    @native.empty?
+                end
+                
+                ##
+                # Clears the queue.
+                #
+              
+                def clear!
+                    @native.clear
+                end
+                
+                ##
+                # Returns length of the queue.
+                # @return [Integer]
+                #
+                
+                def length
+                    @native.length
+                end
+                
+                ##
+                # Returs type of the queue.
+                # @return [:linear]
+                #
+                
+                def type
+                    :linear
+                end
+                
+            end
+        end
+        
+    end
+    
+end