eldritch 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cbab97dd7492c7c19829d608f555e6cd1660901
-  data.tar.gz: a05f7a551bc3c73736f86846b2fced0f51000e67
+  metadata.gz: 126e27cd07d65470ca6636e9fdee32863141f810
+  data.tar.gz: df821431679824457c23f5970d779b907d9371c6
 SHA512:
-  metadata.gz: 679b8be6668f63dbd2b688e94b64f30f58ec858d0d6179ddc06ccc3e434ddd4973214bf7af41846849d970888494d2c8788d07ae11e859f46949416ebedb1351
-  data.tar.gz: 4478f50cf4c09996245b2407007287a03368731818bdaeb466e7cd6ee6602ff321e6fc7083023f622deee32fe521e6d3a16d766809455f31fda2eef8afd7f452
+  metadata.gz: 4f8fe3201d12712f927af4e21a8939feaaf4221e293b43d3581a55376ead5ad364329cc7aba43ab4d8896338777e386630ea1b6f40309469f48d37b442f88e87
+  data.tar.gz: 2130979b69b7099a626b06c9e88a9d3640f21c0bc4cdfde89b1d3b0b98f3230677a058b6d5a01dd522a2d5f772cbce7c27ee3c0d8a53c2684e91dfc393a6e6db

data/README.md

@@ -99,6 +99,28 @@ together do |group|
 end
 ```
 
+A note on GIL
+-------------
+
+MRI has this nasty little feature called a _GIL_ or _Global Interpreter Lock_. This lock makes it so that only one
+thread can run at a time. Let's say that you have 4 cores, running threaded code on MRI will only make use of 1 core.
+Sometimes, you might not gain a speed boost if you make code parallel. This could the case even if theory says otherwise.
+
+Not all ruby implementations use a _GIL_. For example, jRuby does not use a _GIL_. The problem with using jRuby, is that
+this gem requires ruby >= 2.1.0 and jRuby only supports up to 1.9.3 (as of writing this).
+
+You will probably see a speed boost if your code does a lot of IO or anything that's blocking. In that case running on a
+single core is not that much of a hindrance, because most of the threads will be blocked and your code should run more
+often.
+
+Running examples
+----------------
+
+If you installed eldritch with gem, you can just run the examples directly. If you are running them against a clone of
+this repository you need to add `lib/` to the include path.
+
+    $ ruby -Ilib examples/the_example.rb
+
 Installation
 ------------
 

data/examples/jacobi.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+require 'eldritch'
+
+def print_matrix(matrix)
+  matrix.each do |line|
+    formatted = line.map { |i| '% 10.5f' % i }
+    puts "[ #{formatted.join(', ')} ]"
+  end
+end
+
+def create_matrix(n, m)
+  Array.new(n+2).map{[-1] * (m+2)}
+end
+
+matrix = [
+  [-1, -1, -1, -1, -1, -1],
+  [-1,  1,  2,  3,  4, -1],
+  [-1,  1,  2,  3,  4, -1],
+  [-1,  1,  2,  3,  4, -1],
+  [-1,  1,  2,  3,  4, -1],
+  [-1, -1, -1, -1, -1, -1]
+]
+
+epsilon = 0.001
+
+print_matrix matrix
+puts
+
+height = matrix.length - 2
+width = matrix.first.length - 2
+
+iteration = 1
+begin
+  next_matrix = create_matrix(height, width)
+
+  together do
+    (1..height).each do |r|
+      async do
+        (1..width).each do |c|
+          neighbors = [c-1, c+1].product([r-1, r+1]).map{|i, j| matrix[i][j]}
+          next_matrix[r][c] = neighbors.reduce(:+) / 4.0
+        end
+      end
+    end
+  end
+
+  diff = matrix.flatten.zip(next_matrix.flatten).map{|i, j| (i - j).abs}.max
+
+  matrix = next_matrix
+
+  print_matrix matrix
+  puts "iteration = #{iteration}; diff = #{diff}"
+  puts
+
+  iteration += 1
+end while diff > epsilon

data/examples/parallel_sort.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require 'eldritch'
+
+def merge(a, b)
+  merged = []
+
+  until b.empty? || a.empty? do
+    if a.first <= b.first
+      merged += a.take_while { |i| (i <= b.first) }
+      a = a.drop_while { |i| i <= b.first }
+    else
+      merged += b.take_while { |i| i <= a.first }
+      b = b.drop_while { |i| i <= a.first }
+    end
+  end
+  merged + (a.empty? ? b : a)
+end
+
+def parallel_merge_sort(array)
+  return array if array.size <= 1
+
+  mid = (array.length / 2).floor
+
+  first = async { parallel_merge_sort(array.slice(0, mid)) }
+  second = parallel_merge_sort(array.slice(mid, array.length - mid))
+
+  merge(second, first.value)
+end
+
+nums = (1..25).to_a.shuffle
+
+puts "values: #{nums.join(', ')}"
+puts 'sorting...'
+sorted = parallel_merge_sort(nums)
+puts "values: #{sorted.join(', ')}"

data/lib/eldritch/task.rb

@@ -33,6 +33,7 @@ module Eldritch
     # Waits for the task to complete
     def wait
       @thread.join
+      @thread.task = nil
     end
 
     # The return value of the task

data/lib/eldritch/version.rb

@@ -1,3 +1,3 @@
 module Eldritch
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/task_spec.rb

@@ -46,6 +46,13 @@ describe Eldritch::Task do
       expect(task.thread).to receive(:join)
       task.wait
     end
+
+    it 'should set the thread task to nil' do
+      task.start
+
+      expect(thread).to receive(:task=).with(nil)
+      task.wait
+    end
   end
 
   describe '#value' do
@@ -56,6 +63,13 @@ describe Eldritch::Task do
       task.value
     end
 
+    it 'should set the thread task to nil' do
+      task.start
+
+      expect(thread).to receive(:task=).with(nil)
+      task.value
+    end
+
     it 'should return the value' do
       task.value = 42
       task.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eldritch
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Boris Bera
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,9 @@ files:
 - eldritch.gemspec
 - examples/async_block.rb
 - examples/async_method_with_class.rb
+- examples/jacobi.rb
 - examples/matrix_multiplication.rb
+- examples/parallel_sort.rb
 - examples/password_cracker.rb
 - examples/simple_async_method.rb
 - examples/together_simple.rb