magic_numbers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b3ced15a7b66249d77826c9510e1aec7a734a77
+  data.tar.gz: ebc70856bfac4d0a725b6dd10220e265a50f7ed8
+SHA512:
+  metadata.gz: d1486a6fcc2272d534fc3df4079093b7f725a75b2187b8c92b1139fa7ac1188d8b2db4e72507fb73035971b7e23ea147e6646316499963d73de32db8eb0e80e6
+  data.tar.gz: b0a51eb9ba078e97dd161c3593fe0ab4048b7e6c7daf96773ba978ad50ec38fac9549026f828a808eb02f2308203a9ac757f7fed64838581eae7118bd383e032

data/.gitignore

@@ -0,0 +1,6 @@
+.ruby-gemset
+.ruby-version
+.rspec
+Gemfile.lock
+todo.txt
+doc/

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Fernando Rodrigues da Silva
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+MagicNumbers
+============
+
+Install
+=======
+Add this line to your application's Gemfile:
+```ruby
+gem 'magic_numbers'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install magic_numbers
+```
+
+Usage
+=====
+
+Contributing
+============
+
+Licence
+=======
+MIT

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/magic_numbers.rb

@@ -0,0 +1,6 @@
+require "magic_numbers/version"
+require "magic_numbers/summary/all"
+
+module MagicNumbers
+
+end

data/lib/magic_numbers/summary.rb

@@ -0,0 +1,113 @@
+module MagicNumbers
+  module Summary
+    # Check if all elements are numbers.
+    #
+    # @example
+    #   [1, 2, 3].numeric? #=> True
+    #   ["a", 5].numeric?  #=> False
+    def numeric?
+      all? { |x| x.is_a?(Numeric) }
+    end
+
+    # Sum of all elements.
+    #
+    # @example
+    #   [1, 2, 3].sum #=> 6
+    #   [].sum        #=> nil
+    #   ["a", 5].sum  #=> TypeError
+    #
+    # @raise [TypeError] When collection includes a non Numeric type
+    # @return [Numeric] The sum of all objects
+    def sum
+      if numeric?
+        reduce(:+)
+      else
+        raise TypeError, "collection must include only Numeric types"
+      end
+    end
+
+    # Arithmetic mean
+    #
+    # @example
+    #   [1, 2, 3, 4].mean #=> 2.5
+    #   [].mean           #=> nil
+    #   ["a", 5].mean     #=> TypeError
+    #
+    # @see http://en.wikipedia.org/wiki/Arithmetic_mean Wikipedia: Arithmetic Mean
+    # @raise [TypeError] When collection includes a non Numeric type
+    # @return [Numeric] The mean
+    def mean
+      return nil unless any?
+      sum / size.to_f
+    end
+
+    # A measure of the expected deviation from the mean.
+    #
+    # @example
+    #   [2, 3, 4, 5].var      #=> 1.25
+    #   [1, 4, 5, 8].var      #=> 6.25
+    #   [2, 3, 6, 12].var(1)  #=> 20.25
+    #   [].var                #=> nil
+    #   ["a", 5].var          #=> TypeError
+    #   [2, 3, 6, 12].var(-1) #=> ArgumentError
+    #   [2, 3, 6, 12].var(4)  #=> ArgumentError
+    #
+    # @see http://en.wikipedia.org/wiki/Variance Wikipedia: Variance
+    # @see http://en.wikipedia.org/wiki/Degrees_of_freedom_%28statistics%29 Wikipedia: Degrees of Freedom
+    # @raise [TypeError] When collection includes a non Numeric type
+    # @raise [ArgumentError] When degress of freedom is not between (0..collection_size - 1)
+    # @return [Numeric] The population variance
+    def variance(degrees_of_freedom = 0)
+      l_mean, l_size = mean, size
+      msg = "degrees_of_freedom must be greater or equal to zero and lesser than collection size"
+
+      return nil unless l_mean
+      raise ArgumentError, msg unless (0...l_size) === degrees_of_freedom
+
+      squares = map { |x| (x - mean) ** 2 }
+      squares.sum / (l_size - degrees_of_freedom)
+    end
+    alias :var :variance
+
+    # A statistic that measures how spread out a set of data is.
+    #
+    # @example
+    #   [1, 4, 5, 8].sd      #=> 2.5
+    #   [3, 4, 7, 12].sd     #=> 3.5
+    #   [2, 3, 6, 12].sd(1)  #=> 4.5
+    #   [].sd                #=> nil
+    #   ["a", 5].sd          #=> TypeError
+    #   [2, 3, 6, 12].sd(-1) #=> ArgumentError
+    #   [2, 3, 6, 12].sd(4)  #=> ArgumentError
+    #
+    # @see http://en.wikipedia.org/wiki/Standard_deviation Wikipedia: Standard Deviation
+    # @see http://en.wikipedia.org/wiki/Degrees_of_freedom_%28statistics%29 Wikipedia: Degrees of Freedom
+    # @raise [TypeError] When collection includes a non Numeric type
+    # @raise [ArgumentError] When degress of freedom is not between (0..collection_size - 1)
+    # @return [Numeric] The population standard deviation
+    def standard_deviation(degrees_of_freedom = 0)
+      return nil unless l_variance = variance(degrees_of_freedom)
+      Math.sqrt(l_variance)
+    end
+    alias :sd :standard_deviation
+
+    # The difference between the minimum and the maximum values.
+    #
+    # @example
+    #   [19, 4, 5, 8].range #=> 15
+    #   [].range            #=> nil
+    #   ["a", 5].range      #=> TypeError
+    #
+    # @see http://en.wikipedia.org/wiki/Range_(statistics) Wikipedia: Range
+    # @raise [TypeError] When collection includes a non Numeric type
+    # @return [Numeric] The range
+    def range
+      return nil unless any?
+      if numeric?
+        max - min
+      else
+        raise TypeError, "collection must include only Numeric types"
+      end
+    end
+  end
+end

data/lib/magic_numbers/summary/all.rb

@@ -0,0 +1,3 @@
+require 'magic_numbers/summary/array'
+require 'magic_numbers/summary/set'
+require 'magic_numbers/summary/matrix'

data/lib/magic_numbers/summary/array.rb

@@ -0,0 +1,5 @@
+require 'magic_numbers/summary'
+
+class Array
+  include MagicNumbers::Summary
+end

data/lib/magic_numbers/summary/matrix.rb

@@ -0,0 +1,6 @@
+require 'matrix'
+require 'magic_numbers/summary'
+
+class Vector
+  include MagicNumbers::Summary
+end

data/lib/magic_numbers/summary/set.rb

@@ -0,0 +1,6 @@
+require 'set'
+require 'magic_numbers/summary'
+
+class Set
+  include MagicNumbers::Summary
+end

data/lib/magic_numbers/version.rb

@@ -0,0 +1,3 @@
+module MagicNumbers
+  VERSION = "0.0.1"
+end

data/magic_numbers.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magic_numbers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "magic_numbers"
+  spec.version       = MagicNumbers::VERSION
+  spec.authors       = ["Fernando Rodrigues"]
+  spec.email         = ["fernandors87@gmail.com"]
+  spec.summary       = %q{Ruby data analysis library}
+  spec.description   = %q{Ruby data analysis library}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "rspec", "~> 2.14", ">= 2.14.1"
+  spec.add_development_dependency "yard", "~> 0.8", ">= 0.8.7.3"
+end

data/spec/magic_numbers/summary_spec.rb

@@ -0,0 +1,61 @@
+require 'magic_numbers/summary/all'
+
+describe MagicNumbers::Summary do
+  shared_examples_for 'a statistical summary' do
+    describe '#sum' do
+      it { expect(collection.sum).to eq 0 }
+      it { expect(empty.sum).to be_nil }
+      it { expect { nan.sum }.to raise_error(TypeError) }
+    end
+
+    describe '#numeric?' do
+      it { expect(collection).to be_numeric }
+      it { expect(nan).not_to be_numeric }
+    end
+
+    describe '#mean' do
+      it { expect(collection.mean).to eq 0 }
+      it { expect(empty.mean).to be_nil }
+      it { expect { nan.mean }.to raise_error(TypeError) }
+    end
+
+    describe '#variance' do
+      it { expect { collection.variance(-1) }.to raise_error(ArgumentError) }
+      it { expect(collection.variance).to be_within(10.0).of(0.00000001) }
+      it { expect(collection.variance(2)).to be_within(12.22222222).of(0.00000001) }
+      it { expect { collection.variance(collection.size) }.to raise_error(ArgumentError) }
+      it { expect(empty.variance).to be_nil }
+      it { expect { nan.variance }.to raise_error(TypeError) }
+    end
+
+    describe '#standard_deviation' do
+      it { expect { collection.standard_deviation(-1) }.to raise_error(ArgumentError) }
+      it { expect(collection.standard_deviation).to be_within(3.16227766).of(0.00000001) }
+      it { expect(collection.standard_deviation(2)).to be_within(3.49602949).of(0.00000001) }
+      it { expect { collection.standard_deviation(collection.size) }.to raise_error(ArgumentError) }
+      it { expect(empty.standard_deviation).to be_nil }
+      it { expect { nan.standard_deviation }.to raise_error(TypeError) }
+    end
+  end
+
+  describe Array do
+    let(:collection) { (-5..5).to_a }
+    let(:empty) { [] }
+    let(:nan) { [1, "2"] }
+    it_behaves_like 'a statistical summary'
+  end
+
+  describe Set do
+    let(:collection) { Set.new((-5..5).to_a) }
+    let(:empty) { Set.new }
+    let(:nan) { Set.new([1, "2"]) }
+    it_behaves_like 'a statistical summary'
+  end
+
+  describe Vector do
+    let(:collection) { Vector[*(-5..5).to_a] }
+    let(:empty) { Vector[] }
+    let(:nan) { Vector[*[1, "2"]] }
+    it_behaves_like 'a statistical summary'
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: magic_numbers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fernando Rodrigues
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+description: Ruby data analysis library
+email:
+- fernandors87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/magic_numbers.rb
+- lib/magic_numbers/summary.rb
+- lib/magic_numbers/summary/all.rb
+- lib/magic_numbers/summary/array.rb
+- lib/magic_numbers/summary/matrix.rb
+- lib/magic_numbers/summary/set.rb
+- lib/magic_numbers/version.rb
+- magic_numbers.gemspec
+- spec/magic_numbers/summary_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.1
+signing_key: 
+specification_version: 4
+summary: Ruby data analysis library
+test_files:
+- spec/magic_numbers/summary_spec.rb
+- spec/spec_helper.rb
+has_rdoc: