accumulators 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.1.0"
+  gem "cucumber", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,41 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    cucumber (0.9.4)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  cucumber
+  jeweler (~> 1.5.1)
+  rcov
+  rspec (~> 2.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gavin Heavyside
+
+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.rdoc

@@ -0,0 +1,27 @@
+= accumulators
+
+Statistical accumulators for Ruby
+
+== TODO ==
+
+* Running Mean
+* Running Variance/Std Deviation (sample and population)
+* Combination of mean and mean-variance
+* Skew?
+* Weighted Means
+
+== Contributing to accumulators
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Gavin Heavyside. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  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
+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 = "accumulators"
+  gem.homepage = "http://github.com/hgavin/accumulators"
+  gem.license = "MIT"
+  gem.summary = %Q{Statiscal accumulators for Ruby}
+  gem.description = %Q{Statistical accumulators for Ruby}
+  gem.email = "gavin@heavyside.co.uk"
+  gem.authors = ["Gavin Heavyside"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+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
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "accumulators #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/features/accumulators.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  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
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'accumulators'
+
+require 'rspec/expectations'

data/lib/accumulators/count.rb

@@ -0,0 +1,18 @@
+module Accumulators
+  class Count
+    attr_reader :count
+
+    def initialize
+      @count = 0
+    end
+
+    def add(rhs)
+      if rhs.is_a? Accumulators::Count
+        @count += rhs.count
+      else
+        @count += 1
+      end
+    end
+  end
+end
+

data/lib/accumulators/mean.rb

@@ -0,0 +1,27 @@
+
+module Accumulators
+  class Mean
+    attr_reader :count, :mean
+
+    def initialize
+      @count = 0
+      @mean = 0.0
+    end
+
+    def add(rhs)
+      if rhs.is_a? Numeric
+        value_to_add = rhs.to_f
+        @mean = @mean + (value_to_add - @mean)/(@count + 1)
+        @count += 1
+      elsif rhs.is_a? Accumulators::Mean
+        sum = @mean * @count
+        rhs_sum = rhs.mean * rhs.count
+        @count = @count + rhs.count
+        @mean = (sum + rhs_sum) / @count
+      else
+        raise ArgumentError.new("Can only add numbers to a Mean Accumulator")
+      end
+    end
+  end
+end
+

data/lib/accumulators.rb

@@ -0,0 +1,3 @@
+module Accumulators
+end
+

data/spec/accumulators/count_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+require 'accumulators/count'
+
+
+describe "Accumulators" do
+  describe "Count" do
+    before :each do
+      @count = Accumulators::Count.new
+    end
+
+    context "Creation" do
+      it "can be created" do
+        lambda{ Accumulators::Count.new }.should_not raise_error
+      end
+
+      it "returns count of 0 before anything is added to it" do
+        Accumulators::Count.new.count.should == 0
+      end
+    end
+
+    context "adding numbers or distributions" do
+      it "allows integers to be added" do
+        lambda{@count.add 5}.should_not raise_error
+      end
+
+      it "allows floats to be added" do
+        lambda{@count.add 3.4}.should_not raise_error
+      end
+
+      it "allows other Count distributions to be added" do
+        c2 = Accumulators::Count.new
+        lambda{@count.add c2}.should_not raise_error
+      end
+
+      it "allows strings to be added" do
+        lambda{@count.add "1.5"}.should_not raise_error
+      end
+    end
+
+    context "correctness of item additions" do
+      it "should return a count of 1 when a single item is added" do
+        @count.add 5
+        @count.count.should == 1
+      end
+
+      it "should return the count of how many items have been added" do
+        1.upto(1000) do |i|
+          @count.add i
+          @count.count.should == i
+        end
+      end
+    end
+
+    context "correctness of accumulator additions" do
+      it "should combine two Count accumulators correctly" do
+        c2 = Accumulators::Count.new
+        10.times{ c2.add 1; @count.add 1 }
+        @count.add(c2)
+        @count.count.should == 20
+      end
+    end
+  end
+end
+

data/spec/accumulators/mean_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+require 'accumulators/mean'
+
+EPSILON = 0.00001
+
+describe "Accumulators" do
+  describe "Mean" do
+    before :each do
+      @mean = Accumulators::Mean.new
+    end
+
+    context "Creation" do
+      it "can be created" do
+        lambda{ Accumulators::Mean.new}.should_not raise_error
+      end
+
+      it "returns count and mean of 0 before anything is added to it" do
+        mean = Accumulators::Mean.new
+        mean.count.should == 0
+        mean.mean.should be_within(EPSILON).of(0.0)
+      end
+
+    end
+
+    context "adding numbers or distributions" do
+      it "allows integers to be added" do
+        lambda{@mean.add 5}.should_not raise_error
+      end
+
+      it "allows floats to be added" do
+        lambda{@mean.add 3.4}.should_not raise_error
+      end
+
+      it "allows other Mean distributions to be added" do
+        mean2 = Accumulators::Mean.new
+        lambda{@mean.add mean2}.should_not raise_error
+      end
+
+      it "raises an ArgumentError if a string is added" do
+        lambda{@mean.add "1.5"}.should raise_error(ArgumentError)
+      end
+    end
+
+    context "correctness of int additions" do
+      it "should return count of 1 and mean of 5 when 5 is added" do
+        @mean.add(5)
+        @mean.count.should == 1
+        @mean.mean.should be_within(EPSILON).of(5)
+      end
+
+      it "should calculate the mean correctly for a set of integers" do
+        1.upto(10) {|i| @mean.add i}
+        @mean.count.should == 10
+        @mean.mean.should be_within(EPSILON).of((1..10).reduce(:+).to_f/10)
+      end
+
+      it "should calculate the mean correctly for a random set of 1000 integers" do
+        vals = []
+        1000.times do
+          vals << rand(100000)
+          @mean.add(vals.last)
+        end
+
+        @mean.mean.should be_within(EPSILON).of(vals.reduce(:+).to_f/vals.size)
+      end
+    end
+
+    context "correctness of float additions" do
+      it "should calculate the mean correctly for a set of floats" do
+        1.upto(10) {|i| @mean.add i+0.1}
+        @mean.count.should == 10
+        @mean.mean.should be_within(EPSILON).of((1..10).map{|i| i+0.1}.reduce(:+)/10)
+      end
+
+      it "should calculate the mean correctly for a random set of 1000 floats" do
+        vals = []
+        1000.times do
+          vals << rand * 1000000
+          @mean.add vals.last
+        end
+        @mean.mean.should be_within(EPSILON).of(vals.reduce(:+)/vals.size)
+      end
+    end
+
+    context "correctness of accumulator additions" do
+      it "should combine two means correctly" do
+        m2 = Accumulators::Mean.new
+        vals = []
+        500.times do
+          vals << rand * 1000000
+          @mean.add vals.last
+          vals << rand * 100000
+          m2.add vals.last
+        end
+        @mean.add(m2)
+        @mean.count.should == 1000
+        @mean.mean.should be_within(EPSILON).of(vals.reduce(:+)/vals.size)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'accumulators'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: accumulators
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gavin Heavyside
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-27 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: Statistical accumulators for Ruby
+email: gavin@heavyside.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- features/accumulators.feature
+- features/step_definitions/accumulators_steps.rb
+- features/support/env.rb
+- lib/accumulators.rb
+- lib/accumulators/count.rb
+- lib/accumulators/mean.rb
+- spec/accumulators/count_spec.rb
+- spec/accumulators/mean_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hgavin/accumulators
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2246303287397258855
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Statiscal accumulators for Ruby
+test_files: 
+- spec/accumulators/count_spec.rb
+- spec/accumulators/mean_spec.rb
+- spec/spec_helper.rb