weightedpicker 0.1.1 → 0.1.2

data/CHANGES

@@ -1,6 +1,12 @@
 = weightedpicker changelog
 
-== Master (for 0.1.1)
+== Master (for 0.1.3)
+
+== Version 0.1.2 [2014-09-01] released
+  Add WeightedPicker::total_weight.
+  Change test method from rspec to test-unit
+
+== Version 0.1.1 [2013-04-18] released
   Add bin/weight to deal with weight yaml.
   Add WeightedPicker::names.
   Add WeightedPicker::dump_histgram.

data/Gemfile

@@ -6,10 +6,11 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.13.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.3.4"
-  gem "jeweler", "~> 1.8.3"
+  #gem "rspec", "~> 2.13.0"
+  gem "test-unit", "~> 3.0.1"
+  gem "rdoc", "~> 4.0.1"
+  gem "bundler", "~> 1.7.2"
+  gem "jeweler", "~> 2.0.1"
   gem "simplecov", ">= 0"
   #gem "psych", ">= 0"
 end

data/Rakefile

@@ -3,50 +3,58 @@
 require 'rubygems'
 require 'bundler'
 begin
-  Bundler.setup(:default, :development)
+    Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
+    $stderr.puts e.message
+    $stderr.puts "Run `bundle install` to install missing gems"
+    exit e.status_code
 end
 require 'rake'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "weightedpicker"
-  gem.homepage = "http://github.com/ippei94da/weightedpicker"
-  gem.license = "MIT"
-  gem.summary = %Q{Picking one item from list at the rate of its weight.}
-  gem.description = %Q{This library enables to pick out items at the rate of their weight.
-    Weight data is storaged as a YAML file.
-    You can use this library for music player, wallpaper changer, language training.
-  }
-  gem.email = "ippei94da@gmail.com"
-  gem.authors = ["ippei94da"]
-  # dependencies defined in Gemfile
+    # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+    gem.name = "weightedpicker"
+    gem.homepage = "http://github.com/ippei94da/weightedpicker"
+    gem.license = "MIT"
+    gem.summary = %Q{Picking one item from list at the rate of its weight.}
+    gem.description = %Q{This library enables to pick out items at the rate of their weight.
+        Weight data is storaged as a YAML file.
+        You can use this library for music player, wallpaper changer, language training.
+    }
+    gem.email = "ippei94da@gmail.com"
+    gem.authors = ["ippei94da"]
+    # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
+#require 'rspec/core'
+#require 'rspec/core/rake_task'
+#RSpec::Core::RakeTask.new(:spec) do |spec|
+#    spec.pattern = FileList['spec/**/*_spec.rb']
+#end
+#
+#RSpec::Core::RakeTask.new(:rcov) do |spec|
+#    spec.pattern = 'spec/**/*_spec.rb'
+#    spec.rcov = true
+#end
+#
+#task :default => :spec
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
 end
-
-task :default => :spec
+task :default => :test
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+    version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "weightedpicker #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "weightedpicker #{version}"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/weightedpicker.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'yaml'
 
 class WeightedPicker; end
@@ -5,18 +6,18 @@ class WeightedPicker; end
 require 'weightedpicker/tree.rb'
 
 # TODO
-#   initialize.指定したファイル内のデータが WeightedPicker 的に
-#   解釈できなければ例外。
+#       initialize.指定したファイル内のデータが WeightedPicker 的に
+#       解釈できなければ例外。
 
 #= 概要
 # 要素群の中から、優先度に応じた重み付きランダムで、
 # どれか1つを選択する。
 # たとえば、以下の用途に使える。
 #* 音楽ファイルの再生(好みのものは多い頻度で、
-#  そうでないものは少ない頻度で)
+#    そうでないものは少ない頻度で)
 #* クイズゲームの問題選択
 #* 画像
-#  * 写真で壁紙, スライドショー的な用途。
+#    * 写真で壁紙, スライドショー的な用途。
 #
 # 対象の要素はファイルであることを前提としない。
 # 文字列であることが多いかもしれない。
@@ -95,124 +96,128 @@ require 'weightedpicker/tree.rb'
 # 
 # ヒストリ関係はこのクラスの外に出した方が良いと判断。
 class WeightedPicker
-  MAX_WEIGHT = 2**16
-  INI_WEIGHT = 2** 8
-  MIN_WEIGHT = 2** 0
-
-  HISTGRAM_WIDTH = 50
-
-  class InvalidFilenameError < Exception; end
-  class NoEntryError         < Exception; end
-  class NotExistKeyError     < Exception; end
-  class InvalidWeightError   < Exception; end
-
-  # Initialization.
-  def initialize(data)
-    data = sanity_data(data)
-    @tree = WeightedPicker::Tree.new(data)
-  end
-
-  # Argument 'file' indicates a strage file name for data
-  # which this class manages.
-  # If the 'file' does not exist, this file is used to data strage.
-  #
-  # Argument 'items' is an array of items to be managed.
-  # Not all the items in the 'file' survive.
-  # A and B in the file and B and C in items,
-  # then B and C is the items which this class manage.
-  # A is discarded from record.
-  def self.load_file(filename)
-    weights = YAML.load_file(filename)
-    self.new(weights)
-  end
-
-  def dump(io)
-    YAML.dump(@tree.names_weights, io)
-  end
-
-  def dump_histgram(io)
-    encounters = {}
-    names_weights.each do |key, weight|
-      #val_log2 = (Math::log(weight)/Math::log(2.0)).to_i
-      power = Math::log2(weight).ceil
-      encounters[power] ||= 0
-      encounters[power] += 1
+    MAX_WEIGHT = 2**16
+    INI_WEIGHT = 2** 8
+    MIN_WEIGHT = 2** 0
+
+    HISTGRAM_WIDTH = 50
+
+    class InvalidFilenameError < Exception; end
+    class NoEntryError               < Exception; end
+    class NotExistKeyError       < Exception; end
+    class InvalidWeightError     < Exception; end
+
+    # Initialization.
+    def initialize(data)
+        data = sanity_data(data)
+        @tree = WeightedPicker::Tree.new(data)
     end
-    max = encounters.values.max
-    0.upto(16) do |power|
-      num = encounters[power] || 0
-      stars = "*" * (HISTGRAM_WIDTH.to_f * num / max).ceil
-      io.printf("%6d(%4d)|#{stars}\n", 2**power, num)
+
+    # Argument 'file' indicates a strage file name for data
+    # which this class manages.
+    # If the 'file' does not exist, this file is used to data strage.
+    #
+    # Argument 'items' is an array of items to be managed.
+    # Not all the items in the 'file' survive.
+    # A and B in the file and B and C in items,
+    # then B and C is the items which this class manage.
+    # A is discarded from record.
+    def self.load_file(filename)
+        weights = YAML.load_file(filename)
+        self.new(weights)
     end
-  end
-
-  def names_weights
-    @tree.names_weights
-  end
-
-  def names
-    names_weights.keys
-  end
-
-  # 乱数を利用して優先度で重み付けして要素を選び、要素を返す。
-  # num is only for test. User should not use this argument.
-  def pick
-    @tree.pick
-  end
-
-  #重みを重くする。(優先度が上がる)
-  def weigh(item)
-    @tree.weigh(item)
-  end
-
-  #重みを軽くする。(優先度が下がる)
-  def lighten(item)
-    @tree.lighten(item)
-  end
-
-  # 引数 keys で示したものと、
-  # 内部的に管理しているデータが整合しているかチェックし、
-  # keys に合わせる。
-  # 追加されたデータの重みは、データ内に存在する最大値と
-  # 同じになる。
-  # This affects destructively.
-  def merge(keys)
-    new_weights = {}
-    new_keys = []
-    max = 0
-    data = @tree.names_weights
-    keys.each do |key|
-      new_weights[key] = data[key]
-
-      if data[key] == nil
-        #substitute max among exist values afterward
-        new_keys << key unless data[key]
-        next 
-      end
-
-      max = data[key] if max < data[key]
+
+    def dump(io)
+        YAML.dump(@tree.names_weights, io)
     end
 
-    max = INI_WEIGHT if max < INI_WEIGHT
-    new_keys.each do |key|
-      new_weights[key] = max
+    def dump_histgram(io)
+        encounters = {}
+        names_weights.each do |key, weight|
+            #val_log2 = (Math::log(weight)/Math::log(2.0)).to_i
+            power = Math::log2(weight).ceil
+            encounters[power] ||= 0
+            encounters[power] += 1
+        end
+        max = encounters.values.max
+        0.upto(16) do |power|
+            num = encounters[power] || 0
+            stars = "*" * (HISTGRAM_WIDTH.to_f * num / max).ceil
+            io.printf("%6d(%4d)|#{stars}\n", 2**power, num)
+        end
     end
 
-    data = new_weights
+    def names_weights
+        @tree.names_weights
+    end
+
+    def names
+        names_weights.keys
+    end
 
-    @tree = WeightedPicker::Tree.new(data)
-  end
+    # 乱数を利用して優先度で重み付けして要素を選び、要素を返す。
+    # num is only for test. User should not use this argument.
+    def pick
+        @tree.pick
+    end
+
+    #重みを重くする。(優先度が上がる)
+    def weigh(item)
+        @tree.weigh(item)
+    end
+
+    #重みを軽くする。(優先度が下がる)
+    def lighten(item)
+        @tree.lighten(item)
+    end
+
+    # 引数 keys で示したものと、
+    # 内部的に管理しているデータが整合しているかチェックし、
+    # keys に合わせる。
+    # 追加されたデータの重みは、データ内に存在する最大値と
+    # 同じになる。
+    # This affects destructively.
+    def merge(keys)
+        new_weights = {}
+        new_keys = []
+        max = 0
+        data = @tree.names_weights
+        keys.each do |key|
+            new_weights[key] = data[key]
+
+            if data[key] == nil
+                #substitute max among exist values afterward
+                new_keys << key unless data[key]
+                next 
+            end
+
+            max = data[key] if max < data[key]
+        end
+
+        max = INI_WEIGHT if max < INI_WEIGHT
+        new_keys.each do |key|
+            new_weights[key] = max
+        end
+
+        data = new_weights
+
+        @tree = WeightedPicker::Tree.new(data)
+    end
+
+    def total_weight
+        @tree.total_weight
+    end
 
-  private
+    private
 
-  def sanity_data(data)
-    data.each do |key, val|
-      data[key] = 0 if val < MIN_WEIGHT
-      data[key] = MAX_WEIGHT if MAX_WEIGHT < val
+    def sanity_data(data)
+        data.each do |key, val|
+            data[key] = 0 if val < MIN_WEIGHT
+            data[key] = MAX_WEIGHT if MAX_WEIGHT < val
 
-      raise InvalidWeightError, "#{val.inspect}, not integer." unless val.is_a? Integer
+            raise InvalidWeightError, "#{val.inspect}, not integer." unless val.is_a? Integer
+        end
+        data
     end
-    data
-  end
 
 end

data/lib/weightedpicker/tree.rb

@@ -6,118 +6,122 @@
 #
 class WeightedPicker::Tree
 
-  attr_reader :size
+    attr_reader :size
 
-  class NoEntryError < Exception; end
+    class NoEntryError < Exception; end
 
-  #
-  def initialize(data)
-    @size = data.size #for return hash.
+    #
+    def initialize(data)
+        @size = data.size #for return hash.
 
-    @names = data.keys
-    @weights = []
-    @weights[0] = data.values
+        @names = data.keys
+        @weights = []
+        @weights[0] = data.values
 
-    #Fill 0 to 2**n
-    @size.upto ((2 ** depth) - 1) do |i|
-      @weights[0][i] = 0
-    end
+        #Fill 0 to 2**n
+        @size.upto ((2 ** depth) - 1) do |i|
+            @weights[0][i] = 0
+        end
+
+        depth.times do |i|
+            @weights[i+1] = []
+            num = @weights[i].size
+            (num - num / 2).times do |j|
+                @weights[i+1] << @weights[i][2*j] + @weights[i][2*j + 1]
+            end
+        end
 
-    depth.times do |i|
-      @weights[i+1] = []
-      num = @weights[i].size
-      (num - num / 2).times do |j|
-        @weights[i+1] << @weights[i][2*j] + @weights[i][2*j + 1]
-      end
+        @weights.reverse!
     end
 
-    @weights.reverse!
-  end
+    # Return internal data as a Hash.
+    def names_weights
+        results = {}
+        @size.times do |i|
+            results[@names[i]] = @weights[-1][i]
+        end
+        results
+    end
 
-  # Return internal data as a Hash.
-  def names_weights
-    results = {}
-    @size.times do |i|
-      results[@names[i]] = @weights[-1][i]
+    def pick
+        raise NoEntryError if @weights[0][0] == 0
+
+        current_index = 0
+        depth.times do |i|
+            next_id0 = 2 * current_index
+            next_id1 = 2 * current_index + 1
+            #puts
+            choise = choose( @weights[i+1][next_id0], @weights[i+1][next_id1])
+            current_index = 2 * current_index + choise
+        end
+        return @names[current_index]
     end
-    results
-  end
-
-  def pick
-    raise NoEntryError if @weights[0][0] == 0
-
-    current_index = 0
-    depth.times do |i|
-      next_id0 = 2 * current_index
-      next_id1 = 2 * current_index + 1
-      #puts
-      choise = choose( @weights[i+1][next_id0], @weights[i+1][next_id1])
-      current_index = 2 * current_index + choise
+
+    def weigh(item)
+        raise NoEntryError unless @names.include?(item)
+        id = index(item)
+        old_weight = @weights[-1][id]
+        if (WeightedPicker::MAX_WEIGHT < old_weight * 2)
+            add_weight = WeightedPicker::MAX_WEIGHT - old_weight
+        else
+            add_weight = old_weight
+        end
+        return if add_weight == 0
+        add_ancestors(id, add_weight)
     end
-    return @names[current_index]
-  end
-
-  def weigh(item)
-    raise NoEntryError unless @names.include?(item)
-    id = index(item)
-    old_weight = @weights[-1][id]
-    if (WeightedPicker::MAX_WEIGHT < old_weight * 2)
-      add_weight = WeightedPicker::MAX_WEIGHT - old_weight
-    else
-      add_weight = old_weight
+
+    def lighten(item)
+        raise NoEntryError unless @names.include?(item)
+        id = index(item)
+        old_weight = @weights[-1][id]
+        if (old_weight / 2 < WeightedPicker::MIN_WEIGHT)
+            add_weight = 0
+        else
+            add_weight = - old_weight / 2
+        end
+        return if add_weight == 0
+        add_ancestors(id, add_weight)
     end
-    return if add_weight == 0
-    add_ancestors(id, add_weight)
-  end
-
-  def lighten(item)
-    raise NoEntryError unless @names.include?(item)
-    id = index(item)
-    old_weight = @weights[-1][id]
-    if (old_weight / 2 < WeightedPicker::MIN_WEIGHT)
-      add_weight = 0
-    else
-      add_weight = - old_weight / 2
+
+    def total_weight
+        @weights[0][0]
     end
-    return if add_weight == 0
-    add_ancestors(id, add_weight)
-  end
 
-  private
+    private
 
-  def add_ancestors(id, val)
-    (depth+1).times do |d|
-      divisor = 2 ** (depth - d)
-      x = id / divisor
-      @weights[d][x] += val
+    def add_ancestors(id, val)
+        (depth+1).times do |d|
+            divisor = 2 ** (depth - d)
+            x = id / divisor
+            @weights[d][x] += val
+        end
     end
-  end
 
-  def log2_ceil(num)
-    result = 0
-    while (num > 1)
-      result += 1
-      num -= num/2
+    def log2_ceil(num)
+        result = 0
+        while (num > 1)
+            result += 1
+            num -= num/2
+        end
+        result
     end
-    result
-  end
 
-  def depth
-    log2_ceil(@size)
-  end
+    def depth
+        log2_ceil(@size)
+    end
 
-  def choose(num0, num1)
-    sum = num0 + num1
+    def choose(num0, num1)
+        sum = num0 + num1
 
-    # 0, 1, 2
-    return 0 if rand(sum) < num0
-    return 1
-  end
+        # 0, 1, 2
+        return 0 if rand(sum) < num0
+        return 1
+    end
 
-  def index(item)
-    return @names.index(item)
-    #raise WeightedPicker::Tree::NoEntryError
-  end
+    def index(item)
+        return @names.index(item)
+        #raise WeightedPicker::Tree::NoEntryError
+    end
 
 end