zipfian 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zipfian.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :test do
+  watch(%r{^test/test_.+\.rb$})
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Junegunn Choi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Zipfian
+
+[Zipfian distribution](http://en.wikipedia.org/wiki/Zipf's_law) implementation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zipfian'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zipfian
+
+## Usage
+
+```ruby
+# 1000: Number of elements
+#  1.0: Exponent
+z = Zipfian.new 1000, 1.0
+
+(1..1000).each do |i|
+  puts [z.pmf(i), z.cdf(i)].join ' - '
+end
+
+puts z.sample
+```
+
+## Disclaimer
+
+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.
+
+```ruby
+# A workaround of memory limitation
+z = Zipfian.new 1000000, 0.5
+
+puts z.sample * 1000 - rand(1000)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/lib/zipfian.rb

@@ -0,0 +1,66 @@
+require "zipfian/version"
+
+class Zipfian
+  def initialize n, s
+    unless n > 0 && n.is_a?(Integer)
+      raise ArgumentError.new("Number of elements must be a positive integer")
+    end
+    unless s > 0
+      raise ArgumentError.new("Exponent must be a positive number")
+    end
+
+    @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
+
+        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
+        end
+
+        v < self[c] ? c : c + 1
+      end
+    end
+  end
+
+  def inspect
+    {
+      :N => @n,
+      :s => @s
+    }.inspect
+  end
+
+  def pmf k
+    check_rank k
+    1.0 / ((k ** @s) * @h)
+  end
+
+  def cdf k
+    check_rank k
+    @cdf[k]
+  end
+
+  def sample
+    @cdf.binary_search_index rand
+  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
+end
+

data/lib/zipfian/version.rb

@@ -0,0 +1,3 @@
+class Zipfian
+  VERSION = "0.0.1"
+end

data/test/test_zipfian.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib')
+require 'zipfian'
+require 'test-unit'
+
+class TestZipfian < Test::Unit::TestCase
+  def test_init
+    assert_raise(ArgumentError) { z = Zipfian.new }
+
+    [0.9, 0, -1].each do |n|
+      assert_raise(ArgumentError) { z = Zipfian.new n, 1 }
+    end
+
+    assert_raise(ArgumentError) { z = Zipfian.new 100, 0 }
+    assert_raise(ArgumentError) { z = Zipfian.new 100, -1 }
+  end
+
+  def test_invalid_rank
+    z = Zipfian.new 1000, 0.1
+
+    [0.1, 0, 2000].each do |k|
+      assert_raise(ArgumentError) { z.pmf k }
+      assert_raise(ArgumentError) { z.cdf k }
+    end
+  end
+
+  def test_pmf_cdf
+    z = Zipfian.new 1000, 1
+
+    sum = 0
+    (1..1000).each do |i|
+      assert z.pmf(i) <= z.cdf(i)
+      assert z.pmf(i) < z.pmf(i - 1) if i > 1
+    end
+    assert_equal z.pmf(1), z.cdf(1)
+    assert_equal 1, z.cdf(1000)
+  end
+
+  def test_sample
+    z = Zipfian.new 100, 1
+
+    10000.times do |i|
+      assert (1..100).include?(z.sample)
+    end
+  end
+end

data/zipfian.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/zipfian/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Junegunn Choi"]
+  gem.email         = ["junegunn.c@gmail.com"]
+  gem.description   = %q{Zipfian distribution}
+  gem.summary       = %q{Zipfian distribution}
+  gem.homepage      = "https://github.com/junegunn/zipfian"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "zipfian"
+  gem.require_paths = ["lib"]
+  gem.version       = Zipfian::VERSION
+
+  gem.add_development_dependency 'test-unit'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-test'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: zipfian
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Junegunn Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &2153866200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153866200
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2153865760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153865760
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: &2153865340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153865340
+description: Zipfian distribution
+email:
+- junegunn.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/zipfian.rb
+- lib/zipfian/version.rb
+- test/test_zipfian.rb
+- zipfian.gemspec
+homepage: https://github.com/junegunn/zipfian
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Zipfian distribution
+test_files:
+- test/test_zipfian.rb