means 1.1.0 → 1.2.0

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/means.rb

@@ -8,23 +8,23 @@ class Mean
 
   # Calculate the arithmetic mean
   # @param [Array<Numeric>] data the data values
-  # @return [Numeric] the arithmetic mean
+  # @return [Numeric, nil] the arithmetic mean or nil if there is no data
   def Mean.arithmetic(data)
     data.reduce(:+) / data.size unless data.empty?
   end
 
   # Calculate the geometric mean
   # @param (see Mean.arithmetic)
-  # @return [Numeric] the geometric mean
+  # @return [Numeric, nil] the geometric mean or nil if there is no data or any elements are zero or negative
   def Mean.geometric(data)
-    data.reduce(:*) ** (1 / data.size) unless data.empty?
+    data.reduce(:*) ** (1 / data.size) unless data.empty? or includes_zero_or_negative? data
   end
 
   # Calculate the harmonic mean
   # @param (see Mean.arithmetic)
-  # @return [Numeric] the harmonic mean
+  # @return [Numeric, nil] the harmonic mean or nil if there is no data or any elements are zero or negative
   def Mean.harmonic(data)
-    data.size / data.reduce(0) {|sum, element| sum += (1 / element)} unless data.empty?
+    data.size / data.reduce(0) {|sum, element| sum += (1 / element)} unless data.empty? or includes_zero_or_negative? data
   end
 
   # Remember the initial state. 
@@ -34,37 +34,63 @@ class Mean
   # [geometric mean] needs `:product` and `:count`
   # [harmonic mean] needs `:sum_of_reciprocals` and `:count`
   # @param [Hash{Symbol => Numeric}]
+  # @raise if `:count` is negative
+  # @raise if `:sum_of_reciprocals` is negative
+  # @raise if `:product` is negative
   def initialize(params={})
+    raise_error_for_negative params, :count
+    raise_error_for_negative params, :sum_of_reciprocals
+    raise_error_for_negative params, :product
+
     @sum                ||= params[:sum]                ||= 0
     @sum_of_reciprocals ||= params[:sum_of_reciprocals] ||= 0
     @product            ||= params[:product]            ||= 1
     @count              ||= params[:count]              ||= 0
+    @includes_zero_or_negative = false
   end
 
   # Add element to the data set
   # @param [Numeric] element the element to add
   def push(element)
+    if Mean.zero_or_negative? element
+      @includes_zero_or_negative = true
+    end
+
     @sum += element
-    @sum_of_reciprocals += (1 / element)
-    @product *= element
+    @sum_of_reciprocals += (1 / element) unless @includes_zero_or_negative
+    @product *= element unless @includes_zero_or_negative
     @count += 1
   end
 
   # Calculate the arithmetic mean
-  # @return [Numeric] the arithmetic mean
+  # @return [Numeric, nil] the arithmetic mean or nil if there is no data
   def arithmetic_mean
     @sum / @count unless @count.zero?
   end
 
   # Calculate the geometric mean
-  # @return [Numeric] the geometric mean
+  # @return [Numeric, nil] the geometric mean or nil if there is no data or any elements are zero or negative
   def geometric_mean
-    @product ** (1 / @count) unless @count.zero?
+    @product ** (1 / @count) unless @count.zero? or @includes_zero_or_negative
   end
 
   # Calculate the harmonic mean
-  # @return [Numeric] the harmonic mean
+  # @return [Numeric, nil] the harmonic mean or nil if there is no data or any elements are zero or negative
   def harmonic_mean
-    @count / @sum_of_reciprocals unless @count.zero?
+    @count / @sum_of_reciprocals unless @count.zero? or @includes_zero_or_negative
   end
+
+  private 
+
+    def Mean.includes_zero_or_negative? data
+      data.any? { |element| zero_or_negative? element }
+    end
+
+    def Mean.zero_or_negative? element
+      element <= 0
+    end
+
+    def raise_error_for_negative params, key 
+      raise %{cannot have negative "#{key.to_s}" of "#{params[key]}"} if params.has_key? key and params[key] < 0
+    end
 end

data/means.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "means"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nigel Lowry"]
-  s.date = "2012-03-21"
+  s.date = "2012-04-12"
   s.description = "Calculates the different means for a data set (arithmetic, geometric and harmonic)."
   s.email = "nigel-lowry@ultra.eclipse.co.uk"
   s.extra_rdoc_files = [

data/spec/means_spec.rb

@@ -20,9 +20,14 @@ end
 
 shared_examples_for "non-arithmetic means" do
   [:geometric, :harmonic].each do |mean|
-    it "is zero when there are any zeroes" do
+    it "is nil when there are any zeroes" do
       data = [1.1, 2.2, 0.0]
-      Mean.send(mean, data).should == 0
+      Mean.send(mean, data).should be_nil
+    end
+
+    it "is nil when there are any negative numbers" do
+      data = [1, -1]
+      Mean.send(mean, data).should be_nil
     end
   end
 end
@@ -56,6 +61,16 @@ describe "Mean" do
       data = [1, 2, 3]
       Mean.arithmetic(data).should == 2
     end
+
+    it "works with zero" do
+      data = [0, 2]
+      Mean.arithmetic(data).should == 1
+    end
+
+    it "works with negative numbers" do
+      data = [-1, 3]
+      Mean.arithmetic(data).should == 1
+    end
   end
 
   describe ".geometric" do
@@ -107,26 +122,52 @@ describe "Mean" do
         @m.arithmetic_mean.should == 1.5
         @m.push 3
         @m.arithmetic_mean.should == 2
+        @m.push 0
+        @m.arithmetic_mean.should == 1.5
       end
     end
 
     describe "#geometric_mean" do
-      it "accumulates the geometric mean" do
+      it "accumulates the geometric mean until zero" do
+        @m.geometric_mean.should be_nil
+        @m.push 2
+        @m.geometric_mean.should == 2
+        @m.push 8
+        @m.geometric_mean.should == 4
+        @m.push 0
+        @m.geometric_mean.should be_nil
+      end
+
+      it "accumulates the geometric mean until negative" do
         @m.geometric_mean.should be_nil
         @m.push 2
         @m.geometric_mean.should == 2
         @m.push 8
         @m.geometric_mean.should == 4
+        @m.push -1
+        @m.geometric_mean.should be_nil
       end
     end
 
     describe "#harmonic_mean" do
-      it "accumulates the harmonic mean" do
+      it "accumulates the harmonic mean until zero" 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
+        @m.push 0
+        @m.harmonic_mean.should be_nil
+      end
+
+      it "accumulates the harmonic mean until negative" 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
+        @m.push -1
+        @m.harmonic_mean.should be_nil
       end
     end
   end
@@ -152,5 +193,17 @@ describe "Mean" do
       m.push 2
       m.harmonic_mean.should == 4.0 / 3.0
     end
+
+    it "rejects a negative count" do
+      lambda { Mean.new(count: -1) }.should raise_error
+    end
+
+    it "rejects negative sum of reciprocals" do
+      lambda { Mean.new(sum_of_reciprocals: -1) }.should raise_error
+    end
+
+    it "rejects negative product" do
+      lambda { Mean.new(product: -1) }.should raise_error
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: means
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-21 00:00:00.000000000 Z
+date: 2012-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70238701358200 !ruby/object:Gem::Requirement
+  requirement: &70325868075600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70238701358200
+  version_requirements: *70325868075600
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70238701356180 !ruby/object:Gem::Requirement
+  requirement: &70325868073840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.7.4
   type: :development
   prerelease: false
-  version_requirements: *70238701356180
+  version_requirements: *70325868073840
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70238701353120 !ruby/object:Gem::Requirement
+  requirement: &70325868072040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70238701353120
+  version_requirements: *70325868072040
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70238701415900 !ruby/object:Gem::Requirement
+  requirement: &70325868132480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70238701415900
+  version_requirements: *70325868132480
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70238701415140 !ruby/object:Gem::Requirement
+  requirement: &70325868131760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70238701415140
+  version_requirements: *70325868131760
 description: Calculates the different means for a data set (arithmetic, geometric
   and harmonic).
 email: nigel-lowry@ultra.eclipse.co.uk
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3343725683295383752
+      hash: 2648056903560015944
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: