statval 0.1

data/AUTHORS

@@ -0,0 +1 @@
+Stefan Plantikow <stefanp@moviepilot.com>

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+group :development do
+  gem 'rake'
+  gem 'irbtools'
+end
+
+group :test do
+  gem 'rspec', '2.6.0'
+end

data/Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.0.2)
+    boson (1.1.1)
+    clipboard (1.0.1)
+    coderay (1.0.6)
+    diff-lcs (1.1.3)
+    every_day_irb (1.2.2)
+    fancy_irb (0.7.2)
+      paint (>= 0.8.1)
+      unicode-display_width (>= 0.1.1)
+    g (1.6.0)
+      ruby_gntp
+    hirb (0.6.2)
+    interactive_editor (0.0.10)
+      spoon (>= 0.0.1)
+    irbtools (1.2.2)
+      awesome_print (~> 1.0.2)
+      boson (~> 1.1.1)
+      clipboard (~> 1.0.1)
+      coderay (~> 1.0.5)
+      every_day_irb (>= 1.2.2)
+      fancy_irb (>= 0.7.2)
+      g (>= 1.5.0)
+      hirb (~> 0.6.1)
+      interactive_editor (>= 0.0.10)
+      method_locator (>= 0.0.4)
+      method_source (>= 0.7.0)
+      methodfinder (>= 1.2.5)
+      ori (~> 0.1.0)
+      paint (>= 0.8.4)
+      sketches (>= 0.1.1)
+      wirb (>= 0.4.2)
+      zucker (>= 12.1)
+    method_locator (0.0.4)
+    method_source (0.7.1)
+    methodfinder (1.2.5)
+    ori (0.1.0)
+    paint (0.8.4)
+    rake (0.9.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby_gntp (0.3.4)
+    sketches (0.1.1)
+    spoon (0.0.1)
+    unicode-display_width (0.1.1)
+    wirb (0.4.2)
+    zucker (12.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  irbtools
+  rake
+  rspec (= 2.6.0)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Stefan Plantikow
+
+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,28 @@
+statval
+=======
+
+Very simple incremental statisctics collector
+
+    require 'statval'
+    s = StatVal.new
+    => {:avg=>0.0, :std=>0.0, :min=>Infinity, :max=>-Infinity, :num=>0, :sum=>0, :sq_sum=>0, :avg_sq=>0.0, :var=>0.0}
+
+    s << 10
+    s << 20
+    s << 30
+    s.to_hash
+    => {:avg=>20.0, :std=>8.16496580927726, :min=>10, :max=>30}
+
+    s.to_hash(:all)
+    => {:avg=>20.0, :std=>8.16496580927726, :min=>10, :max=>30, :num=>3, :sum=>60, :sq_sum=>1400, :avg_sq=>466.6666666666667, :var=>66.66666666666669}
+
+    s[:max]=40
+    h = { :a => 5, :s => s }
+    => {:a=>5, :s=>{:avg=>20.0, :std=>8.16496580927726, :min=>10, :max=>40, :num=>3, :sum=>60, :sq_sum=>1400, :avg_sq=>466.6666666666667, :var=>66.66666666666669}}
+
+    StatVal.map_hash(h)
+    => {:a=>5, :s=>{:avg=>20.0, :std=>8.16496580927726, :min=>10, :max=>40}}
+
+    StatVal.flatmap_hash(h, :all)
+    => {:a=>5, "s_avg"=>20.0, "s_std"=>8.16496580927726, "s_min"=>10, "s_max"=>40, "s_num"=>3, "s_sum"=>60, "s_sq_sum"=>1400, "s_avg_sq"=>466.6666666666667, "s_var"=>66.66666666666669}
+

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+
+require 'rdoc/task'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc 'Run all rspecs'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.fail_on_error = true
+  spec.verbose       = false
+end
+
+desc 'Run rdoc over project sources'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+desc 'Run irb in project environment'
+task :console do
+  require 'irb'
+  ARGV.clear
+  IRB.start
+end
+
+task :doc => :rdoc
+task :test => :spec
+task :irb => :console

data/lib/statval.rb

@@ -0,0 +1,2 @@
+require 'statval/version'
+require 'statval/statval'

data/lib/statval/statval.rb

@@ -0,0 +1,227 @@
+module StatVal
+
+  class StatVal
+
+    POS_INFINITY =   1.0/0.0
+    NEG_INFINITY = - 1.0/0.0
+
+    attr_reader :num
+    attr_reader :min
+    attr_reader :max
+    attr_reader :sum
+    attr_reader :sq_sum
+
+    def initialize(options = {}) ; reset(options) end
+
+    def reset(options = {})
+      options[:num] = 0 unless options[:num]
+      options[:min] = nil unless options[:min]
+      options[:max] = nil unless options[:max]
+      options[:sum] = 0 unless options[:sum]
+      options[:sq_sum] = 0 unless options[:sq_sum]
+      options.each_pair { |k, v| self[k] = v}
+      options
+    end
+
+
+    def all_keys ; [ :avg, :std, :min, :max, :num, :sum, :sq_sum, :avg_sq, :var ] end
+    def default_keys ; [ :avg, :std, :min, :max, :num ] end
+    def writable_keys ; [ :num, :min, :max, :sum, :sq_sum ] end
+
+    alias_method :keys, :default_keys
+
+    def [](key)
+      case key
+        when :num then num
+        when :min then min
+        when :max then max
+        when :sum then sum
+        when :sq_sum then sq_sum
+        when :avg then avg
+        when :std then std
+        when :avg_sq then avg_sq
+        when :var then var
+        else
+          raise ArgumentError
+      end
+    end
+
+    def []=(key, new_val)
+      case key
+        when :num then self.num = new_val
+        when :min then self.min = new_val
+        when :max then self.max = new_val
+        when :sum then self.sum = new_val
+        when :sq_sum then self.sq_sum = new_val
+        else
+          raise ArgumentError
+      end
+    end
+
+    def each_pair
+      this = self
+      keys.each { | key| yield key, this[key] }
+    end
+
+    alias_method :each, :each_pair
+
+    def values
+      this = self
+      keys.map { |key| this[key] }
+    end
+
+    def +(value) ; self.class.new << self << value end
+
+    def <<(value, *rest)
+      this = self
+      if value.kind_of? StatVal
+        if empty?
+          reset(value.to_hash(:writable))
+        else
+          begin
+            @num    += value.num
+            @sum    += value.sum
+            @sq_sum += value.sq_sum
+            val_min  = value.min
+            val_max  = value.max
+            @min     = val_min if val_min < @min
+            @max     = val_max if val_max > @max
+          end unless value.empty?
+        end
+      else
+        if value.kind_of? Numeric
+          @sum       += value
+          @sq_sum    += value * value
+          @num       += 1
+          @min        = value if value < @min
+          @max        = value if value > @max
+        else
+          if value.respond_to?(:each_pair)
+            value.each_pair { |k, v| this << v } 
+          else 
+            if value.respond_to?(:each)
+              value.each { |v| this << v } 
+            else
+              raise ArgumentError
+            end
+          end
+        end
+      end
+      rest.each { |v| this << v } if rest
+      this
+    end
+
+    def key_hash(which_keys = nil)
+      return which_keys if which_keys.is_a?(Hash)
+
+      case which_keys
+        when nil then iter = keys
+        when :all then iter = all_keys
+        when :default then iter = default_keys
+        when :writable then iter = writable_keys
+        else
+          if which_keys.repsond_to?(:each)
+            iter = which_Keys
+          else
+            return { which_keys => which_keys }
+          end
+      end
+
+      iter.inject({}) { |h, k| h[k] = k; h }
+    end
+
+    def to_hash(which_keys = nil)
+      key_hash(which_keys).inject({}) { |h, (name, attr)| h[name] = self[attr]; h }
+    end
+
+    def to_s ; to_hash.to_s end
+
+    def empty? ; @num == 0 end
+
+    def bounded? ; ! (abs_is_infinite(@min) || abs_is_infinite(@max)) end
+
+    def avg ; if empty? then zero_if_unbounded(abs_div(@max - @min, 2)) else abs_div(@sum, @num) end end
+
+    def avg_sq
+      if empty? then zero_if_unbounded(abs_div((@max*@max) - (@min*@min), 2)) else abs_div(@sq_sum, @num) end
+    end
+
+    def var ; avg_sq - (avg * avg) end
+
+    def std ; Math.sqrt(var) end
+
+    def num=(new_val)
+      raise ArgumentError if new_val < 0
+      @num = new_val
+    end
+
+    def sum=(new_val)
+      raise ArgumentError if new_val < 0
+      @sum= new_val
+    end
+
+    def sq_sum=(new_val)
+      raise ArgumentError if new_val < 0
+      @sq_sum= new_val
+    end
+
+    def min=(new_val)
+      @min = if new_val then new_val else (if empty? then POS_INFINITY else avg-std end) end
+    end
+
+    def max=(new_val)
+      @max = if new_val then new_val else (if empty? then NEG_INFINITY else avg+std end) end
+    end
+
+    private
+
+    def abs_is_infinite(val) ; val.abs.to_f === POS_INFINITY end
+
+    def zero_if_unbounded(val) ; if bounded? then val else 0.0 end end
+
+    def abs_div(nom, denom) ; nom.abs.to_f / denom end
+
+  end
+
+  # Take hash that contains StatVal values and create new hash that is identical to it but has
+  # the StatVal values v replaced by v.to_hash(which_keys)
+  #
+  # Just copies non-StatVal entries
+  #
+  def self.map_hash(h, which_keys = nil)
+    r = {}
+    h.each_pair { |k,v| r[k] = if v.kind_of?(StatVal) then v.to_hash(which_keys) else v end }
+    r
+  end
+
+  # Like map_hash, but flattens converted StatVal values such there attributes get pre- or appended
+  # with their key in the outer hash
+  #
+  # All symbols
+  # raises on key conflict
+  #
+  def self.flatmap_hash(h, which_keys = nil, prefix=true, use_symbols=false)
+    flat = {}
+    h.each_pair do |k,r|
+      if r.kind_of? StatVal
+        results = r.to_hash(which_keys)
+        results.each_pair do |tag,val|
+          new_tag = if prefix then "#{tag}_#{k}" else "#{k}_#{tag}" end
+          new_tag = new_tag.to_sym if use_symbols
+
+          raise ArgumentError if flat[new_tag]
+          flat[new_tag] = val
+        end
+      else
+        raise ArgumentError if flat[k]
+        if k.is_a?(Symbol) && !use_symbols
+          flat[k.to_s] = r
+        else
+          flat[k] = r
+        end
+      end
+    end
+    flat
+  end
+
+end

data/lib/statval/version.rb

@@ -0,0 +1,3 @@
+module StatVal
+  VERSION = '0.1'
+end

data/spec/lib/statval/statval_spec.rb

@@ -0,0 +1,78 @@
+require 'set'
+
+require 'statval'
+
+module StatVal
+  describe StatVal do
+
+    it 'is instantiated' do
+      @it = lambda { StatVal.new }
+      @it.should_not raise_error
+    end
+
+    it 'collects statistics' do
+      @it = StatVal.new
+      @it << 0
+      @it << 10
+      @it << [0, 10]
+      @it.<< 0, 10
+      @it << @it
+      @it << [@it, @it] # :)
+      @it.avg.should be == 5.0
+      @it.num.should be == 48
+      @it.var.should be == 25.0
+      @it.std.should be == 5.0
+      @it.min.should be == 0
+      @it.max.should be == 10
+    end
+
+    it 'is additive' do
+      @one = StatVal.new
+      @one << 10
+      @one << 10
+      @two = StatVal.new
+      @two << 20
+      @two << 20
+      @it = @one + @two
+      @it.avg.should be == 15.0
+    end
+
+    it 'resets' do
+      @it = StatVal.new
+      @it.reset num: 2, min: -2, max: +12, sum: 10, sq_sum: 148
+      @it.num.should be == 2
+      @it.min.should be == -2
+      @it.max.should be == 12
+      @it.sum.should be == 10
+      @it.avg.should be == 5.0
+      @it.sq_sum.should be == 148
+      @it.var.should be == 49
+      @it.std.should be == 7
+    end
+
+    it 'can be accessed like a hash' do
+      @it = StatVal.new
+      @it[:num] = 2
+      @it[:min] = -2
+      @it[:max] = 12
+      @it[:sum] = 10
+      @it[:sq_sum] = 148
+      @it[:num].should be == 2
+      @it[:min].should be == -2
+      @it[:max].should be == 12
+      @it[:sum].should be == 10
+      @it[:avg].should be == 5.0
+      @it[:sq_sum].should be == 148
+      @it[:var].should be == 49
+      @it[:std].should be == 7      
+    end
+
+    it 'renders hashes' do
+      @it = StatVal.new
+      @it.reset num: 2, min: -2, max: +12, sum: 10, sq_sum: 148
+      @it = { a: 7, h: @it } 
+      ::StatVal.map_hash(@it).keys.to_set.should be == [ :h, :a ].to_set
+      ::StatVal.flatmap_hash(@it).keys.to_set.should be == [ 'a', 'num_h', 'std_h', 'min_h', 'max_h', 'avg_h' ].to_set
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler.setup

data/statval.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'statval/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'statval'
+  s.version     = StatVal::VERSION
+  s.summary     = 'Very simple statistics collector'
+  s.description = 'Utility class for incrementally recording measured values and reporting avg, variance, min, and max'
+  s.author      = 'Stefan Plantikow'
+  s.email       = 'stefanp@moviepilot.com'
+  s.homepage    = 'http://moviepilot.github.com/statval'
+  s.rubyforge_project = 'statval'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.bindir      = 'script'
+  s.executables = `git ls-files -- script/*`.split("\n").map{ |f| File.basename(f) }
+#  s.default_executable = 'statval'
+  s.licenses = ['PUBLIC DOMAIN WITHOUT ANY WARRANTY']
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: statval
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Stefan Plantikow
+autorequire: 
+bindir: script
+cert_chain: []
+date: 2012-04-16 00:00:00.000000000 Z
+dependencies: []
+description: Utility class for incrementally recording measured values and reporting
+  avg, variance, min, and max
+email: stefanp@moviepilot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/statval.rb
+- lib/statval/statval.rb
+- lib/statval/version.rb
+- spec/lib/statval/statval_spec.rb
+- spec/spec_helper.rb
+- statval.gemspec
+homepage: http://moviepilot.github.com/statval
+licenses:
+- PUBLIC DOMAIN WITHOUT ANY WARRANTY
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3748375320206604171
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: statval
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Very simple statistics collector
+test_files:
+- spec/lib/statval/statval_spec.rb
+- spec/spec_helper.rb