vectorops 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38db41b3c73af01fc46878a9175fcc8474fd4beb
+  data.tar.gz: 3b952bfff17bbebd5bf85e59ddb6af6e512d5004
+SHA512:
+  metadata.gz: 85eb175b0ad2ad2370c6ea4278c095549fafeb92192475da29bd367210f55b32ba5a3c365e249c5cd7a0d465dcef89a5edc37b4ae3e0acbeda433ba170ffb3c6
+  data.tar.gz: cbd217dc043552fe6362f360e7ea5563cfa4a91b2f691156b58c364b6cfdadc87e592f6c6c3cbe1b8e5168cfa686d4cd2aa4cbc1f5107d1ee976dd0bc20d0225

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vectorops.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Sorowka
+
+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,78 @@
+vectorops
+==========
+
+**Advanced Vector Operations for Ruby.**
+
+READ THIS
+----------
+This is work in progress and only very few operations are implemented. Feel free to contribute by adding more vector operations 
+like multiplication and so on.
+
+
+Basic
+-----
+
+When you want to perform vector operations like summation in ruby, you cannot use the array class as it behaves like this: 
+
+      v1 = [1,1,1,0,0,0]
+      v2 = [1,1,1,1,1,1]
+
+      v1 + v2
+      # -> [1,1,1,0,0,0,1,1,1,1,1,1]
+
+For this purpose, there is a Vector class, defined in Ruby's stdlib. With Vector objects it's possible to do the following:
+
+      require 'matrix.rb'
+
+      v1 = Vector[1,1,1,0,0,0]
+      v2 = Vector[1,1,1,1,1,1]
+
+      v1 + v2
+      # -> Vector[2,2,2,1,1,1]
+
+which is exactly what you want. Unfortunately, as of now, the libary seems not to be quite mature, as neither of the following will work by default: 
+
+      v1 = Vector[1,1,1,0,0,0]
+      v2 = Vector[1,1,1,1,1,1]
+
+      # assigning values to a vector is impossible 
+      # as no []= method is defined in the lib
+      v1 += v2
+
+      # adding up subsets of the vectors is not possible, as 
+      # the [] accessor returns an array rather than a Vector
+      v1[0..3] + v2[0..3]
+
+      # adding a scalar to a vector doesn't work as expected as 
+      # the + method doesn't handle this case
+      v1 + 2
+
+
+Using the vectorops Gem, the following operations work like expected
+
+      v1 = Vector[1,1,1,0,0,0]
+      v2 = Vector[1,1,1,1,1,1]
+
+      v1[0..3]
+      # -> Vector[1,1,1]
+
+      v1 += v2
+      # -> v1 == Vector[2,2,2,1,1,1]
+
+      v1[0..3] += v2[0..3]
+      # -> v1 == Vector[2,2,2,0,0,0]
+
+      v1 + 2
+      # -> Vector[3,3,3,1,1,1]
+
+
+Usage
+-----
+
+Install vectorops using the command
+
+      gem install vectorops
+
+Or include the vectorops gem into your Gemfile
+
+      gem 'vectorops'

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+task :default => :spec

data/lib/core_ext/matrix.rb

@@ -0,0 +1,52 @@
+require 'matrix'
+
+class Vector 
+
+  def []=(pos, value)
+    @elements[pos] = value.to_a
+  end
+
+  def [](*i)
+    i.length == 1 and i[0].is_a?(Numeric) ? @elements[i[0]] : Vector.elements(@elements[*i])
+  end
+
+  def +(v)
+    case v
+    when Vector
+      Vector.Raise ErrDimensionMismatch if size != v.size
+      els = collect2(v) {|v1, v2|
+        v1 + v2
+      }
+      Vector.elements(els, false)
+    when Matrix
+      Matrix.column_vector(self) + v
+    when Array
+      Vector.Raise ErrDimensionMismatch if size != v.length
+      Vector.elements(v) + self
+    when Numeric
+      Vector.elements([v] * size) + self
+    else
+      apply_through_coercion(v, __method__)
+    end
+  end
+
+  def -(v)
+    case v
+    when Vector
+      Vector.Raise ErrDimensionMismatch if size != v.size
+      els = collect2(v) {|v1, v2|
+        v1 - v2
+      }
+      Vector.elements(els, false)
+    when Matrix
+      Matrix.column_vector(self) - v
+    when Array
+      Vector.Raise ErrDimensionMismatch if size != v.length
+      Vector.elements(v) - self
+    when Numeric
+      Vector.elements([v] * size) - self
+    else
+      apply_through_coercion(v, __method__)
+    end
+  end
+end

data/lib/vectorops.rb

@@ -0,0 +1,3 @@
+require "vectorops/version"
+
+require 'core_ext/matrix'

data/lib/vectorops/version.rb

@@ -0,0 +1,3 @@
+module Vectorops
+  VERSION = "0.1.2"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'vectorops'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.color = true
+
+end

data/spec/vector-ops.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Vector do
+
+  it "works to add two equal length vectors" do
+
+    v1 = Vector[1,1,1,2,2,2]
+    v2 = Vector[2,2,2,3,3,3]
+
+    expect(v1 + v2).to eql(Vector[3,3,3,5,5,5])
+  end
+
+  it "refuses to add two unequal length vectors" do
+
+    v1 = Vector[1,2,3]
+    v2 = Vector[1,2,3,4,5]
+
+    expect {v1 + v2}.to raise_error
+  end
+
+  it "returns a vector when selecting a subset of vectors" do 
+
+    v = Vector[1,2,3,4,5,6,7,8]
+    expect(v[2..4]).to eql(Vector[3,4,5])
+  end
+
+  it "works to use the += operator on the whole vector" do
+
+    v1 = Vector[1,1,1,2,2,2]
+    v2 = Vector[2,2,2,3,3,3]
+
+    v1 += v2
+
+    expect(v1).to eql(Vector[3,3,3,5,5,5])
+  end
+
+
+  it "works to use the += operator on a subset of a vector" do
+
+    v1 = Vector[1,1,1,2,2,2]
+    v2 = Vector[2,2,2,3,3,3]
+
+    v1[0..2] += v2[3..5]
+    
+    expect(v1).to eql(Vector[4,4,4,2,2,2])
+  end
+
+  it "works to add a scalar to a vector" do
+
+    v = Vector[0,0,0]
+
+    expect(v + 2).to eql(Vector[2,2,2])
+  end
+end

data/vectorops.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vectorops/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vectorops"
+  spec.version       = Vectorops::VERSION
+  spec.authors       = ["Peter Sorowka"]
+  spec.email         = ["psorowka@freilicht.net"]
+  spec.description   = %q{Advanced operations for Ruby Vector class}
+  spec.summary       = %q{Adds additional operations to the basic Ruby Vector class}
+  spec.homepage      = "https://github.com/psorowka/vectorops"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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"
+  spec.add_development_dependency "rspec",  "~> 3.0.0.beta2"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: vectorops
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Peter Sorowka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-23 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: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+description: Advanced operations for Ruby Vector class
+email:
+- psorowka@freilicht.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/core_ext/matrix.rb
+- lib/vectorops.rb
+- lib/vectorops/version.rb
+- spec/spec_helper.rb
+- spec/vector-ops.rb
+- vectorops.gemspec
+homepage: https://github.com/psorowka/vectorops
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Adds additional operations to the basic Ruby Vector class
+test_files:
+- spec/spec_helper.rb
+- spec/vector-ops.rb
+has_rdoc: