descriptive_statistics 1.1.5 → 2.5.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 36155709ef3b8ff6a6a38dd0335e3d0038fce127
-  data.tar.gz: 7aa6db66838780f71554af0917525ad2afb7d3a6
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWY4YTM5Y2MxOTc3Mzc5MWYzNzk1NjRmZjVlYzljYjY1MDQwYWIwMg==
+  data.tar.gz: !binary |-
+    ZTA4MTc2MmY4NjMzM2EzOTJmYTkyYTJjODk0NGE5MjM5NjU0OWMwNA==
 SHA512:
-  metadata.gz: 4cf3f0c2f98e7d526303c77e1a3242d7180461cbbbfeb4a868840c0acca50b875d14ce346a2f79aeb3f7aad950f7b78dd76053b715d067e02066042af5c933d0
-  data.tar.gz: 3571f09ba9a4d1b3b4c9ca60ee2c37e81225eaa1eb00e46f8d67d50d5cdc155f1b3bf771c507e84bb68679971ae1d4fc916a6dfb5152d286fa59dfcd24f1434d
+  metadata.gz: !binary |-
+    ODE0YmJlMWIwZTRkN2FhODU2MGU4MzZmMTJlMTBlNWJkNjE3MmIzNDlhZDIx
+    NDc2ZTRmMzNiYzU1OGEyNWFjZmE2MmJkNjNhMjUxYzdkOGRkNTc0YmQxZjky
+    OTE0ZTc1OGQwOTlmYWFlNGNmZmJhMmNmMGIxY2YxZTBlYTg4MTA=
+  data.tar.gz: !binary |-
+    NDNjZTg1OTQ4ZjJkMWQxNWU2ZGUwOThmZjM0MDdiMGI2MmM1NTg0OWZjMjNj
+    ZGVkNTBmYWIwN2M2NDZmYTI5MGNhYjBiODIwMzQ2ZGY2MTczZjE3MDQxNjQ3
+    YjY2ODIwNjUwMmRhZGUwMDZlZDA1YjVkYWViNjMxMWVmNDgyZGU=

data/lib/descriptive_statistics/class_methods.rb

@@ -0,0 +1,36 @@
+module DescriptiveStatistics
+
+  class << self
+
+    def empty_collection_default_value
+      @empty_collection_default_value
+    end
+
+    def empty_collection_default_value=(value)
+      @empty_collection_default_value = value
+      DescriptiveStatistics.instance_methods.each { |m| default_values[m] = value }
+    end
+
+    DescriptiveStatistics.instance_methods.each do |m|
+      define_method("#{m}_empty_collection_default_value") do
+        default_values[m]
+      end
+      define_method("#{m}_empty_collection_default_value=") do |value|
+        default_values[m] = value
+      end
+    end
+
+    private
+
+    def default_values
+      @default_values ||= {}
+    end
+
+  end
+
+  DescriptiveStatistics.instance_methods.each do |method|
+    module_function method
+    public method
+  end
+
+end

data/lib/descriptive_statistics/descriptive_statistics.rb

@@ -1,17 +1,17 @@
 module DescriptiveStatistics
-  def descriptive_statistics
-    return { :number => self.size.to_f,
-             :sum => self.sum,
-             :variance => self.variance,
-             :standard_deviation => self.standard_deviation,
-             :min => self.min,
-             :max => self.max,
-             :mean => self.mean,
-             :mode => self.mode,
-             :median => self.median,
-             :range => self.range,
-             :q1 => self.percentile(25),
-             :q2 => self.percentile(50),
-             :q3 => self.percentile(75) }
+  def descriptive_statistics(&block)
+    return { :number => self.number(&block),
+             :sum => self.sum(&block),
+             :variance => self.variance(&block),
+             :standard_deviation => self.standard_deviation(&block),
+             :min => self.min(&block),
+             :max => self.max(&block),
+             :mean => self.mean(&block),
+             :mode => self.mode(&block),
+             :median => self.median(&block),
+             :range => self.range(&block),
+             :q1 => self.percentile(25, &block),
+             :q2 => self.percentile(50, &block),
+             :q3 => self.percentile(75, &block) }
   end
 end

data/lib/descriptive_statistics/enumerable_extension.rb

@@ -1,11 +1,9 @@
 module Enumerable
   include DescriptiveStatistics
 
-  # This is necessary because otherwise objects which
-  # have already included Enumerable (such as Array) won't
-  # be able to access DescriptiveStatistics's methods.
-  # It is an evil hack though :-/
-  DescriptiveStatistics.instance_methods.each do |m|
-    define_method(m, DescriptiveStatistics.instance_method(m))
+  DescriptiveStatistics.instance_methods.each do |name|
+    method = DescriptiveStatistics.instance_method(name)
+    define_method(name, method)
   end
+
 end

data/lib/descriptive_statistics/mean.rb

@@ -1,5 +1,8 @@
 module DescriptiveStatistics
-  def mean
-    self.sum / self.number
-  end 
+  def mean(collection = self, &block)
+    values = Support::convert(collection, &block)
+    return DescriptiveStatistics.mean_empty_collection_default_value if values.empty?
+
+    values.sum / values.number
+  end
 end

data/lib/descriptive_statistics/median.rb

@@ -1,5 +1,8 @@
 module DescriptiveStatistics
-  def median
-    self.percentile(50)
-  end 
+  def median(collection = self, &block)
+    values = Support::convert(collection, &block)
+    return DescriptiveStatistics.median_empty_collection_default_value if values.empty?
+
+    values.percentile(50)
+  end
 end

data/lib/descriptive_statistics/mode.rb

@@ -1,5 +1,12 @@
 module DescriptiveStatistics
-  def mode
-    self.group_by { |e| e }.values.max_by(&:size).first
-  end 
+  def mode(collection = self, &block)
+    values = Support::extract(collection, &block)
+    return if values.to_a.empty?
+
+    values
+      .group_by { |e| e }
+      .values
+      .max_by(&:size)
+      .first
+  end
 end

data/lib/descriptive_statistics/number.rb

@@ -1,5 +1,7 @@
 module DescriptiveStatistics
-  def number
-    self.size.to_f
+  def number(collection = self, &block)
+    values = Support::extract(collection, &block)
+
+    values.to_a.size.to_f
   end
 end

data/lib/descriptive_statistics/percentile.rb

@@ -1,12 +1,14 @@
 module DescriptiveStatistics
-  def percentile(p)
-    sorted = self.sort
-    return sorted[-1].to_f if p == 100        
-    rank = p.to_f / 100.to_f * (self.number - 1) 
-    lrank = rank.floor
-    d = rank - lrank
-    lower = sorted[lrank].to_f
-    upper = sorted[lrank+1].to_f
-    lower + (upper - lower) * d
+  def percentile(p, collection = self, &block)
+    values = Support::convert(collection, &block)
+
+    return DescriptiveStatistics.percentile_empty_collection_default_value if values.empty?
+    return values.first if values.size == 1
+
+    values.sort!
+    return values.last if p == 100
+    rank = p / 100.0 * (values.size - 1)
+    lower, upper = values[rank.floor,2]
+    lower + (upper - lower) * (rank - rank.floor)
   end
 end

data/lib/descriptive_statistics/percentile_rank.rb

@@ -1,6 +1,9 @@
 module DescriptiveStatistics
   # percent of cases that are at or below a score
-  def percentile_rank(p)
-    return (((sort.rindex{ |x| x <= p} || -1.0) + 1.0)) / number * 100.0
+  def percentile_rank(p, collection = self, &block)
+    values = Support::convert(collection, &block)
+    return DescriptiveStatistics.percentile_rank_empty_collection_default_value if values.empty?
+
+    return (((values.sort.rindex { |x| x <= p } || -1.0) + 1.0)) / values.number * 100.0
   end
 end

data/lib/descriptive_statistics/range.rb

@@ -1,6 +1,8 @@
 module DescriptiveStatistics
-  def range
-    return 0 unless self.number > 0
-    self.max - self.min
-  end 
+  def range(collection = self, &block)
+    values = Support::convert(collection, &block)
+    return DescriptiveStatistics.range_empty_collection_default_value if values.empty?
+
+    values.max - values.min
+  end
 end

data/lib/descriptive_statistics/refinement.rb

@@ -0,0 +1,33 @@
+require "descriptive_statistics/safe"
+
+module DescriptiveStatistics
+
+  module Refinement
+
+    def self.new(*klasses)
+      refinement_module = Module.new
+
+      klasses.each do |klass|
+
+        refinement_module.instance_eval do
+
+          refine klass do
+
+            DescriptiveStatistics.instance_methods.each do |name|
+              method = DescriptiveStatistics.instance_method(name)
+              define_method(name, method)
+            end
+
+          end
+
+        end
+
+      end
+
+      return refinement_module
+
+    end
+
+  end
+
+end

data/lib/descriptive_statistics/safe.rb

@@ -1,3 +1,4 @@
+require "descriptive_statistics/support/convert"
 require 'descriptive_statistics/number.rb'
 require 'descriptive_statistics/sum.rb'
 require 'descriptive_statistics/mean.rb'
@@ -9,4 +10,6 @@ require 'descriptive_statistics/percentile.rb'
 require 'descriptive_statistics/percentile_rank.rb'
 require 'descriptive_statistics/range.rb'
 require 'descriptive_statistics/descriptive_statistics.rb'
+require 'descriptive_statistics/stats.rb'
+require 'descriptive_statistics/class_methods.rb'
 

data/lib/descriptive_statistics/standard_deviation.rb

@@ -1,5 +1,8 @@
 module DescriptiveStatistics
-  def standard_deviation
-    Math.sqrt(self.variance)
+  def standard_deviation(collection = self, &block)
+    values = Support::convert(collection, &block)
+    return DescriptiveStatistics.standard_deviation_empty_collection_default_value if values.empty?
+
+    Math.sqrt(values.variance)
   end
 end

data/lib/descriptive_statistics/stats.rb

@@ -0,0 +1,9 @@
+require 'delegate'
+
+module DescriptiveStatistics
+
+  class Stats < SimpleDelegator
+    include DescriptiveStatistics
+  end
+
+end

data/lib/descriptive_statistics/sum.rb

@@ -1,5 +1,8 @@
 module DescriptiveStatistics
-  def sum 
-    return self.inject(:+)
-  end 
+  def sum(collection = self, &block)
+    values = Support::convert(collection, &block)
+    return DescriptiveStatistics.sum_empty_collection_default_value if values.empty?
+
+    return values.reduce(:+)
+  end
 end

data/lib/descriptive_statistics/support/convert.rb

@@ -0,0 +1,43 @@
+require 'set'
+
+module DescriptiveStatistics
+
+  module Support
+
+    def self.convert(from_enumerable, &block)
+      extend to_float to_value(to_array(from_enumerable), &block)
+    end
+
+    def self.extract(from_enumerable, &block)
+      extend to_value(to_array(from_enumerable), &block)
+    end
+
+    private
+
+    def self.extend(enumerable)
+      enumerable.extend(DescriptiveStatistics)
+    end
+
+    def self.to_float(enumerable)
+      enumerable.map(&:to_f)
+    end
+
+    def self.to_value(enumerable, &block)
+      return enumerable unless block_given?
+      enumerable.map { |object| yield object }
+    end
+
+    def self.to_array(enumerable)
+      case enumerable
+      when Hash
+        enumerable.values.each
+      when Set
+        enumerable.to_a.each
+      else
+        enumerable.each
+      end
+    end
+
+  end
+
+end

data/lib/descriptive_statistics/variance.rb

@@ -1,6 +1,9 @@
 module DescriptiveStatistics
-  def variance
-    mean = self.mean
-    self.map{ |sample| (mean - sample) ** 2 }.sum / self.number
+  def variance(collection = self, &block)
+    values = Support::convert(collection, &block)
+    return DescriptiveStatistics.variance_empty_collection_default_value if values.empty?
+
+    mean = values.mean
+    values.map { |sample| (mean - sample) ** 2 }.reduce(:+) / values.number
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: descriptive_statistics
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 2.5.1
 platform: ruby
 authors:
 - Derrick Parkhurst
@@ -9,18 +9,21 @@ authors:
 - Daniel Farrell
 - Graham Malmgren
 - Guy Shechter
+- Charlie Egan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies: []
-description: Adds descriptive statistics methods to Enumerable for use on collections
+description: Adds descriptive statistics methods to Enumerable module for use on collections
+  or Numeric data
 email: derrick.parkhurst@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/descriptive_statistics.rb
+- lib/descriptive_statistics/class_methods.rb
 - lib/descriptive_statistics/descriptive_statistics.rb
 - lib/descriptive_statistics/enumerable_extension.rb
 - lib/descriptive_statistics/mean.rb
@@ -30,9 +33,12 @@ files:
 - lib/descriptive_statistics/percentile.rb
 - lib/descriptive_statistics/percentile_rank.rb
 - lib/descriptive_statistics/range.rb
+- lib/descriptive_statistics/refinement.rb
 - lib/descriptive_statistics/safe.rb
 - lib/descriptive_statistics/standard_deviation.rb
+- lib/descriptive_statistics/stats.rb
 - lib/descriptive_statistics/sum.rb
+- lib/descriptive_statistics/support/convert.rb
 - lib/descriptive_statistics/variance.rb
 homepage: https://github.com/thirtysixthspan/descriptive_statistics
 licenses:
@@ -44,17 +50,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Descriptive Statistics