concurrent-ruby 0.9.2 → 1.0.0.pre1

data/lib/concurrent/collection/map/mri_map_backend.rb

@@ -0,0 +1,66 @@
+require 'thread'
+require 'concurrent/collection/map/non_concurrent_map_backend'
+
+module Concurrent
+
+  # @!visibility private
+  module Collection
+
+    # @!visibility private
+    class MriMapBackend < NonConcurrentMapBackend
+
+      def initialize(options = nil)
+        super(options)
+        @write_lock = Mutex.new
+      end
+
+      def []=(key, value)
+        @write_lock.synchronize { super }
+      end
+
+      def compute_if_absent(key)
+        if stored_value = _get(key) # fast non-blocking path for the most likely case
+          stored_value
+        else
+          @write_lock.synchronize { super }
+        end
+      end
+
+      def compute_if_present(key)
+        @write_lock.synchronize { super }
+      end
+
+      def compute(key)
+        @write_lock.synchronize { super }
+      end
+
+      def merge_pair(key, value)
+        @write_lock.synchronize { super }
+      end
+
+      def replace_pair(key, old_value, new_value)
+        @write_lock.synchronize { super }
+      end
+
+      def replace_if_exists(key, new_value)
+        @write_lock.synchronize { super }
+      end
+
+      def get_and_set(key, value)
+        @write_lock.synchronize { super }
+      end
+
+      def delete(key)
+        @write_lock.synchronize { super }
+      end
+
+      def delete_pair(key, value)
+        @write_lock.synchronize { super }
+      end
+
+      def clear
+        @write_lock.synchronize { super }
+      end
+    end
+  end
+end

data/lib/concurrent/collection/map/non_concurrent_map_backend.rb

@@ -0,0 +1,142 @@
+module Concurrent
+
+  # @!visibility private
+  module Collection
+
+    # @!visibility private
+    class NonConcurrentMapBackend
+
+      # WARNING: all public methods of the class must operate on the @backend
+      # directly without calling each other. This is important because of the
+      # SynchronizedMapBackend which uses a non-reentrant mutex for perfomance
+      # reasons.
+      def initialize(options = nil)
+        @backend = {}
+      end
+
+      def [](key)
+        @backend[key]
+      end
+
+      def []=(key, value)
+        @backend[key] = value
+      end
+
+      def compute_if_absent(key)
+        if NULL != (stored_value = @backend.fetch(key, NULL))
+          stored_value
+        else
+          @backend[key] = yield
+        end
+      end
+
+      def replace_pair(key, old_value, new_value)
+        if pair?(key, old_value)
+          @backend[key] = new_value
+          true
+        else
+          false
+        end
+      end
+
+      def replace_if_exists(key, new_value)
+        if NULL != (stored_value = @backend.fetch(key, NULL))
+          @backend[key] = new_value
+          stored_value
+        end
+      end
+
+      def compute_if_present(key)
+        if NULL != (stored_value = @backend.fetch(key, NULL))
+          store_computed_value(key, yield(stored_value))
+        end
+      end
+
+      def compute(key)
+        store_computed_value(key, yield(@backend[key]))
+      end
+
+      def merge_pair(key, value)
+        if NULL == (stored_value = @backend.fetch(key, NULL))
+          @backend[key] = value
+        else
+          store_computed_value(key, yield(stored_value))
+        end
+      end
+
+      def get_and_set(key, value)
+        stored_value = @backend[key]
+        @backend[key] = value
+        stored_value
+      end
+
+      def key?(key)
+        @backend.key?(key)
+      end
+
+      def value?(value)
+        @backend.value?(value)
+      end
+
+      def delete(key)
+        @backend.delete(key)
+      end
+
+      def delete_pair(key, value)
+        if pair?(key, value)
+          @backend.delete(key)
+          true
+        else
+          false
+        end
+      end
+
+      def clear
+        @backend.clear
+        self
+      end
+
+      def each_pair
+        dupped_backend.each_pair do |k, v|
+          yield k, v
+        end
+        self
+      end
+
+      def size
+        @backend.size
+      end
+
+      def get_or_default(key, default_value)
+        @backend.fetch(key, default_value)
+      end
+
+      alias_method :_get, :[]
+      alias_method :_set, :[]=
+      private :_get, :_set
+      private
+      def initialize_copy(other)
+        super
+        @backend = {}
+        self
+      end
+
+      def dupped_backend
+        @backend.dup
+      end
+
+      def pair?(key, expected_value)
+        NULL != (stored_value = @backend.fetch(key, NULL)) && expected_value.equal?(stored_value)
+      end
+
+      def store_computed_value(key, new_value)
+        if new_value.nil?
+          @backend.delete(key)
+          nil
+        else
+          @backend[key] = new_value
+        end
+      end
+    end
+  end
+end

data/lib/concurrent/collection/map/synchronized_map_backend.rb

@@ -0,0 +1,86 @@
+require 'concurrent/collection/map/non_concurrent_map_backend'
+
+module Concurrent
+
+  # @!visibility private
+  module Collection
+
+    # @!visibility private
+    class SynchronizedMapBackend < NonConcurrentMapBackend
+
+      require 'mutex_m'
+      include Mutex_m
+      # WARNING: Mutex_m is a non-reentrant lock, so the synchronized methods are
+      # not allowed to call each other.
+
+      def [](key)
+        synchronize { super }
+      end
+
+      def []=(key, value)
+        synchronize { super }
+      end
+
+      def compute_if_absent(key)
+        synchronize { super }
+      end
+
+      def compute_if_present(key)
+        synchronize { super }
+      end
+
+      def compute(key)
+        synchronize { super }
+      end
+
+      def merge_pair(key, value)
+        synchronize { super }
+      end
+
+      def replace_pair(key, old_value, new_value)
+        synchronize { super }
+      end
+
+      def replace_if_exists(key, new_value)
+        synchronize { super }
+      end
+
+      def get_and_set(key, value)
+        synchronize { super }
+      end
+
+      def key?(key)
+        synchronize { super }
+      end
+
+      def value?(value)
+        synchronize { super }
+      end
+
+      def delete(key)
+        synchronize { super }
+      end
+
+      def delete_pair(key, value)
+        synchronize { super }
+      end
+
+      def clear
+        synchronize { super }
+      end
+
+      def size
+        synchronize { super }
+      end
+
+      def get_or_default(key, default_value)
+        synchronize { super }
+      end
+
+      private
+      def dupped_backend
+        synchronize { super }
+      end
+    end
+  end
+end

data/lib/concurrent/collection/non_concurrent_priority_queue.rb

@@ -0,0 +1,143 @@
+require 'concurrent/collection/java_non_concurrent_priority_queue'
+require 'concurrent/collection/ruby_non_concurrent_priority_queue'
+require 'concurrent/utility/engine'
+
+module Concurrent
+  module Collection
+
+    # @!visibility private
+    # @!macro internal_implementation_note
+    NonConcurrentPriorityQueueImplementation = case
+                                               when Concurrent.on_jruby?
+                                                 JavaNonConcurrentPriorityQueue
+                                               else
+                                                 RubyNonConcurrentPriorityQueue
+                                               end
+    private_constant :NonConcurrentPriorityQueueImplementation
+
+    # @!macro [attach] priority_queue
+    #
+    #   A queue collection in which the elements are sorted based on their
+    #   comparison (spaceship) operator `<=>`. Items are added to the queue
+    #   at a position relative to their priority. On removal the element
+    #   with the "highest" priority is removed. By default the sort order is
+    #   from highest to lowest, but a lowest-to-highest sort order can be
+    #   set on construction.
+    #
+    #   The API is based on the `Queue` class from the Ruby standard library.
+    #
+    #   The pure Ruby implementation, `RubyNonConcurrentPriorityQueue` uses a heap algorithm
+    #   stored in an array. The algorithm is based on the work of Robert Sedgewick
+    #   and Kevin Wayne.
+    #
+    #   The JRuby native implementation is a thin wrapper around the standard
+    #   library `java.util.NonConcurrentPriorityQueue`.
+    #
+    #   When running under JRuby the class `NonConcurrentPriorityQueue` extends `JavaNonConcurrentPriorityQueue`.
+    #   When running under all other interpreters it extends `RubyNonConcurrentPriorityQueue`.
+    #
+    #   @note This implementation is *not* thread safe.
+    #
+    #   @see http://en.wikipedia.org/wiki/Priority_queue
+    #   @see http://ruby-doc.org/stdlib-2.0.0/libdoc/thread/rdoc/Queue.html
+    #
+    #   @see http://algs4.cs.princeton.edu/24pq/index.php#2.6
+    #   @see http://algs4.cs.princeton.edu/24pq/MaxPQ.java.html
+    #
+    #   @see http://docs.oracle.com/javase/7/docs/api/java/util/PriorityQueue.html
+    # 
+    # @!visibility private
+    class NonConcurrentPriorityQueue < NonConcurrentPriorityQueueImplementation
+
+      alias_method :has_priority?, :include?
+
+      alias_method :size, :length
+
+      alias_method :deq, :pop
+      alias_method :shift, :pop
+
+      alias_method :<<, :push
+      alias_method :enq, :push
+
+      # @!method initialize(opts = {})
+      #   @!macro [new] priority_queue_method_initialize
+      #
+      #     Create a new priority queue with no items.
+      #    
+      #     @param [Hash] opts the options for creating the queue
+      #     @option opts [Symbol] :order (:max) dictates the order in which items are
+      #       stored: from highest to lowest when `:max` or `:high`; from lowest to
+      #       highest when `:min` or `:low`
+
+      # @!method clear
+      #   @!macro [new] priority_queue_method_clear
+      #
+      #     Removes all of the elements from this priority queue.
+
+      # @!method delete(item)
+      #   @!macro [new] priority_queue_method_delete
+      #
+      #     Deletes all items from `self` that are equal to `item`.
+      #  
+      #     @param [Object] item the item to be removed from the queue
+      #     @return [Object] true if the item is found else false
+
+      # @!method empty?
+      #   @!macro [new] priority_queue_method_empty
+      #  
+      #     Returns `true` if `self` contains no elements.
+      #  
+      #     @return [Boolean] true if there are no items in the queue else false
+
+      # @!method include?(item)
+      #   @!macro [new] priority_queue_method_include
+      #
+      #     Returns `true` if the given item is present in `self` (that is, if any
+      #     element == `item`), otherwise returns false.
+      #  
+      #     @param [Object] item the item to search for
+      #  
+      #     @return [Boolean] true if the item is found else false
+
+      # @!method length
+      #   @!macro [new] priority_queue_method_length
+      #    
+      #     The current length of the queue.
+      #    
+      #     @return [Fixnum] the number of items in the queue
+
+      # @!method peek
+      #   @!macro [new] priority_queue_method_peek
+      #    
+      #     Retrieves, but does not remove, the head of this queue, or returns `nil`
+      #     if this queue is empty.
+      #     
+      #     @return [Object] the head of the queue or `nil` when empty
+
+      # @!method pop
+      #   @!macro [new] priority_queue_method_pop
+      #    
+      #     Retrieves and removes the head of this queue, or returns `nil` if this
+      #     queue is empty.
+      #     
+      #     @return [Object] the head of the queue or `nil` when empty
+
+      # @!method push(item)
+      #   @!macro [new] priority_queue_method_push
+      #    
+      #     Inserts the specified element into this priority queue.
+      #    
+      #     @param [Object] item the item to insert onto the queue
+
+      # @!method self.from_list(list, opts = {})
+      #   @!macro [new] priority_queue_method_from_list
+      #    
+      #     Create a new priority queue from the given list.
+      #    
+      #     @param [Enumerable] list the list to build the queue from
+      #     @param [Hash] opts the options for creating the queue
+      #    
+      #     @return [NonConcurrentPriorityQueue] the newly created and populated queue
+    end
+  end
+end

data/lib/concurrent/collection/ruby_non_concurrent_priority_queue.rb

@@ -0,0 +1,150 @@
+module Concurrent
+  module Collection
+
+    # @!macro priority_queue
+    # 
+    # @!visibility private
+    # @!macro internal_implementation_note
+    class RubyNonConcurrentPriorityQueue
+
+      # @!macro priority_queue_method_initialize
+      def initialize(opts = {})
+        order = opts.fetch(:order, :max)
+        @comparator = [:min, :low].include?(order) ? -1 : 1
+        clear
+      end
+
+      # @!macro priority_queue_method_clear
+      def clear
+        @queue = [nil]
+        @length = 0
+        true
+      end
+
+      # @!macro priority_queue_method_delete
+      def delete(item)
+        return false if empty?
+        original_length = @length
+        k = 1
+        while k <= @length
+          if @queue[k] == item
+            swap(k, @length)
+            @length -= 1
+            sink(k)
+            @queue.pop
+          else
+            k += 1
+          end
+        end
+        @length != original_length
+      end
+
+      # @!macro priority_queue_method_empty
+      def empty?
+        size == 0
+      end
+
+      # @!macro priority_queue_method_include
+      def include?(item)
+        @queue.include?(item)
+      end
+      alias_method :has_priority?, :include?
+
+      # @!macro priority_queue_method_length
+      def length
+        @length
+      end
+      alias_method :size, :length
+
+      # @!macro priority_queue_method_peek
+      def peek
+        empty? ? nil : @queue[1]
+      end
+
+      # @!macro priority_queue_method_pop
+      def pop
+        return nil if empty?
+        max = @queue[1]
+        swap(1, @length)
+        @length -= 1
+        sink(1)
+        @queue.pop
+        max
+      end
+      alias_method :deq, :pop
+      alias_method :shift, :pop
+
+      # @!macro priority_queue_method_push
+      def push(item)
+        raise ArgumentError.new('cannot enqueue nil') if item.nil?
+        @length += 1
+        @queue << item
+        swim(@length)
+        true
+      end
+      alias_method :<<, :push
+      alias_method :enq, :push
+
+      #   @!macro priority_queue_method_from_list
+      def self.from_list(list, opts = {})
+        queue = new(opts)
+        list.each{|item| queue << item }
+        queue
+      end
+
+      private
+
+      # Exchange the values at the given indexes within the internal array.
+      # 
+      # @param [Integer] x the first index to swap
+      # @param [Integer] y the second index to swap
+      # 
+      # @!visibility private
+      def swap(x, y)
+        temp = @queue[x]
+        @queue[x] = @queue[y]
+        @queue[y] = temp
+      end
+
+      # Are the items at the given indexes ordered based on the priority
+      # order specified at construction?
+      #
+      # @param [Integer] x the first index from which to retrieve a comparable value
+      # @param [Integer] y the second index from which to retrieve a comparable value
+      #
+      # @return [Boolean] true if the two elements are in the correct priority order
+      #   else false
+      # 
+      # @!visibility private
+      def ordered?(x, y)
+        (@queue[x] <=> @queue[y]) == @comparator
+      end
+
+      # Percolate down to maintain heap invariant.
+      # 
+      # @param [Integer] k the index at which to start the percolation
+      # 
+      # @!visibility private
+      def sink(k)
+        while (j = (2 * k)) <= @length do
+          j += 1 if j < @length && ! ordered?(j, j+1)
+          break if ordered?(k, j)
+          swap(k, j)
+          k = j
+        end
+      end
+
+      # Percolate up to maintain heap invariant.
+      # 
+      # @param [Integer] k the index at which to start the percolation
+      # 
+      # @!visibility private
+      def swim(k)
+        while k > 1 && ! ordered?(k/2, k) do
+          swap(k, k/2)
+          k = k/2
+        end
+      end
+    end
+  end
+end