pcbr 0.1.3 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b3ebecb25ead598113da23a081caff2edae89b2
-  data.tar.gz: 017a54c57edab08278ea631356774a315a0ef976
+  metadata.gz: 9c14c95b38050d0a74a838c101e6321886aa7ac9
+  data.tar.gz: 4059ab70af92b3cad59bbc3199d29f948477d525
 SHA512:
-  metadata.gz: 9935c310af1592e636e9e3c38bc239d7323053eb5c32e3c501ce974ecc17aab10d081892f988c0074b5e579fe8d19350d36d0bcaadceb10dc536a49e293dd58f
-  data.tar.gz: 00ca5fcb6c35b5dec763a96638a25c3b39e548bad1e66f9c8b63905376d1470dc53ae5db0e2537c5a0229b88d30e44eff70bd75fe1624f9c62f32a1e7757439e
+  metadata.gz: '097ea8ee69316361d9124ca139757ddb8b0ef4e54ca4a5c91ca33f91cb80c9a06b8225d8cbaa608b0929c922c429c4b295af712d634983f4e9da997c47c05a8f'
+  data.tar.gz: d6be5246bf91af6e918583c98d25ffc96e48f7d7af5e6e647f66665c2c6f87db599ccdd77edcbd14204eadae9a96da1b387c3589c9074464f45f428be9c52d01

data/README.md

@@ -1,6 +1,6 @@
 # PCBR (Pairs Comparison Based Rating)
 
-Making ratings is fun. After applying my method several times I've decided to gemify it.
+You often need to sort an array of vectors. This allows you to do it without knowing the optimal ranking function and with some pairs of vectors that are not even comparable.
 
 ### Examples
 
@@ -8,20 +8,20 @@ See [`describe "examples" do` in specs](spec/_spec.rb).
 
 ### How it works
 
-The first idea of rating items by one-to-one comparison was about QuakeLive players in 2013 or so and it didn't work well. At that time I was thinking about tree data structure. Later in May 2015 I've realised that it's really about dots in n-dimensional space and sectors. Applying it to Reddit RSS made my feed 50% more interesting.
-
-TODO: describe/illustrate algorithm?
-
-At the moment it's a "proof of concept" -- it needs huge optimisations for lookups, maybe using trees.
+The first idea was in 2013 -- at that time I was imagining it as a tree data structure. Later in May 2015 I've realised that it's really about dots in n-dimensional space and sectors, and round-robin. Applying it to Reddit RSS feed made it 50% more interesting. It also applied well to boost tree search process in the [bad Facebook advertisment classifier](https://drive.google.com/file/d/0B3BLwu7Vb2U-SVhKYWVMR2JvOFk/view?usp=sharing) production project. Since then I mostly use it to oprimize tree searches, it's basically an automated replacement for euristics.
 
 ### Installation
 
     $ gem install pcbr
 
-### Testing with RSpec before contributing
+### Testing
 
     rspec
 
 or
 
     rake spec
+
+### TODO
+
+Illustrate this README, replace rspec with minitest.

data/lib/pcbr.rb

@@ -1,43 +1,63 @@
-class PCBR
+module PCBR
+  class Error < RuntimeError
+    # def initialize body
+    #   super "#{Module.nesting[1]} error: #{body}"
+    # end
+  end
 
-  VERSION = "0.1.3"
+  def self.new &block
+    Storage.new &block
+  end
 
-  attr_reader :table
+  class Storage
+    attr_reader :table
+    attr_reader :set
+    @@default_lambda = lambda do |a_, b_|
+      raise Error.new "comparison vectors are of the different length" unless a_.size == b_.size
+      tt = [0, 0, 0]
+      [*a_].zip([*b_]) do |a, b|
+        t = a <=> b and tt[t] = t
+      end
+      tt[0] + tt[1] + tt[2]
+    end
 
-  def initialize &block
-    @table = []
-    @callback = block || ->*_{[*_[0]]}
-  end
+    def initialize &block
+      @table = []
+      @set = Set.new
+      @callback = block || @@default_lambda
+    end
 
-  # def size
-  #   @table.size
-  # end
-
-  ARRAY_101 = [0, 0, 0]
-  def store key, *vector
-    vector = vector.empty? ? [key] : vector.first
-    calculated = @callback[vector, key]
-    score = 0
-    @table.each do |item|
-      array = ARRAY_101.dup
-      calculated.zip(item[3]).each do |a, b|
-        next unless t = a <=> b
-        array[t] = t
+    def store key, vector = nil
+      raise Error.new "duplicating key" if @set.include? key
+      key = [NilClass, FalseClass, TrueClass, Numeric, Symbol, Method].any?{ |c| key.is_a? c } ? key : key.dup
+      vector = Array key if vector.nil?
+      score = 0
+      @table.each do |item|
+        point = @callback.call vector, item[1]
+        item[2] -= point
+        score += point
       end
-      point = array.inject :+
-      score += point
-      item[2] -= point
+      @set.add key
+      @table.push [key, vector, score]
     end
-    @table.push [key, vector, score, calculated]
-  end
 
-  def score key
-    @table.assoc(key)[-2]
-  end
+    def score key
+      @table.assoc(key)[2]
+    end
 
-  def sorted
-    # from the best to the worst
-    @table.sort_by.with_index{ |item, i| [-item[2], i] }.map(&:first)
-  end
+    def sorted
+      # from the best to the worst
+      @table.sort_by.with_index{ |item, i| [-item[2], i] }.map(&:first)
+    end
+
+    # def quality
+    #   factorial = ->x{ (1..x).inject(:*) }
+    #   (2...@table.size).each do |sublength|
+    #     combinations = factorial[@table.size] / factorial[sublength] / factorial[@table.size - sublength]
+    #     comparisons = sublength * (sublength - 1) / 2
+    #     p [sublength, combinations, comparisons, combinations * comparisons]
+    #   end
+    # end
 
+  end
 end

data/pcbr.gemspec

@@ -1,18 +1,23 @@
 Gem::Specification.new do |spec|
   spec.name          = "pcbr"
-  spec.version       = (require_relative "lib/pcbr"; PCBR::VERSION)
+  spec.version       = "0.4.2"
+  spec.summary       = "Pair Comparison Based Rating"
+
   spec.author        = "Victor Maslov"
   spec.email         = "nakilon@gmail.com"
-  spec.summary       = "Pair Comparison Based Rating"
-  spec.description   = "Making ratings is fun. After applying my method several times I've decided to gemify it."
-  spec.homepage      = "https://github.com/Nakilon/pcbr"
   spec.license       = "MIT"
+  spec.homepage      = "https://github.com/Nakilon/pcbr"
+  spec.description   = <<-EOF
+    Making ratings is fun. After applying my method several times I've decided to gemify it.
+    This is one of the first gems I made so it's far for being nicely done.
+  EOF
 
-  spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = ["spec/"]
+  spec.files         = `git ls-files -z`.split(?\0) - spec.test_files
 
-  spec.add_development_dependency "bundler", "~> 1.12.0"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "ruby-prof"
 
   spec.required_ruby_version = ">= 2.0.0"
 end

data/spec/_spec.rb

@@ -13,13 +13,19 @@ describe "basic specs" do
     expect(rating.sorted).to eq([2, 1])
   end
 
-  example "#size", skip: :deprecated do
+  example "raises if vectors are of the different length" do
     rating = PCBR.new
-    rating.store 1
-    rating.store 2
-    expect(rating.size).to eq(2)
+    rating.store 1, [2]
+    expect{ rating.store 3, [4, 5] }.to raise_error PCBR::Error
   end
 
+  # example "#size" do
+  #   rating = PCBR.new
+  #   rating.store 1
+  #   rating.store 2
+  #   expect(rating.size).to eq(2)
+  # end
+
   example "Nil elements in vector are ignored" do
     rating = PCBR.new
     rating.store 1, [1, nil]
@@ -31,26 +37,41 @@ describe "basic specs" do
 
   example "&block" do
     n = 0
-    rating = PCBR.new do |item|
+    rating = PCBR.new do |a, b|
       n += 1
-      [item[:goodness], -item[:badness]]
+      a <=> b
+    end
+    rating.store 1
+    rating.store 2
+    rating.store 3
+    rating.store 4
+    expect(rating.sorted).to eq([4, 3, 2, 1])
+    expect(n).to eq(6)
+  end
+
+  example "the vector is not neccessary an Array" do
+    rating = PCBR.new do |a, b|
+      a <=> b
+    end
+    0.class.class_eval do
+      def size
+        fail
+      end
     end
-    rating.store 3, {goodness: 0, badness: 2}
-    rating.store 2, {goodness: 1, badness: 2}
-    rating.store 1, {goodness: 1, badness: 1}
-    expect(rating.sorted).to eq([1, 2, 3])
-    expect(n).to eq(3)
+    rating.store 1, 2
+    rating.store 2, 1
+    expect(rating.sorted).to eq([1, 2])
   end
 
   example "#sorted and #score[key]" do
     rating = PCBR.new
     table = [
-      [1, [1, 1], -1, [1, 1]],
-      [2, [2, 2],  5, [2, 2]],
-      [3, [0, 0], -5, [0, 0]],
-      [4, [1, 2],  3, [1, 2]],
-      [6, [1, 1], -1, [1, 1]],
-      [5, [0, 2], -1, [0, 2]],
+      [1, [1, 1], -1],
+      [2, [2, 2],  5],
+      [3, [0, 0], -5],
+      [4, [1, 2],  3],
+      [6, [1, 1], -1],
+      [5, [0, 2], -1],
     ].each do |key, vector, |
       rating.store key, vector
     end
@@ -62,6 +83,45 @@ describe "basic specs" do
     expect(rating.table).to eq(table)
   end
 
+  # example "quality estimation" do
+  #   rating = PCBR.new
+  #   table = [
+  #     [1, [1, 1]],
+  #     [2, [2, 2]],
+  #     [3, [0, 0]],
+  #     [4, [1, 2]],
+  #     [6, [1, 1]],
+  #     [5, [0, 2]],
+  #   ].each do |key, vector, |
+  #     rating.store key, vector
+  #   end
+  # end
+
+  example "duplicating keys are forbidden" do
+    rating = PCBR.new
+    rating.store 0
+    expect{ rating.store 0 }.to raise_error PCBR::Error
+  end
+
+  example "keys are dupped" do
+    rating = PCBR.new
+    a = [[1]]
+    v = [0]
+    rating.store a, v
+    a[0][0] = 2
+    rating.store [[1]], [1]
+    expect(rating.sorted).to eq [[[1]], [[2]]]
+  end
+
+  example "keys are dupped but not deeply" do
+    rating = PCBR.new
+    a = [[1]]
+    v = [0]
+    rating.store a, v
+    a[0][0] = 2
+    expect{ rating.store [[2]], [1] }.to raise_error PCBR::Error
+  end
+
 end
 
 
@@ -96,26 +156,28 @@ describe "examples" do
       "DOT: capistrano/capistrano" => {issue: 38, pr: 6, watch: 339, star: 8392, fork: 1365},
     }
 
-    push_repos = lambda do |rating|
-      repos.each do |repo_name, repo_stats|
-        rating.store repo_name, repo_stats
+    create_rating = lambda do |&callback|
+      PCBR.new.tap do |rating|
+        repos.each do |repo_name, repo_stats|
+          rating.store repo_name, callback[repo_stats, repo_name]
+        end
       end
     end
 
-    contribution_intensivity_rating = PCBR.new do |repo_stats| [
+    contribution_intensivity_rating = create_rating.call do |repo_stats| [
       repo_stats[:pr],
       -repo_stats[:fork],
-    ] end.tap &push_repos
+    ] end
 
-    quality_rating = PCBR.new do |repo_stats| [
+    quality_rating = create_rating.call do |repo_stats| [
       repo_stats[:star],
       -repo_stats[:issue],
-    ] end.tap &push_repos
+    ] end
 
-    resulting_rating = PCBR.new do |_, repo_name| [
+    resulting_rating = create_rating.call do |repo_stats, repo_name| [
       contribution_intensivity_rating.score(repo_name),
       quality_rating.score(repo_name),
-    ] end.tap &push_repos
+    ] end
 
     aggregate_failures do
       expect(

metadata

@@ -1,51 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: pcbr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.4.2
 platform: ruby
 authors:
 - Victor Maslov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
-description: Making ratings is fun. After applying my method several times I've decided
-  to gemify it.
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Making ratings is fun. After applying my method several times I've decided to gemify it.
+      This is one of the first gems I made so it's far for being nicely done.
 email: nakilon@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .rspec
 - Gemfile
 - README.md
 - Rakefile
@@ -62,17 +76,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Pair Comparison Based Rating

data/.rspec

@@ -1 +0,0 @@
---color