means 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,13 @@
+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.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Nigel Lowry
+
+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,19 @@
+= means
+
+A very small gem to calculate the different kinds of mean in a data set.
+
+== Contributing to means
+ 
+* 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) 2011 Nigel Lowry. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+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 = "means"
+  gem.homepage = "http://github.com/nigel-lowry/means"
+  gem.license = "MIT"
+  gem.summary = %Q{Small gem to work out the arithmetic, harmonic and geometric means of a data set}
+  gem.description = %Q{Calculates the diferent kinds of mean for a data set. Also has methods to do this cumulatively given an accumulator rather than going over whole data set each time given a single new value}
+  gem.email = "nigel-lowry@ultra.eclipse.co.uk"
+  gem.authors = ["Nigel Lowry"]
+  # 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
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "means #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/Mean.rb

@@ -0,0 +1,59 @@
+require 'mathn'
+
+# Allows calculation of arithmetic, geometric and harmonic means.
+# Class methods allow the passing in of a data set. 
+# Alternatively an object can be created and elements can
+# be added with Mean#push
+class Mean
+
+  # Calculate the arithmetic mean of _data_
+  def Mean.arithmetic(data)
+    data.reduce(:+) / data.size unless data.empty?
+  end
+
+  # Calculate the geometric mean of _data_
+  def Mean.geometric(data)
+    data.reduce(:*) ** (1 / data.size) unless data.empty?
+  end
+
+  # Calculate the harmonic mean of _data_
+  def Mean.harmonic(data)
+    data.size / data.reduce(0) {|sum, element| sum += (1 / element)} unless data.empty?
+  end
+
+  # Remember the initial state. 
+  #
+  # If you are passing in an initial state:
+  # [arithmetic mean] needs :sum and :count
+  # [geometric mean] needs :product and :count.
+  # [harmonic mean] needs :sum_of_reciprocals and :count
+  def initialize(params={})
+    @sum                ||= params[:sum]                ||= 0
+    @sum_of_reciprocals ||= params[:sum_of_reciprocals] ||= 0
+    @product            ||= params[:product]            ||= 1
+    @count              ||= params[:count]              ||= 0
+  end
+
+  # Add _element_ to the data set
+  def push(element)
+    @sum += element
+    @sum_of_reciprocals += (1 / element)
+    @product *= element
+    @count += 1
+  end
+
+  # Calculate the arithmetic mean of the data set
+  def arithmetic_mean
+    @sum / @count unless @count == 0
+  end
+
+  # Calculate the geometric mean of the data set
+  def geometric_mean
+    @product ** (1 / @count) unless @count == 0
+  end
+
+  # Calculate the harmonic mean of the data set
+  def harmonic_mean
+    @count / @sum_of_reciprocals unless @count == 0
+  end
+end

data/means.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "means"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nigel Lowry"]
+  s.date = "2011-11-06"
+  s.description = "Calculates the diferent kinds of mean for a data set. Also has methods to do this cumulatively given an accumulator rather than going over whole data set each time given a single new value"
+  s.email = "nigel-lowry@ultra.eclipse.co.uk"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/Mean.rb",
+    "means.gemspec",
+    "spec/Mean_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/nigel-lowry/means"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Small gem to work out the arithmetic, harmonic and geometric means of a data set"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/Mean_spec.rb

@@ -0,0 +1,165 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Mean" do
+
+  describe "#arithmetic" do
+    it "should be nil for an empty array" do
+      Mean.arithmetic([]).should be_nil
+    end
+
+    it "should be the singleton element of a singleton array" do
+      element = 5.5
+      Mean.arithmetic([element]).should == element
+    end
+
+    it "should be the common value in an array when all values are equal" do
+      element = 5.5
+      Mean.arithmetic([element, element]).should == element
+    end
+
+    it "should be 1.5 for [1, 2]" do 
+      data = [1.0, 2.0]
+      Mean.arithmetic(data).should be_within(0.01).of(1.5)
+    end
+
+    it "should work with integers" do
+      data = [1, 2]
+      Mean.arithmetic(data).should be_within(0.01).of(1.5) 
+    end
+
+    it "should work with an int then a float" do
+      data = [1, 2.0]
+      Mean.arithmetic(data).should be_within(0.01).of(1.5) 
+    end
+
+    it "should work with a float then an int" do
+      data = [1.0, 2]
+      Mean.arithmetic(data).should be_within(0.01).of(1.5) 
+    end
+
+    it "should work with three numbers" do
+      data = [1, 2, 3]
+      Mean.arithmetic(data).should == 2
+    end
+  end
+
+  describe "#geometric" do
+    it "should be nil for an empty array" do
+      Mean.geometric([]).should be_nil
+    end
+
+    it "should be the singleton element of a singleton array" do
+      element = 5.5
+      Mean.geometric([element]).should == element
+    end
+
+    it "should be the common value in a when all values are equal" do
+      element = 5.5
+      Mean.geometric([element, element]).should == element
+    end
+
+    it "should be zero when there is even a single zero" do
+      data = [1.1, 2.2, 0.0]
+      Mean.geometric(data).should == 0
+    end
+
+    it "should be the square root of the product of two numbers" do
+      d1, d2 = 2, 8
+      data = [d1, d2]
+      Mean.geometric(data).should == 4
+    end
+
+    it "should be the cube root of the product of three numbers" do
+      d1, d2, d3 = 4, 1, 1.0 / 32.0
+      data = [d1, d2, d3]
+      Mean.geometric(data).should == 1.0 / 2.0
+    end
+  end
+
+  describe "#harmonic" do
+    it "should be nil for an empty array" do
+      Mean.harmonic([]).should be_nil
+    end
+
+    it "should be the singleton element of a singleton array" do
+        element = 5.5
+        Mean.harmonic([element]).should == element
+    end
+
+    it "should be the common value in a when all values are equal" do
+      element = 5.5
+      Mean.harmonic([element, element]).should == element
+    end
+
+    it "should be be according to the formula with two elements" do
+      d1, d2 = 1.0, 2.0
+      data = [d1, d2]
+      Mean.harmonic(data).should be_within(0.01).of((2.0 * d1 * d2) / (d1 + d2))
+    end
+
+    it "should be 12/7 for [1, 2, 4]" do
+      data = [1.0, 2.0, 4.0]
+      Mean.harmonic(data).should be_within(0.01).of(1.7142)
+    end
+
+    it "should be zero if there is even one zero" do 
+      data = [1.0, 2.0, 0.0]
+      Mean.harmonic(data).should == 0
+    end
+  end
+
+  describe "accumulators" do
+    before(:each) do
+      @m = Mean.new()
+    end
+
+    it "should accumulate the arithmetic mean" do
+      @m.arithmetic_mean.should be_nil
+      @m.push 1
+      @m.arithmetic_mean.should == 1
+      @m.push 2
+      @m.arithmetic_mean.should == 1.5
+      @m.push 3
+      @m.arithmetic_mean.should == 2
+    end
+
+    it "should accumulate the geometric mean" do
+      @m.geometric_mean.should be_nil
+      @m.push 2
+      @m.geometric_mean.should == 2
+      @m.push 8
+      @m.geometric_mean.should == 4
+    end
+
+    it "should accumulate the harmonic mean" do
+      @m.harmonic_mean.should be_nil
+      @m.push 1
+      @m.harmonic_mean.should == 1
+      @m.push 2
+      @m.harmonic_mean.should == 4.0 / 3.0
+    end
+  end
+
+  describe "initialising accumulator" do
+    it "should resurrect the arithmetic mean using the count and sum" do
+      m = Mean.new(count: 1, sum: 1)
+      m.arithmetic_mean.should == 1
+      m.push 2
+      m.arithmetic_mean.should == 1.5
+    end
+
+    it "should resurrect the geometric mean using the count and product" do
+      m = Mean.new(count: 1, product: 2)
+      m.geometric_mean.should == 2
+      m.push 8
+      m.geometric_mean.should == 4
+    end
+
+    it "should resurrect the harmonic mean using the count and sum of the reciprocals" do
+      m = Mean.new(count: 1, sum_of_reciprocals: 1)
+      m.harmonic_mean.should == 1
+      m.push 2
+      m.harmonic_mean.should == 4.0 / 3.0
+    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 'Mean'
+
+# 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,109 @@
+--- !ruby/object:Gem::Specification
+name: means
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nigel Lowry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70157793188260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70157793188260
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70157793187780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70157793187780
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70157793187300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70157793187300
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70157793186820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70157793186820
+description: Calculates the diferent kinds of mean for a data set. Also has methods
+  to do this cumulatively given an accumulator rather than going over whole data set
+  each time given a single new value
+email: nigel-lowry@ultra.eclipse.co.uk
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/Mean.rb
+- means.gemspec
+- spec/Mean_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nigel-lowry/means
+licenses:
+- MIT
+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: -1103619696357381530
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Small gem to work out the arithmetic, harmonic and geometric means of a data
+  set
+test_files: []