hive-stalker 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd25f6be41759e222436358de85faa3b201b186de9284bb6e192046b4b8697c1
-  data.tar.gz: b3be85cec70b83f55de5c90acc218023c306bb9b5ca83e5fbfa8f64b86316cc6
+  metadata.gz: 680174946cee915b68f32d6e6963e7634eee6d4ff233ce168fea839c2ce42f38
+  data.tar.gz: 62211fd3df968d77089d0c9f5ab6d0c42fa32312679b980b3978139e9dd09db9
 SHA512:
-  metadata.gz: 5e1d711c97febf884a1464f08ce88cb17ea4b5409cbb3a809e1511cdac5e897d366b8ba97ac573766efbd778e8e21b93ea73d95dff7de1e0fa8383d26ad7d9d8
-  data.tar.gz: c467cbb107f064722af5d4e3b99df616962e3ae2c5e99deed655e0459a5d6ed462a2c75ebd022190787343112139941b0ebf07d7fc03bbb65860b6112dfad890
+  metadata.gz: a8c520b55a9ca8b062ef38d2cf4e11c078927573f40bc15bb7651da3be6f73d9372c56639f358238adba54580f43c4b46e845b1a8b2a4c27dc6402454d180f52
+  data.tar.gz: 96eb5d47d0be3c0a5f8ba8b3ba83ea54c18fcb9d76de1deda87233f7bf6a88344e49341fc35a700e56a486da2cac913fea50686f14e5fa91a793d2994a17e903

data/CHANGELOG.md

@@ -19,6 +19,16 @@ glance - what to expact from upgrading to a new version.
 ### Removed
 
 
+## [0.3.0] - 2020-11-01
+
+### Added
+
+- Support for per-team and per-position (field & commander) skill values
+- Support for skill tiers
+- `PlayerData#specific_skills` which returns a struct with such-computed values
+- `PlayerData#specific_skill_tiers` which returns a struct with such-computed skill tiers
+
+
 ## [0.2.0] - 2019-03-04
 
 ### Added

data/hive-stalker.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "hive-stalker"
-  spec.version       = '0.2.0'
+  spec.version       = '0.3.0'
   spec.authors       = ["Michael Senn"]
   spec.email         = ["michael@morrolan.ch"]
 

data/lib/hive_stalker/client.rb

@@ -62,12 +62,18 @@ module HiveStalker
           # normalization of skills, which happened shortly after Hive2 went
           # live.
           skill: raw_data.fetch('skill').to_i,
+          skill_offset: raw_data.fetch('skill_offset').to_i,
+          comm_skill: raw_data.fetch('comm_skill').to_i,
+          comm_skill_offset: raw_data.fetch('comm_skill_offset').to_i,
           time_total: raw_data.fetch('time_played'),
           time_marine: raw_data.fetch('marine_playtime'),
           time_alien: raw_data.fetch('alien_playtime'),
           time_commander: raw_data.fetch('commander_time'),
           reinforced_tier: raw_data.fetch('reinforced_tier'),
-          adagrad_sum: raw_data.fetch('adagrad_sum'),
+          # For accounts with no Hive2 rounds on record, the adagrad sum will be null.
+          adagrad_sum: raw_data.fetch('adagrad_sum') || 0,
+          # For people without a single comm round on record since Hive3, the comm adagrad sum might be null.
+          comm_adagrad_sum: raw_data.fetch('comm_adagrad_sum') || 0,
           latitude: raw_data.fetch('lat', 0).to_f,
           longitude: raw_data.fetch('long', 0).to_f,
           continent: raw_data.fetch('cont', ''),

data/lib/hive_stalker/player_data.rb

@@ -1,4 +1,11 @@
 module HiveStalker
+  SpecificSkill = Struct.new(:alien, :marine)
+  TeamSkill = Struct.new(:field, :field_estimate, :commander, :commander_estimate)
+
+  SkillTier = Struct.new(:name, :rank)
+  SpecificSkillTier = Struct.new(:alien, :marine)
+  TeamSkillTier = Struct.new(:field, :commander)
+
   # Container for various player statistics. Essentially a glorified struct.
   class PlayerData
     # Player ID, probably NS2/Hive2-internal.
@@ -29,10 +36,22 @@ module HiveStalker
     # @return [Array]
     attr_reader :badges
 
-    # Skill / ELO
+    # Field skill / ELO base value
     # @return [Fixnum]
     attr_reader :skill
 
+    # Field skill / ELO offset
+    # @return [Fixnum]
+    attr_reader :skill_offset
+
+    # Comm skill / ELO base value
+    # @return [Fixnum]
+    attr_reader :commander_skill
+
+    # Comm skill / ELO offset
+    # @return [Fixnum]
+    attr_reader :commander_skill_offset
+
     # Total time played in seconds.
     #
     # This equals {#time_marine} + {#time_alien}
@@ -55,10 +74,14 @@ module HiveStalker
     # @return [NilClass]
     attr_reader :reinforced_tier
 
-    # AdaGrad sum (https://en.wikipedia.org/wiki/Stochastic_gradient_descent#AdaGrad).
+    # Field AdaGrad sum (https://en.wikipedia.org/wiki/Stochastic_gradient_descent#AdaGrad).
     # @return [Float]
     attr_reader :adagrad_sum
 
+    # Comm AdaGrad sum (https://en.wikipedia.org/wiki/Stochastic_gradient_descent#AdaGrad).
+    # @return [Float]
+    attr_reader :commander_adagrad_sum
+
     # Geographical latitude
     # @return [Float]
     attr_reader :latitude
@@ -76,23 +99,114 @@ module HiveStalker
     # @param kwargs [Hash<Symbol, Object>] data with which to initialize the
     #   instance's attributes.
     def initialize(**kwargs)
-      @player_id       = kwargs[:player_id]
-      @steam_id        = kwargs[:steam_id]
-      @alias           = kwargs[:alias]
-      @score           = kwargs[:score]
-      @level           = kwargs[:level]
-      @experience      = kwargs[:experience]
-      @badges          = kwargs[:badges]
-      @skill           = kwargs[:skill]
-      @time_total      = kwargs[:time_total]
-      @time_marine     = kwargs[:time_marine]
-      @time_alien      = kwargs[:time_alien]
-      @time_commander  = kwargs[:time_commander]
-      @reinforced_tier = kwargs[:reinforced_tier]
-      @adagrad_sum     = kwargs[:adagrad_sum]
-      @latitude        = kwargs[:latitude]
-      @longitude       = kwargs[:longitude]
-      @continent       = kwargs[:continent]
+      @player_id              = kwargs[:player_id]
+      @steam_id               = kwargs[:steam_id]
+      @alias                  = kwargs[:alias]
+      @score                  = kwargs[:score]
+      @level                  = kwargs[:level]
+      @experience             = kwargs[:experience]
+      @badges                 = kwargs[:badges]
+      @skill                  = kwargs[:skill]
+      @skill_offset           = kwargs[:skill_offset]
+      @commander_skill        = kwargs[:comm_skill]
+      @commander_skill_offset = kwargs[:comm_skill_offset]
+      @time_total             = kwargs[:time_total]
+      @time_marine            = kwargs[:time_marine]
+      @time_alien             = kwargs[:time_alien]
+      @time_commander         = kwargs[:time_commander]
+      @reinforced_tier        = kwargs[:reinforced_tier]
+      @adagrad_sum            = kwargs[:adagrad_sum]
+      @commander_adagrad_sum  = kwargs[:comm_adagrad_sum]
+      @latitude               = kwargs[:latitude]
+      @longitude              = kwargs[:longitude]
+      @continent              = kwargs[:continent]
+    end
+
+    # Returns per-team and per-position (field / commander) skills, including
+    # lower bounds for each.
+    def specific_skills
+      return SpecificSkill.new(
+        # Alien
+        TeamSkill.new(
+          # Field
+          [skill - skill_offset, 0].max,
+          skill_estimate(skill - skill_offset, adagrad_sum),
+
+          # Commander
+          [commander_skill - commander_skill_offset, 0].max,
+          skill_estimate(commander_skill - commander_skill_offset, commander_adagrad_sum),
+        ),
+
+        # Marine
+        TeamSkill.new(
+          # Field
+          skill + skill_offset,
+          skill_estimate(skill + skill_offset, adagrad_sum),
+
+          # Commander
+          commander_skill + commander_skill_offset,
+          skill_estimate(commander_skill + commander_skill_offset, commander_adagrad_sum),
+        ),
+      )
+    end
+
+    def specific_skill_tiers
+      skills = specific_skills
+
+      return SpecificSkillTier.new(
+        # Alien
+        TeamSkillTier.new(
+          # Field
+          skill_tier(skills.alien.field_estimate, level),
+          # Commander
+          skill_tier(skills.alien.commander_estimate, level),
+        ),
+
+        # Marine
+        TeamSkillTier.new(
+          # Field
+          skill_tier(skills.marine.field_estimate, level),
+          # Commander
+          skill_tier(skills.marine.commander_estimate, level),
+        ),
+      )
+    end
+
+    private
+    # Conservative estimate of a player's skill, using the sum of adagrad
+    # gradients. Works somewhat like a lower one-sided bound with indeterminate
+    # confidence.
+    def skill_estimate(skill_value, adagrad_sum_value)
+      # Use adagrad sum to get a lower bound for a player's skill.
+      [0, skill_value - 25 / Math.sqrt(adagrad_sum_value)].max
+    end
+
+    # Skill tier assignment based on skill estimate and level.
+    def skill_tier(skill_estimate, level)
+      if level < 20
+        SkillTier.new('Rookie', 0)
+
+      elsif skill_estimate < 301
+        SkillTier.new('Recruit', 1)
+
+      elsif skill_estimate < 751
+        SkillTier.new('Frontiersman', 2)
+
+      elsif skill_estimate < 1401
+        SkillTier.new('Squad Leader', 3)
+
+      elsif skill_estimate < 2101
+        SkillTier.new('Veteran', 4)
+
+      elsif skill_estimate < 2901
+        SkillTier.new('Commandant', 5)
+
+      elsif skill_estimate < 4101
+        SkillTier.new('Special Ops', 6)
+
+      else
+        SkillTier.new('Sanji Survivor', 7)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hive-stalker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Senn
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2020-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description:
 email:
 - michael@morrolan.ch
 executables: []
@@ -124,7 +124,7 @@ homepage: https://bitbucket.org/Lavode/hivestalker
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Binding to Natural Selection 2's Hive2 ELO system
 test_files: []