scbi_math 0.0.1

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.0.1 2011-05-26
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/scbi_math.rb
+lib/scbi_math/array_extras.rb
+lib/scbi_math/float_extras.rb
+lib/scbi_math/scbi_narray.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_scbi_math.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on scbi_math, see http://scbi_math.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,62 @@
+= scbi_math
+
+* http://www.scbi.uma.es/downloads
+
+== DESCRIPTION:
+
+scbi_math is a ruby gem based on narray to do some additional statistics, 
+
+== FEATURES/PROBLEMS:
+
+* Calculates MAD (Mean absolute deviation) based on mean
+* Calculates MAD (Median absolute deviation) based on median
+* Calculates a FAT mode using a window_size to find the mode that accumulates more frequency on the sample.
+
+== SYNOPSIS:
+
+  # collect an array
+  my_array=(1..40).collect.to_a
+
+  # create a SCBINArray object
+  na=ScbiNArray.to_na(my_array)
+
+  puts na.mad_median
+
+  puts na.mad_mean
+
+  puts na.fat_mode
+
+  # There are also a set of statistics predefined by the narray class
+
+== REQUIREMENTS:
+
+* narray gem
+
+== INSTALL:
+
+* sudo gem install scbi_math
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Dario Guerrero
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/scbi_math'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'scbi_math' do
+  self.developer 'Dario Guerrero', 'dariogf@gmail.com'
+  # self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['narray']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+task :default => [:spec, :features, :redocs]

data/lib/scbi_math.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
+# require 'scbi_math/array_extras'
+require 'scbi_math/scbi_narray'
+# require 'scbi_math/float_extras'
+
+# require 'scbi_math/scbi_stats'
+
+module ScbiMath
+  VERSION = '0.0.1'
+end

data/lib/scbi_math/array_extras.rb

@@ -0,0 +1,11 @@
+class Array
+
+  def sum
+    r=0
+    each do |e|
+      r+=e
+    end
+    return r
+  end
+
+end

data/lib/scbi_math/float_extras.rb

@@ -0,0 +1,9 @@
+# extend classes with extra methods
+class Float
+  def round_to(d = 2)
+
+    res = (self*10.0*d).round/(10.0*d)
+    return res
+  end
+end
+

data/lib/scbi_math/scbi_narray.rb

@@ -0,0 +1,73 @@
+require 'narray'
+
+class ScbiNArray < NArray
+
+  # mean absolute deviation
+  def mad_mean
+    me = self.mean
+    mad = ((self - me ).abs).mean
+
+    return [mad,me]
+
+  end
+
+  # meadian absolute deviation
+  def mad_median
+    me = self.median
+    mad = ((self - me).abs).median
+
+    return [mad,me]
+  end
+
+  # returns stddev for length=1
+  def stddev
+
+    if self.length<=1
+      stddev=0
+    else
+      stddev=super()
+    end
+
+    return stddev
+  end
+  
+  
+  # coefficient of variance
+  def variance_coefficient
+     return ((stddev/mean)*100)
+  end
+
+
+  # fat mode calculates mode based on accumulated frequency with a window_size
+  def fat_mode(window_size=10)
+
+    fat_modes=[]
+    max_fat=0
+
+    self.length.times do |i|
+      fat=get_window_value(i)
+
+      fat_modes << fat
+
+      if fat_modes[max_fat] < fat
+        max_fat=i
+      end
+
+    end
+    # puts "algo",max_fat
+    return [max_fat,fat_modes[max_fat]]
+  end
+
+
+  # =======================================
+  private
+
+    def get_window_value(i,window_size=10)
+      start_pos=[0,i-window_size].max
+
+      end_pos=[self.length-1,i+window_size].min
+
+      return self[start_pos..end_pos].sum
+    end
+
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/scbi_math.rb'}"
+puts "Loading scbi_math gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/scbi_math'

data/test/test_scbi_math.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+
+class TestScbiMath < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_scbi_narray_class
+    
+    na=ScbiNArray.to_na([2,3,4])
+    assert_equal('ScbiNArray',na.class.to_s)
+    
+
+
+
+    # istat=JSON.parse(File.read('initial_stats.json'))
+    # 
+    # x=[]
+    # istat['qv'].each do |qv|
+    #   x<< qv['tot'].to_i
+    #   
+    # end
+    # # Usage:
+    # 
+    # s=ScbiStats.new(x)
+    # 
+    # puts s.fat_mode
+  end
+  
+  def test_fat_mode
+    
+    na=ScbiNArray.to_na((1..40).collect.to_a)
+
+    na[10]=1000
+    
+    assert_equal([10,21],na.mad_median)
+    assert_equal([47.525,45.225],na.mad_mean)
+    
+    
+    assert_equal([20,1430], na.fat_mode)
+    
+    
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: scbi_math
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dario Guerrero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: narray
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  version_requirements: *id002
+description: scbi_math is a ruby gem based on narray to do some additional statistics,
+email: 
+- dariogf@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/scbi_math.rb
+- lib/scbi_math/array_extras.rb
+- lib/scbi_math/float_extras.rb
+- lib/scbi_math/scbi_narray.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_scbi_math.rb
+homepage: http://www.scbi.uma.es/downloads
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: scbi_math
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: scbi_math is a ruby gem based on narray to do some additional statistics,
+test_files: 
+- test/test_helper.rb
+- test/test_scbi_math.rb