utilities 0.0.16 → 0.0.17

data/README.md

@@ -77,33 +77,58 @@ Usage
 
         48.percentage_of(50) #=> 96
 
-##### Utilities
+#### Utilities
 * Statistics
 
     This module is intended to provide basic statistic functionnalities to numeric arrays. You may either
     call [].to_stats or extend an existing array with Utilities::Statistics module.
 
-    ** sum
+    * sum
     
-        [1,2,3].sum #=> 6
+            [1,2,3].sum #=> 6
     
-    ** squares
+    * squares
         
-        [1,2,3].squares #=> [1,4,9]
+            [1,2,3].squares #=> [1,4,9]
     
-    ** sqrts
+    * sqrts
     
-        [9,16,25].sqrts #=> [3,4,5]
+            [9,16,25].sqrts #=> [3,4,5]
     
-    ** mean
+    * mean
     
-        [1,2,3,4,5].mean #=> 3
+            [1,2,3,4,5].mean #=> 3
     
-    ** frequences
+    * frequences
     
-        [1,1,2,3,3,3,4].frequences #=> {1=>2, 2=>1, 3=>3, 4=>1}
+            [1,1,2,3,3,3,4].frequences #=> {1=>2, 2=>1, 3=>3, 4=>1}
     
-    ** modes
+    * modes
     
-        [1,2,3,3,4,4,4,5].modes #=> {4=>3}
+            [1,2,3,3,4,4,4,5].modes #=> {4=>3}
+    
+    * statistics
+            [1,2,3,4,5].statistics #=> {
+              :first=>1,
+              :last=>5,
+              :size=>5,
+              :sum=>15,
+              :squares=>[1, 4, 9, 16, 25],
+              :sqrts=>[1.0, 1.4142135623730951, 1.7320508075688772, 2.0, 2.23606797749979],
+              :min=>1,population sample  variance
+              :max=>5,
+              :mean=>3.0,
+              :frequences=>{1=>1, 2=>1, 3=>1, 4=>1, 5=>1},
+              :variance=>2.5,
+              :standard_deviation=>1.5811388300841898,
+              :population_variance=>2.0,
+              :population_standard_deviation=>1.4142135623730951,
+              :modes=>{1=>1, 2=>1, 3=>1, 4=>1, 5=>1},
+              :ranks=>[0.0, 1.0, 2.0, 3.0, 4.0],
+              :median=>3,
+              :midrange=>3.0,
+              :statistical_range=>4,
+              :quartiles=>[1.5, 3, 4.5],
+              :interquartile_range=>3.0
+            }
 

data/lib/utilities/hash.rb

@@ -15,4 +15,9 @@ class Hash
   def symbolize_keys
     collect_keys{ |k| k.to_sym }
   end
+  
+  # Returns a new hash where all keys have been stringified
+  def stringify_keys
+    collect_keys{ |k| k.to_s }
+  end
 end

data/lib/utilities/utilities.rb

@@ -61,16 +61,16 @@ module Utilities
     end
     
     # Return the variance of self
-    def variance
-      m = mean
-      inject(0) { |v, x| v += (x - m) ** 2 }
+    def variance( population = false )
+      m = mean.to_f
+      collect{|v| (v - mean).square  }.to_stats.sum / (size - (population ? 0 : 1))
     end
     
     # Return the (sample|population) standard deviation of self
     # If population is set to true, then we consider the dataset as the complete population
     # Else, we consider the dataset as a sample, so we use the sample standard deviation (size - 1)
     def standard_deviation( population = false )
-      size > 1 ? Math.sqrt( variance / ( size - ( population ? 0 : 1 ) ) ) : 0.0
+      size > 1 ? Math.sqrt( variance( population ) ) : 0.0
     end
     alias_method :std_dev, :standard_deviation
     
@@ -142,12 +142,16 @@ module Utilities
         :last => self.last,
         :size => self.size,
         :sum => self.sum,
+        :squares => self.squares,
+        :sqrts => self.sqrts,
         :min => self.min,
         :max => self.max,
         :mean => self.mean,
         :frequences => self.frequences,
         :variance => self.variance,
         :standard_deviation => self.standard_deviation,
+        :population_variance => self.variance(true),
+        :population_standard_deviation => self.standard_deviation(true),
         :modes => self.modes,
         
         # Need to be sorted...

data/lib/version.rb

@@ -1,7 +1,7 @@
 class Utilities
   MAJOR = 0
   MINOR = 0
-  BUILD = 16
+  BUILD = 17
 
   VERSION = "#{MAJOR}.#{MINOR}.#{BUILD}"
 end

data/test/test_utilities.rb

@@ -48,6 +48,10 @@ describe Hash do
   it "#symbolize_keys should returns a new hash where all keys have been symbolized" do
     {"a"=>1, "b"=>2, "c"=>3}.symbolize_keys.should == {:a=>1, :b=>2, :c=>3}
   end
+  
+  it "#stringify_keys should returns a new hash where all keys have been stringified" do
+    {:a=>1, :b=>2, :c=>3}.stringify_keys.should == {"a"=>1, "b"=>2, "c"=>3}
+  end
 end
 
 describe Kernel do
@@ -125,3 +129,31 @@ describe Range do
     (1...5).overlap?(5..10).should == false
   end
 end
+
+describe Utilities::Statistics do
+  it "#statistics should returns a hash with all statistics included" do
+    [1,2,3,4,5].to_stats.statistics.should == {
+      :first=>1,
+      :last=>5,
+      :size=>5,
+      :sum=>15,
+      :squares=>[1, 4, 9, 16, 25],
+      :sqrts=>[1.0, 1.4142135623730951, 1.7320508075688772, 2.0, 2.23606797749979],
+      :min=>1,population sample  variance
+      :max=>5,
+      :mean=>3.0,
+      :frequences=>{1=>1, 2=>1, 3=>1, 4=>1, 5=>1},
+      :variance=>2.5,
+      :standard_deviation=>1.5811388300841898,
+      :population_variance=>2.0,
+      :population_standard_deviation=>1.4142135623730951,
+      :modes=>{1=>1, 2=>1, 3=>1, 4=>1, 5=>1},
+      :ranks=>[0.0, 1.0, 2.0, 3.0, 4.0],
+      :median=>3,
+      :midrange=>3.0,
+      :statistical_range=>4,
+      :quartiles=>[1.5, 3, 4.5],
+      :interquartile_range=>3.0
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utilities
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
   prerelease: 
 platform: ruby
 authors: