nmatrix 0.1.0.rc4 → 0.1.0.rc5

data/lib/nmatrix/homogeneous.rb

@@ -0,0 +1,143 @@
+#--
+# = NMatrix
+#
+# A linear algebra library for scientific computation in Ruby.
+# NMatrix is part of SciRuby.
+#
+# NMatrix was originally inspired by and derived from NArray, by
+# Masahiro Tanaka: http://narray.rubyforge.org
+#
+# == Copyright Information
+#
+# SciRuby is Copyright (c) 2010 - 2014, Ruby Science Foundation
+# NMatrix is Copyright (c) 2012 - 2014, John Woods and the Ruby Science Foundation
+#
+# Please see LICENSE.txt for additional copyright notices.
+#
+# == Contributing
+#
+# By contributing source code to SciRuby, you agree to be bound by
+# our Contributor Agreement:
+#
+# * https://github.com/SciRuby/sciruby/wiki/Contributor-Agreement
+#
+# == homogeneous.rb
+#
+# This file contains optional shortcuts for generating homogeneous
+# transformations.
+#
+#++
+
+class NMatrix
+  class << self
+    #
+    # call-seq:
+    #     x_rotation(angle_in_radians) -> NMatrix
+    #     x_rotation(angle_in_radians, dtype: dtype) -> NMatrix
+    #     y_rotation(angle_in_radians) -> NMatrix
+    #     y_rotation(angle_in_radians, dtype: dtype) -> NMatrix
+    #     z_rotation(angle_in_radians) -> NMatrix
+    #     z_rotation(angle_in_radians, dtype: dtype) -> NMatrix
+    #
+    # Generate a 4x4 homogeneous transformation matrix representing a rotation
+    # about the x, y, or z axis respectively.
+    #
+    # * *Arguments* :
+    #   - +angle_in_radians+ -> The angle of rotation in radians.
+    #   - +dtype+ -> (optional) Default is +:float64+
+    # * *Returns* :
+    #   - A homogeneous transformation matrix consisting of a single rotation.
+    #
+    # Examples:
+    #
+    #    NMatrix.x_rotation(Math::PI.quo(6)) # =>
+    #                                              1.0      0.0       0.0       0.0
+    #                                              0.0      0.866025 -0.499999  0.0
+    #                                              0.0      0.499999  0.866025  0.0
+    #                                              0.0      0.0       0.0       1.0
+    #
+    #
+    #    NMatrix.x_rotation(Math::PI.quo(6), dtype: :float32) # =>
+    #                                              1.0      0.0       0.0       0.0
+    #                                              0.0      0.866025 -0.5       0.0
+    #                                              0.0      0.5       0.866025  0.0
+    #                                              0.0      0.0       0.0       1.0
+    #
+    def x_rotation angle_in_radians, opts={}
+      c = Math.cos(angle_in_radians)
+      s = Math.sin(angle_in_radians)
+      NMatrix.new(4, [1.0, 0.0, 0.0, 0.0,
+                      0.0, c,   -s,  0.0,
+                      0.0, s,    c,  0.0,
+                      0.0, 0.0, 0.0, 1.0], {dtype: :float64}.merge(opts))
+    end
+
+    def y_rotation angle_in_radians, opts={}
+      c = Math.cos(angle_in_radians)
+      s = Math.sin(angle_in_radians)
+      NMatrix.new(4, [ c,  0.0,  s,  0.0,
+                      0.0, 1.0, 0.0, 0.0,
+                      -s,  0.0,  c,  0.0,
+                      0.0, 0.0, 0.0, 1.0], {dtype: :float64}.merge(opts))
+    end
+
+    def z_rotation angle_in_radians, opts={}
+      c = Math.cos(angle_in_radians)
+      s = Math.sin(angle_in_radians)
+      NMatrix.new(4, [ c,  -s,  0.0, 0.0,
+                       s,   c,  0.0, 0.0,
+                      0.0, 0.0, 1.0, 0.0,
+                      0.0, 0.0, 0.0, 1.0], {dtype: :float64}.merge(opts))
+    end
+
+
+    #
+    # call-seq:
+    #     translation(x, y, z) -> NMatrix
+    #     translation([x,y,z]) -> NMatrix
+    #     translation(translation_matrix) -> NMatrix
+    #     translation(translation_matrix) -> NMatrix
+    #     translation(translation, dtype: dtype) -> NMatrix
+    #     translation(x, y, z, dtype: dtype) -> NMatrix
+    #
+    # Generate a 4x4 homogeneous transformation matrix representing a translation.
+    #
+    # * *Returns* :
+    #   - A homogeneous transformation matrix consisting of a translation.
+    #
+    # Examples:
+    #
+    #    NMatrix.translation(4.0,5.0,6.0) # =>
+    #                                          1.0   0.0   0.0   4.0
+    #                                          0.0   1.0   0.0   5.0
+    #                                          0.0   0.0   1.0   6.0
+    #                                          0.0   0.0   0.0   1.0
+    #
+    #    NMatrix.translation(4.0,5.0,6.0, dtype: :int64) # =>
+    #                                                         1  0  0  4
+    #                                                         0  1  0  5
+    #                                                         0  0  1  6
+    #                                                         0  0  0  1
+    #    NMatrix.translation(4,5,6) # =>
+    #                                     1  0  0  4
+    #                                     0  1  0  5
+    #                                     0  0  1  6
+    #                                     0  0  0  1
+    #
+    def translation *args
+      xyz = args.shift if args.first.is_a?(NMatrix) || args.first.is_a?(Array)
+      default_dtype = xyz.respond_to?(:dtype) ? xyz.dtype : NMatrix.guess_dtype(xyz)
+      opts = {dtype: default_dtype}
+      opts = opts.merge(args.pop) if args.size > 0 && args.last.is_a?(Hash)
+      xyz ||= args
+
+      n = if args.size > 0
+        NMatrix.eye(4, opts)
+      else
+        NMatrix.eye(4, opts)
+      end
+      n[0..2,3] = xyz
+      n
+    end
+  end
+end

data/lib/nmatrix/nmatrix.rb

@@ -820,6 +820,18 @@ class NMatrix
   end
 
 
+  #
+  # call-seq:
+  #     inject -> symbol
+  #
+  # This overrides the inject function to use map_stored for yale matrices
+  #
+  def inject(sym)
+    return super(sym) unless self.yale?
+    return self.map_stored.inject(sym)
+  end
+
+
   #
   # call-seq:
   #     clone_structure -> NMatrix

data/lib/nmatrix/version.rb

@@ -31,7 +31,7 @@ class NMatrix
     MAJOR = 0
     MINOR = 1
     TINY = 0
-    PRE = "rc4"
+    PRE = "rc5"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/nmatrix.gemspec

@@ -43,12 +43,12 @@ EOF
 
   gem.required_ruby_version = '>= 1.9'
 
-  gem.add_dependency 'rdoc', '>=4.0.1'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'bundler'
-  gem.add_development_dependency 'rspec', '~>2.14.1'
-  gem.add_development_dependency 'rspec-longrun', '~>1.0.1'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rake-compiler', '~>0.8.1'
+  gem.add_dependency 'rdoc', '~>4.0', '>=4.0.1'
+  gem.add_development_dependency 'rake', '~>10.3'
+  gem.add_development_dependency 'bundler', '~>1.6'
+  gem.add_development_dependency 'rspec', '~>2.14'
+  gem.add_development_dependency 'rspec-longrun', '~>1.0'
+  gem.add_development_dependency 'pry', '~>0.10'
+  gem.add_development_dependency 'rake-compiler', '~>0.8'
 end
 

data/spec/00_nmatrix_spec.rb

@@ -562,4 +562,20 @@ describe 'NMatrix' do
       end
     end
   end
+
+  context "#inject" do
+    it "should sum columns of yale matrix correctly" do
+      n = NMatrix.new([4, 3], stype: :yale, default: 0)
+      n[0,0] = 1
+      n[1,1] = 2
+      n[2,2] = 4
+      n[3,2] = 8
+      column_sums = []
+      n.cols.times do |i|
+        column_sums << n.col(i).inject(:+)
+      end
+      expect(column_sums).to eq([1, 2, 12])
+    end
+  end
+
 end

data/spec/homogeneous_spec.rb

@@ -0,0 +1,91 @@
+# = NMatrix
+#
+# A linear algebra library for scientific computation in Ruby.
+# NMatrix is part of SciRuby.
+#
+# NMatrix was originally inspired by and derived from NArray, by
+# Masahiro Tanaka: http://narray.rubyforge.org
+#
+# == Copyright Information
+#
+# SciRuby is Copyright (c) 2010 - 2014, Ruby Science Foundation
+# NMatrix is Copyright (c) 2012 - 2014, John Woods and the Ruby Science Foundation
+#
+# Please see LICENSE.txt for additional copyright notices.
+#
+# == Contributing
+#
+# By contributing source code to SciRuby, you agree to be bound by
+# our Contributor Agreement:
+#
+# * https://github.com/SciRuby/sciruby/wiki/Contributor-Agreement
+#
+# == homogeneous_spec.rb
+#
+# Specs for the homogeneous transformation matrix methods.
+#
+
+require 'spec_helper'
+require "./lib/nmatrix/homogeneous.rb"
+
+require 'pry'
+
+describe 'NMatrix' do
+  context "#x_rotation" do
+    it "should generate a matrix representing a rotation about the x axis" do
+      x = NMatrix.x_rotation(Math::PI.quo(6))
+      expect(x).to be_within(1e-8).of(NMatrix.new([4,4], [1.0, 0.0, 0.0, 0.0,
+                                                      0.0, Math.cos(Math::PI.quo(6)), -0.5, 0.0,
+                                                      0.0, 0.5, Math.cos(Math::PI.quo(6)), 0.0,
+                                                      0.0, 0.0, 0.0, 1.0] ))
+    end
+  end
+
+
+  context "#y_rotation" do
+    it "should generate a matrix representing a rotation about the y axis" do
+      y = NMatrix.y_rotation(Math::PI.quo(6))
+      expect(y).to be_within(1e-8).of(NMatrix.new([4,4], [Math.cos(Math::PI.quo(6)), 0.0, 0.5, 0.0,
+                                                      0.0, 1.0, 0.0, 0.0,
+                                                     -0.5, 0.0, Math.cos(Math::PI.quo(6)), 0.0,
+                                                      0.0, 0.0, 0.0, 1.0] ))
+    end
+  end
+
+  context "#z_rotation" do
+    it "should generate a matrix representing a rotation about the z axis" do
+      z = NMatrix.z_rotation(Math::PI.quo(6))
+      expect(z).to be_within(1e-8).of(NMatrix.new([4,4], [Math.cos(Math::PI.quo(6)), -0.5, 0.0, 0.0,
+                                                      0.5, Math.cos(Math::PI.quo(6)), 0.0, 0.0,
+                                                      0.0, 0.0, 1.0, 0.0,
+                                                      0.0, 0.0, 0.0, 1.0] ))
+    end
+  end
+
+  context "#translation" do
+    it "should generate a translation matrix from an Array" do
+      t = NMatrix.translation([4,5,6])
+      expect(t).to be_within(1e-8).of(NMatrix.new([4,4], [1, 0, 0, 4,
+                                                      0, 1, 0, 5,
+                                                      0, 0, 1, 6,
+                                                      0, 0, 0, 1] ))
+    end
+
+    it "should generate a translation matrix from x, y, and z values" do
+      t = NMatrix.translation(4,5,6)
+      expect(t).to be_within(1e-8).of(NMatrix.new([4,4], [1, 0, 0, 4,
+                                                      0, 1, 0, 5,
+                                                      0, 0, 1, 6,
+                                                      0, 0, 0, 1] ))
+    end
+
+    it "should generate a translation matrix from an NMatrix with correctly inferred dtype" do
+      t = NMatrix.translation(NMatrix.new([3,1], [4,5,6], dtype: :float64) )
+      expect(t).to be_within(1e-8).of(NMatrix.new([4,4], [1, 0, 0, 4,
+                                                      0, 1, 0, 5,
+                                                      0, 0, 1, 6,
+                                                      0, 0, 0, 1] ))
+      expect(t.dtype).to be(:float64)
+    end
+  end
+end

data/spec/rspec_spec.rb

@@ -28,7 +28,7 @@ require 'spec_helper'
 
 describe "RSpec" do
   it "should permit #be_within to be used on a dense NMatrix" do
-    expect(NMatrix.new(:dense, [4,1], 1.0, :complex128) / 10000.0).to be_within(0.00000001).of(NMatrix.new(:dense, [4,1], 0.0001, :float64))
-    expect(NMatrix.new(:dense, [4,1], 1.0, :complex128) / 10000.0).not_to be_within(0.00000001).of(NMatrix.new(:dense, [4,1], 1.0, :float64))
+    expect(NMatrix.new([4,1], 1.0, dtype: :complex128, stype: :dense) / 10000.0).to be_within(0.00000001).of(NMatrix.new([4,1], 0.0001, dtype: :float64, stype: :dense))
+    expect(NMatrix.new([4,1], 1.0, dtype: :complex128, stype: :dense) / 10000.0).not_to be_within(0.00000001).of(NMatrix.new([4,1], 1.0, dtype: :float64, stype: :dense))
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nmatrix
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc4
+  version: 0.1.0.rc5
 platform: ruby
 authors:
 - John Woods
@@ -10,106 +10,112 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rspec-longrun
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
 description: NMatrix is an experimental linear algebra library for Ruby, written mostly
   in C.
 email:
@@ -119,9 +125,9 @@ extensions:
 - ext/nmatrix/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - History.txt
@@ -195,6 +201,7 @@ files:
 - lib/nmatrix.rb
 - lib/nmatrix/blas.rb
 - lib/nmatrix/enumerate.rb
+- lib/nmatrix/homogeneous.rb
 - lib/nmatrix/io/market.rb
 - lib/nmatrix/io/mat5_reader.rb
 - lib/nmatrix/io/mat_reader.rb
@@ -218,6 +225,7 @@ files:
 - spec/4x5_dense.mat
 - spec/blas_spec.rb
 - spec/elementwise_spec.rb
+- spec/homogeneous_spec.rb
 - spec/io_spec.rb
 - spec/lapack_spec.rb
 - spec/leakcheck.rb
@@ -262,17 +270,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: NMatrix is an experimental linear algebra library for Ruby, written mostly
@@ -286,6 +294,7 @@ test_files:
 - spec/4x5_dense.mat
 - spec/blas_spec.rb
 - spec/elementwise_spec.rb
+- spec/homogeneous_spec.rb
 - spec/io_spec.rb
 - spec/lapack_spec.rb
 - spec/leakcheck.rb