sixarm_ruby_math_statistics 1.2.0

data/README.md

@@ -0,0 +1,88 @@
+# SixArm.com » Ruby » <br> Math Statistics
+
+* Docs: <http://sixarm.com/sixarm_ruby_math_statistics/doc>
+* Repo: <http://github.com/sixarm/sixarm_ruby_math_statistics>
+* Email: Joel Parker Henderson, <joel@sixarm.com>
+
+
+## Introduction
+
+Math statistics methods.
+
+See http://pallas.telperion.info/ruby-stats/
+
+For docs go to <http://sixarm.com/sixarm_ruby_math_statistics/doc>
+
+Want to help? We're happy to get pull requests.
+
+
+## Quickstart
+
+Install:
+
+    gem install sixarm_ruby_math_statistics
+
+Bundler:
+
+    gem "sixarm_ruby_math_statistics", "=1.2.0"
+
+Require:
+
+    require "sixarm_ruby_math_statistics"
+
+
+## High Security (Optional)
+
+To enable high security for all our gems:
+
+    wget http://sixarm.com/sixarm.pem
+    gem cert --add sixarm.pem
+    gem sources --add http://sixarm.com
+
+To install with high security:
+
+    gem install sixarm_ruby_ --test --trust-policy HighSecurity
+
+
+## Examples
+
+    require "sixarm_ruby_math_statistics"
+    [1,2].sum => 3
+    [1,2].mean => 1.5
+    [1,2].mean => 1.5
+    [1,2].variance => 0.25
+    [1,2].deviation => 0.5
+
+
+## Changes
+
+* 2012-03-14 1.1.0 Update docs, tests
+
+
+## License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU General Public License Version 2 (GPL 2)
+  * GNU Lesser General Public License (LGPL)
+  * MIT License
+  * Perl Artistic License
+  * Ruby License
+
+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.
+
+This license is for the included software that is created by SixArm;
+some of the included software may have its own licenses, copyrights, 
+authors, etc. and these do take precedence over the SixArm license.
+
+Copyright (c) 2005-2013 Joel Parker Henderson

data/Rakefile

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*.rb'
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.8

data/lib/sixarm_ruby_math_statistics.rb

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README
+=end
+
+
+module Enumerable
+
+
+  # Examples
+  #   [].sum => 0
+  #   [1].sum => 1
+  #   [1,2,3].sum => 5
+  #
+  # Example with default for empty
+  #   [].sum(99) => 99
+  #
+  # Example with block
+  #   [1,2,3].sum{|x| x*2} => 10
+  #
+  # This method is copied from rails to ensure compatibility.
+  
+  def sum(identity = 0, &block)
+    return identity unless size > 0
+    if block_given?
+      map(&block).sum
+    else
+      inject { |sum, element| sum + element }
+    end
+  end
+
+
+  # Examples
+  #   [].mean => nil
+  #   [1].mean => 1.0
+  #   [1,2].mean => 1.5
+  #   [1,2,9].mean => 4.0
+  
+  def mean
+    size==0 ? nil : sum.to_f / size
+  end
+
+
+  # Examples
+  #  [].median => nil
+  #  [1].median => 1.0
+  #  [1,2].median => 1.5
+  #  [1,2,9].mean => 2.0
+  
+  def median
+    size==0 ? nil : ((0==self.size%2) ? sort[size/2-1,2].mean : sort[self.size/2].to_f)
+  end
+  
+
+  # Examples
+  #  [].sum_of_squares => 0
+  #  [1].sum_of_squares => 1.0
+  #  [1,2].sum_of_squares => 5.0
+  #  [1,2,3].sum_of_squares => 14.0
+  
+  def sum_of_squares
+    size==0 ? 0 : inject(0){|sum,x|sum+(x*x)}
+  end
+  
+
+  # Examples
+  #   [].variance => nil
+  #   [1].variance =>  0.0
+  #   [1,2].variance => 0.25
+  #   [1,2,3,4].variance => 1.25
+  
+  def variance
+    size==0 ? nil : ( m=mean and sum_of_squares.to_f/size - m*m )
+  end
+  
+  
+  # Examples
+  #   [].deviation => nil
+  #   [1].deviation => 0.0
+  #   [1,2].deviation => 0.5
+  #   [2,2,4,2,2].deviation => 0.8
+  
+  def deviation
+    size==0 ? nil : Math::sqrt(variance)
+  end
+
+end
+

data/test/sixarm_ruby_math_statistics_test.rb

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+require 'simplecov'
+SimpleCov.start
+require 'sixarm_ruby_math_statistics'
+
+describe Enumerable do
+
+  describe "#sum" do
+
+    it "[] => 0, which tests edge case" do
+      [].sum.must_equal 0
+    end
+
+    it "[1] => 1, which tests minimal case" do
+      [1].sum.must_equal 1
+    end
+
+    it "[1, 2] => 3, which tests a couple args" do
+      [1, 2].sum.must_equal 3
+    end
+
+    it "[1, 2, 3] => 6, which tests a few args" do
+      [1,2,3].sum.must_equal 6
+    end
+
+  end
+
+  describe "#mean" do
+
+    it "[] => nil, which tests edge case" do
+      [].mean.must_equal nil
+    end
+
+    it "[1] => 1.0, which tests minimal case" do
+      [1].mean.must_equal 1.0
+    end
+
+    it "[1, 2] => 1.5, which tests a couple args" do
+      [1,2].mean.must_equal 1.5
+    end
+
+    it "[1, 2, 9] => 4.0, which tests a few args and distinguishes mean and median" do
+      [1,2,9].mean.must_equal 4.0
+    end
+
+  end
+
+  describe "#median" do
+
+    it "[] => nil, which tests edge case" do
+      [].median.must_equal nil
+    end
+
+    it "[1] => 1.0, which tests minimal case" do
+      [1].median.must_equal 1.0
+    end
+
+    it "[1, 2] => 1.5, which tests a couple args" do
+      [1,2].median.must_equal 1.5
+    end
+
+    it "[1, 2, 9] => 2.0, which tests a few args and distiguishes mean from median" do
+      [1,2,9].median.must_equal 2.0
+    end
+
+  end
+
+  describe "#sum_of_squares" do
+
+    it "[] => 0, which tests edge case" do
+      [].sum_of_squares.must_equal []
+    end
+
+    it "[1] => 1.0, which tests minimal case" do
+      [1].sum_of_squares.must_equal 1.0
+    end
+
+    it "[1, 2] => 5.0, which tests a couple args" do
+      [1,2].sum_of_squares.must_equal 5.0
+    end
+
+    it "[1,2,3] => 14.0, which tests few args" do
+      [1,2,3].sum_of_squares.must_equal 14.0
+    end
+
+  end
+
+  describe "#variance" do
+
+    it "[] => 0, which tests edge case" do
+      [].variance.must_equal nil
+    end
+
+   it "[1] => 0, which tests minimal case" do
+      [1].variance.must_equal 0.0
+    end
+
+   it "[1, 2] => 0.25, which tests a couple args" do
+      [1,2].variance.must_equal 0.25
+    end
+
+    it "[1,2,3,4] => 1.25, which tests a few args" do
+      [1,2,3,4].variance.must_equal 1.25
+    end
+
+  end
+
+  describe "#deviation" do
+
+    it "[] => 0, which tests edge case" do
+      [].deviation.must_equal 0
+    end
+
+   it "[1] => 0, which tests minimal case" do
+      [1].deviation.must_equal 0.0
+    end
+
+    it "[1, 2] => 0.25, which tests a couple args" do
+      [1,2].deviation.must_equal 0.5
+    end
+
+    it "[2, 2, 4, 2, 2] => 0.8 with delta 0.001, which tests a small delta" do
+      [2,2,4,2,2].deviation.must_equal 0.8 # TODO delta 0.001
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: sixarm_ruby_math_statistics
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+  prerelease: 
+platform: ruby
+authors:
+- SixArm
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURCRENDQW0yZ0F3SUJB
+  Z0lKQUtQd0VFVFU1YkhvTUEwR0NTcUdTSWIzRFFFQkJRVUFNR0F4Q3pBSkJn
+  TlYKQkFZVEFsVlRNUk13RVFZRFZRUUlFd3BEWVd4cFptOXlibWxoTVJZd0ZB
+  WURWUVFIRXcxVFlXNGdSbkpoYm1OcApjMk52TVE4d0RRWURWUVFLRXdaVGFY
+  aEJjbTB4RXpBUkJnTlZCQU1UQ25OcGVHRnliUzVqYjIwd0hoY05NVEF4Ck1q
+  RXpNak15TnpFeldoY05NVE13T1RBNE1qTXlOekV6V2pCZ01Rc3dDUVlEVlFR
+  R0V3SlZVekVUTUJFR0ExVUUKQ0JNS1EyRnNhV1p2Y201cFlURVdNQlFHQTFV
+  RUJ4TU5VMkZ1SUVaeVlXNWphWE5qYnpFUE1BMEdBMVVFQ2hNRwpVMmw0UVhK
+  dE1STXdFUVlEVlFRREV3cHphWGhoY20wdVkyOXRNSUdmTUEwR0NTcUdTSWIz
+  RFFFQkFRVUFBNEdOCkFEQ0JpUUtCZ1FDOTRtRDlKRHdCc3Vuc09JMFZSM0NY
+  WGJPV2c5Y1dhV2Npd0Z5Sk5GaU03QTlJOEtQTGZYVXcKUUM0Y3pVZTVadUc0
+  V0h2aW5yV2hrckNLKzFkV0Jxb0VDbHhkRi9Gb0tPNWErdG9uR0Nqam1meTgx
+  Sm1Gamp5eAplVHNqc0h5dncrUWlrOWtwZjlhajYrcG5rTnJWc3dnTkhWZWEy
+  bzl5YWJiRWlTNlZTZUpXb1FJREFRQUJvNEhGCk1JSENNQjBHQTFVZERnUVdC
+  QlF6UEp0cW1TZ2M1M2VETjdhU3pEUXdyOVRBTERDQmtnWURWUjBqQklHS01J
+  R0gKZ0JRelBKdHFtU2djNTNlRE43YVN6RFF3cjlUQUxLRmtwR0l3WURFTE1B
+  a0dBMVVFQmhNQ1ZWTXhFekFSQmdOVgpCQWdUQ2tOaGJHbG1iM0p1YVdFeEZq
+  QVVCZ05WQkFjVERWTmhiaUJHY21GdVkybHpZMjh4RHpBTkJnTlZCQW9UCkJs
+  TnBlRUZ5YlRFVE1CRUdBMVVFQXhNS2MybDRZWEp0TG1OdmJZSUpBS1B3RUVU
+  VTViSG9NQXdHQTFVZEV3UUYKTUFNQkFmOHdEUVlKS29aSWh2Y05BUUVGQlFB
+  RGdZRUFvb0VleFAvb1BhbTFUUDcxU3l1aHhNYit1VHJaYlNRZQpqVkIrRXhS
+  d1dhZEd3YU5QVUE1NmQzOXF3YXZ3UCtpdSszSnBlb25OTVZ2YldYRjVuYUNY
+  L2RORkllUkVIekVSClpEUlFZTXFydTlURU1uYTZIRDl6cGNzdEY3dndUaEdv
+  dmxPUSszWTZwbFE0bk16aXBYY1o5VEhxczY1UElMMHEKZWFid3BDYkFvcG89
+  Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
+date: 2012-03-17 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: sixarm@sixarm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- Rakefile
+- README.md
+- VERSION
+- lib/sixarm_ruby_math_statistics.rb
+- test/sixarm_ruby_math_statistics_test.rb
+homepage: http://sixarm.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: ! 'SixArm Ruby Gem: Math statitics methods for sum, mean, median, mode, variance,
+  deviation, etc.'
+test_files:
+- test/sixarm_ruby_math_statistics_test.rb
+has_rdoc: true