correlation 0.0.1

data/gemspec

@@ -0,0 +1,20 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |s|
+  s.name         = "correlation"
+  s.version      = "0.0.1"
+  s.author       = "Ralf M�ller"
+  s.email        = "stark.dreamdetective@gmail.com"
+  s.homepage     = "http://extcsv.rubyforge.org/correlation"
+  s.platform     = Gem::Platform::RUBY
+  s.summary      = "Extension of GSL: Compute correaltion of 2 datasets"
+  candidates     = Dir.glob("lib/*.rb") + [ "rakefile", "gemspec"]
+  s.files        = candidates.delete_if do |item|
+                     item.include?(".hg") || item.include?("doc")
+                   end
+  s.require_path = "lib"
+  s.test_files   = Dir.glob("test/test_*.rb")
+  s.has_rdoc     = true
+end
+
+# vim:ft=ruby

data/lib/correlation.rb

@@ -0,0 +1,45 @@
+require "rbgsl"
+
+# This Extension of the GNU Scientific Library bindings by Yoshiki Tsunesada
+# (http://rb-gsl.rubyforge.org) provides the computation of the correlation of two
+# GSL::Vectors. It is implemented as a method of a GSL::Vector for most easy
+# usage. 
+class GSL::Vector
+
+  # Follow the usual definition, e.g. from Sheriff and Geldart "Exploitation
+  # Seismology", p. 289: cor(v,w)(i) = sum_over_k (v[k]*w[k+i])
+  #
+  # This means, that
+  # * for positive values of i, w is shifted to the left, i.e. in the direction of smaller indizees of v
+  # * for negative i, w is shifted to the right, i.e. in the direction of larger indizees of v
+  def correlation(other)
+    unless size == other.size
+      warn "Vectors/Datasets must have the same size."
+      raise
+    end
+
+    # predefine result vector
+    correlation = GSL::Vector.alloc(1)
+    correlation.shift
+
+    # Alternate definition, which is actually the opposite direction of the definition
+    # (0...size).each {|i|
+    #   correlation << self[0..i]*other[-i-1..-1].col
+    # }
+    # (1...size).each {|i|
+    #   correlation << self[i..size-1]*other[0...size-i].col
+    # }
+
+    (0...size).each {|i|
+      correlation << self[-i-1..-1]*other[0..i].col
+    }
+    (1...size).each {|i|
+      correlation << self[0...size-i]*other[i..size-1].col
+    }
+
+    [GSL::Vector.linspace(-size+1, size-1, 2*size-1) , correlation]
+  end
+  def autocorrelation
+    correlation(self)
+  end
+end

data/rakefile

@@ -0,0 +1,96 @@
+begin	
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+SPEC = eval(File.open("gemspec","r").read)
+
+def filename_to_sym(filename)
+  File.basename(filename,File.extname(filename)).to_sym
+end
+
+# ====================================================================
+# TEST TASKS
+test_tasks = {
+  :test_all   => ["Run all tests"],
+}
+# Syntax checkning task
+task :test_syn do
+  Dir.glob("**/*.rb").each {|file|
+    printf "Checking Syntax of #{file} ..."
+    system("ruby -c #{file}")
+  }
+end
+# Test tasks for each test file
+SPEC.test_files.each do |test_file|
+  next unless File.extname(test_file) == ".rb"
+  Rake::TestTask.new(filename_to_sym(test_file)) do |t|
+    test_tasks[:test_all]  << filename_to_sym(test_file)
+    t.test_files = FileList[test_file]
+    t.warning = false
+    t.verbose = true
+  end
+end
+
+# Test Tasks for groups of test files
+test_tasks.each do |k,v|
+  desc  v[0]
+  task k => v[1..-1]
+end
+# ====================================================================
+# Create a task that will package the software into distributable
+# tar, zip and gem files.
+if ! defined?(Gem)
+  puts "Package Target requires RubyGEMs"
+else
+  package_task = Rake::GemPackageTask.new(SPEC) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+end
+# ====================================================================
+desc "Install the Library with docs"
+task :install => [:repackage] do
+  command = "gem install pkg/#{SPEC.name}-#{SPEC.version}.gem"
+  puts command
+  system(command)
+end
+task :smallInstall => [:repackage] do 
+  command = "gem install pkg/#{SPEC.name}-#{SPEC.version}.gem --no-ri --no-rdoc"
+  puts command
+  system(command)
+end
+# ====================================================================
+# Create a task to build the RDOC documentation tree.
+Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "Correlation Function as GSL Extension"
+  rdoc.options << '-ad' << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+}
+############################################################
+files       = Dir.glob("{lib,test}/*.rb")
+visual_mode = (ENV["vimode"].nil?) ? '-p' : ENV["vimode"]
+desc "Edit texfiles #{files.join(", ")}"
+task :edit do
+  com = (File.exist?("Session.vim"))\
+    ? 'vim -S'\
+    : "vim #{files.join(" ")} rakefile gemspec #{visual_mode}"
+  puts com
+  system(com)
+end
+############################################################
+desc "renew the tags file"
+task :tags do
+  com = "rtags --vi -f tags lib/*.rb"
+  system(com)
+end
+#
+#
+# vim:ft=ruby
+#

data/test/test_correlation.rb

@@ -0,0 +1,20 @@
+$:.unshift File.join(File.dirname(__FILE__),"..","lib")
+require 'test/unit'
+require 'correlation'
+require 'pp'
+
+class TestCorrelation < Test::Unit::TestCase
+  def test_simple
+     v = GSL::Vector.alloc([0,1,0,0,0,0,0,0,0,0])
+     w = GSL::Vector.alloc([0,0,0,0,0,0,0,0,1,0])
+     
+     #GSL::graph(v.correlation(w), "-X 'Correlation v with w' -C -g 3")
+     #GSL::graph(v.autocorrelation,"-X 'Autocorrelation v' -C -g 3")
+
+     assert_equal(1, v.correlation(w)[1][-3])
+     assert_equal(0, v.correlation(w)[1][9])
+
+     assert_equal(1,v.autocorrelation[1][v.autocorrelation[0].where {|i| i == 0}[0]])
+     assert_equal(0,v.autocorrelation[1][v.autocorrelation[0].where {|i| i != 0}[0]])
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+name: correlation
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Ralf M\xFCller"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-24 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: stark.dreamdetective@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/correlation.rb
+- rakefile
+- gemspec
+has_rdoc: true
+homepage: http://extcsv.rubyforge.org/correlation
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: "Extension of GSL: Compute correaltion of 2 datasets"
+test_files: 
+- test/test_correlation.rb