zipfian 0.0.2 → 0.0.3

data/README.md

@@ -34,7 +34,7 @@ puts z.sample    # Integer between 1 and 1000
 
 ```
 
-## Disclaimer
+## Initialization overhead and caching
 
 On initialization, Zipfian precalculates and stores the values of cumulative distribution function for every integer in the range.
 As the number gets bigger, it will take more time and memory.
@@ -46,6 +46,18 @@ z = Zipfian.new 1000000, 0.5
 puts z.sample * 1000 - rand(1000)
 ```
 
+To avoid repeated initialization when multiple `Zipfian` instances are used,
+you can optionally enable thread-safe caching of precalculated data at class-level
+by setting the third parameter of initializer to true.
+
+```ruby
+# Cache precalculated data
+z1 = Zipfian.new 1000000, 0.5, true
+
+# Returns immediately.
+z2 = Zipfian.new 1000000, 0.5
+```
+
 ## Contributing
 
 1. Fork it

data/lib/zipfian.rb

@@ -3,7 +3,12 @@ require "zipfian/version"
 class Zipfian
   attr_reader :n, :s
 
-  def initialize n, s
+  @@global_mutex = Mutex.new
+  @@mutexes      = {}
+  @@h            = {}
+  @@cdf          = {}
+
+  def initialize n, s, cache = false
     unless n > 0 && n.is_a?(Integer)
       raise ArgumentError.new("Number of elements must be a positive integer")
     end
@@ -14,25 +19,33 @@ class Zipfian
     @n   = n
     @s   = s
     sums = [0]
-    @h   = (1..@n).inject(0) { |sum, i| sums[i] = sum + 1.0 / (i ** @s) }
-    @cdf = (0..@n).map { |i| sums[i] / @h }
 
-    class << @cdf
-      def binary_search_index v
-        l = 0
-        r = self.length - 2
+    compute_h = lambda { (1..@n).inject(0) { |sum, i| sums[i] = sum + 1.0 / (i ** @s) } }
+    compute_cdf = lambda { (0..@n).map { |i| sums[i] / @h } }
 
-        while (c = (l + r) / 2) && l < r
-          if v < self[c]
-            r = c - 1
-          elsif v > self[c]
-            l = c + 1
-          else
-            return c
-          end
+    key = [n, s]
+    mutex = nil
+    if cache
+      @@global_mutex.synchronize do
+        mutex = @@mutexes[key] ||= Mutex.new
+      end
+      mutex.synchronize do
+        @h   = @@h[key]   ||= compute_h.call
+        @cdf = @@cdf[key] ||= compute_cdf.call
+      end
+    else
+      @@global_mutex.synchronize do
+        # Do not create mutex
+        mutex = @@mutexes[key]
+      end
+      if mutex
+        mutex.synchronize do
+          @h   = @@h[key]   || compute_h.call
+          @cdf = @@cdf[key] || compute_cdf.call
         end
-
-        v < self[c] ? c : c + 1
+      else
+        @h   = compute_h.call
+        @cdf = compute_cdf.call
       end
     end
   end
@@ -55,14 +68,40 @@ class Zipfian
   end
 
   def sample
-    @cdf.binary_search_index rand
+    binary_search_index @cdf, rand
   end
 
+  def self.cached
+    ret = []
+    @@global_mutex.synchronize do
+      @@mutexes.keys.each do |key|
+        ret << { :n => key.first, :s => key.last }
+      end
+    end
+    ret
+  end
 private
   def check_rank k
     unless k.is_a?(Integer) && k >= 1 && k <= @n
       raise ArgumentError.new("Rank must be a positive integer (max: #{@n})")
     end
   end
+
+  def binary_search_index arr, v
+    l = 0
+    r = arr.length - 2
+
+    while (c = (l + r) / 2) && l < r
+      if v < arr[c]
+        r = c - 1
+      elsif v > arr[c]
+        l = c + 1
+      else
+        return c
+      end
+    end
+
+    v < arr[c] ? c : c + 1
+  end
 end
 

data/lib/zipfian/version.rb

@@ -1,3 +1,3 @@
 class Zipfian
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/test_zipfian.rb

@@ -4,7 +4,10 @@ require 'rubygems'
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib')
 require 'zipfian'
 require 'test-unit'
+require 'parallelize'
+require 'benchmark'
 
+# TODO: naive tests
 class TestZipfian < Test::Unit::TestCase
   def test_init
     assert_raise(ArgumentError) { z = Zipfian.new }
@@ -44,10 +47,57 @@ class TestZipfian < Test::Unit::TestCase
   end
 
   def test_sample
-    z = Zipfian.new 100, 1
+    # cached
+    3.times do
+      z = Zipfian.new 100000, 1, true
 
-    10000.times do |i|
-      assert (1..100).include?(z.sample)
+      10000.times do |i|
+        assert (1..100000).include?(z.sample)
+      end
+    end
+  end
+
+  def test_cached_initialization
+    puts Benchmark.measure { Zipfian.new 10 ** 6, 0.99 }
+    p Zipfian.cached
+    puts Benchmark.measure { Zipfian.new 10 ** 6, 0.99, true }
+    p Zipfian.cached
+    puts Benchmark.measure { Zipfian.new 10 ** 6, 0.99 }
+    p Zipfian.cached
+
+    puts Benchmark.measure { Zipfian.new 10 ** 6, 0.88 }
+    p Zipfian.cached
+    puts Benchmark.measure { Zipfian.new 10 ** 6, 0.88 }
+    p Zipfian.cached
+  end
+
+  def test_multi_threaded
+    m = Mutex.new
+    msgs = []
+    32.times.peach(32) do |idx|
+      m.synchronize { msgs << :s }
+      z = Zipfian.new(10 ** 6, 0.12345, true)
+      m.synchronize { msgs << :e }
+    end
+    puts msgs.join
+  end
+
+  def test_dist
+    [0.1, 0.5, 0.75, 1].each do |s|
+      puts "s = #{s}"
+      max = 10 ** 6
+      cnt = 10 ** 4
+      hst = 20
+      col = 60
+      z = Zipfian.new max, s
+      histogram = Array.new(hst) { 0 }
+      cnt.times do
+        histogram[(z.sample - 1) * hst / max] += 1
+      end
+
+      r = col.to_f / histogram.max
+      puts histogram.map { |e| '*' * (e * r).to_i + " : #{e}" }
+      puts
     end
   end
 end

data/test/test_zipfian_perf.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib')
+require 'zipfian'
+require 'test-unit'
+require 'benchmark'
+require 'parallelize'
+
+class TestZipfian < Test::Unit::TestCase
+  def test_zipfian_performance
+    cnt = 100000
+
+    [8, 4, 2, 1].each do |thr|
+      puts "# of threads: #{thr}"
+      zps = Array.new(thr)
+      (2..6).each do |pow|
+        max = 10 ** pow
+
+        puts "Range: 1 ~ #{max}"
+        print "Initialize (sec): "
+        puts Benchmark.measure {
+          thr.times.peach(thr) do |idx|
+            zps[idx] = Zipfian.new max, 1, true
+          end
+        }.real
+
+        print "Sample throughput (op/sec): "
+        puts cnt / Benchmark.measure {
+          thr.times.peach(thr) do |idx|
+            cnt.times do |i|
+              zps[idx].sample
+            end
+          end
+        }.real
+        puts
+      end
+      puts
+    end
+  end
+end

data/zipfian.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'test-unit'
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'guard-test'
+  gem.add_development_dependency 'parallelize'
 end

metadata

@@ -1,74 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: zipfian
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Junegunn Choi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: test-unit
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: guard
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: guard-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallelize
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Zipfian distribution
-email: 
+email:
 - junegunn.c@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Guardfile
@@ -78,39 +91,32 @@ files:
 - lib/zipfian.rb
 - lib/zipfian/version.rb
 - test/test_zipfian.rb
+- test/test_zipfian_perf.rb
 - zipfian.gemspec
 homepage: https://github.com/junegunn/zipfian
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Zipfian distribution
-test_files: 
+test_files:
 - test/test_zipfian.rb
+- test/test_zipfian_perf.rb