rubysl-matrix 1.0.0

data/lib/rubysl/matrix/version.rb

@@ -0,0 +1,5 @@
+module RubySL
+  module Matrix
+    VERSION = "1.0.0"
+  end
+end

data/rubysl-matrix.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+require './lib/rubysl/matrix/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubysl-matrix"
+  spec.version       = RubySL::Matrix::VERSION
+  spec.authors       = ["Brian Shirai"]
+  spec.email         = ["brixen@gmail.com"]
+  spec.description   = %q{Ruby standard library matrix.}
+  spec.summary       = %q{Ruby standard library matrix.}
+  spec.homepage      = "https://github.com/rubysl/rubysl-matrix"
+  spec.license       = "BSD"
+
+  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.required_ruby_version = "~> 1.8.7"
+
+  spec.add_runtime_dependency "rubysl-e2mmap", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
+end

data/spec/I_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path('../shared/identity', __FILE__)
+
+describe "Matrix.I" do
+  it_behaves_like(:matrix_identity, :I)
+end

data/spec/build_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+require 'matrix'
+
+ruby_version_is "1.9" do
+  describe "Matrix.build" do
+
+    it "returns a Matrix object of the given size" do
+      m = Matrix.build(3, 4){1}
+      m.should be_an_instance_of(Matrix)
+      m.row_size.should == 3
+      m.column_size.should == 4
+    end
+
+    it "builds the Matrix using the given block" do
+      Matrix.build(2, 3){|col, row| 10*col - row}.should ==
+        Matrix[[0, -1, -2], [10, 9, 8]]
+    end
+
+    it "iterates through the first row, then the second, ..." do
+      acc = []
+      Matrix.build(2, 3){|*args| acc << args}
+      acc.should == [[0, 0], [0, 1], [0, 2], [1, 0], [1, 1], [1, 2]]
+    end
+
+    it "returns an Enumerator is no block is given" do
+      enum = Matrix.build(2, 1)
+      enum.should  be_an_instance_of(enumerator_class)
+      enum.each{1}.should == Matrix[[1], [1]]
+    end
+
+    it "requires integers as parameters" do
+      lambda { Matrix.build("1", "2"){1} }.should raise_error(TypeError)
+      lambda { Matrix.build(nil, nil){1} }.should raise_error(TypeError)
+      lambda { Matrix.build(1..2){1} }.should raise_error(TypeError)
+    end
+
+    it "requires non-negative integers" do
+      lambda { Matrix.build(-1, 1){1} }.should raise_error(ArgumentError)
+      lambda { Matrix.build(+1,-1){1} }.should raise_error(ArgumentError)
+    end
+
+    it "returns empty Matrix if one argument is zero" do
+      m = Matrix.build(0, 3){
+        raise "Should not yield"
+      }
+      m.should be_empty
+      m.column_size.should == 3
+
+      m = Matrix.build(3, 0){
+        raise "Should not yield"
+      }
+      m.should be_empty
+      m.row_size.should == 3
+    end
+
+    it "tries to calls :to_int on arguments" do
+      int = mock('int')
+      int.should_receive(:to_int).twice.and_return(2)
+      Matrix.build(int, int){ 1 }.should == Matrix[ [1,1], [1,1] ]
+    end
+
+    it "builds an nxn Matrix when given only one argument" do
+      m = Matrix.build(3){1}
+      m.row_size.should == 3
+      m.column_size.should == 3
+    end
+  end
+
+  describe "for a subclass of Matrix" do
+    it "returns an instance of that subclass" do
+      MatrixSub.build(3){1}.should be_an_instance_of(MatrixSub)
+    end
+  end
+end
+

data/spec/clone_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe "Matrix#clone" do
+  before(:each) do
+    @a = Matrix[[1, 2], [3, 4], [5, 6]]
+  end
+
+  it "returns a shallow copy of the matrix" do
+    b = @a.clone
+    @a.should_not equal(b)
+    b.should be_kind_of(Matrix)
+    b.should == @a
+    0.upto(@a.row_size - 1) do |i|
+      @a.row(i).should_not equal(b.row(i))
+    end
+  end
+
+  ruby_bug "redmine #5307", "1.9.3" do
+    describe "for a subclass of Matrix" do
+      it "returns an instance of that subclass" do
+        MatrixSub.ins.clone.should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/coerce_spec.rb

@@ -0,0 +1,11 @@
+require 'matrix'
+
+describe "Matrix#coerce" do
+  it "needs to be reviewed for spec completeness"
+
+  ruby_bug "revision 24952", "1.8.7" do
+    it "allows the division of fixnum by a Matrix " do
+      (1/Matrix[[0,1],[-1,0]]).should == Matrix[[0,-1],[1,0]]
+    end
+  end
+end

data/spec/collect_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path('../shared/collect', __FILE__)
+
+describe "Matrix#collect" do
+  it_behaves_like(:collect, :collect)
+end

data/spec/column_size_spec.rb

@@ -0,0 +1,14 @@
+require 'matrix'
+
+describe "Matrix#column_size" do
+  it "returns the number of columns" do
+    Matrix[ [1,2], [3,4] ].column_size.should == 2
+  end
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "returns 0 for empty matrices" do
+      Matrix[ [], [] ].column_size.should == 0
+      Matrix[ ].column_size.should == 0
+    end
+  end
+end

data/spec/column_spec.rb

@@ -0,0 +1,36 @@
+require 'matrix'
+
+describe "Matrix#column" do
+  before :all do
+    @m =  Matrix[[1,2,3], [2,3,4]]
+  end
+
+  it "returns a Vector when called without a block" do
+    @m.column(1).should == Vector[2,3]
+  end
+
+  it "yields each element in the column to the block" do
+    a = []
+    @m.column(1) {|n| a << n }
+    a.should == [2,3]
+  end
+
+  it "counts backwards for negative argument" do
+    @m.column(-1).should == Vector[3, 4]
+  end
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "returns self when called with a block" do
+      @m.column(0) { |x| x }.should equal(@m)
+    end
+
+    it "returns nil when out of bounds" do
+      @m.column(3).should == nil
+    end
+
+    it "never yields when out of bounds" do
+      lambda { @m.column(3){ raise } }.should_not raise_error
+      lambda { @m.column(-4){ raise } }.should_not raise_error
+    end
+  end
+end

data/spec/column_vector_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe "Matrix.column_vector" do
+
+  it "returns a single column Matrix when called with an Array" do
+    m = Matrix.column_vector([4,5,6])
+    m.should be_an_instance_of(Matrix)
+    m.should == Matrix[ [4],[5],[6] ]
+  end
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "returns an empty Matrix when called with an empty Array" do
+      m = Matrix.column_vector([])
+      m.should be_an_instance_of(Matrix)
+      m.row_size.should == 0
+      m.column_size.should == 1
+    end
+  end
+
+  ruby_version_is ""..."1.9" do
+    describe "for a subclass of Matrix" do
+      it "returns an instance of Matrix" do
+        MatrixSub.column_vector([4,5,6]).should be_an_instance_of(Matrix)
+      end
+    end
+  end
+
+  ruby_version_is "1.9" do
+    describe "for a subclass of Matrix" do
+      it "returns an instance of that subclass" do
+        MatrixSub.column_vector([4,5,6]).should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/column_vectors_spec.rb

@@ -0,0 +1,25 @@
+require 'matrix'
+
+describe "Matrix#column_vectors" do
+
+  before(:each) do
+    @vectors = Matrix[ [1,2], [3,4] ].column_vectors
+  end
+
+  it "returns an Array" do
+    Matrix[ [1,2], [3,4] ].column_vectors.should be_an_instance_of(Array)
+  end
+
+  it "returns an Array of Vectors" do
+    @vectors.all? {|v| v.should be_an_instance_of(Vector)}
+  end
+
+  it "returns each column as a Vector" do
+    @vectors.should == [Vector[1,3], Vector[2,4]]
+  end
+
+  it "returns an empty Array for empty matrices" do
+    Matrix[ [] ].column_vectors.should == []
+  end
+
+end

data/spec/columns_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe "Matrix.columns" do
+  before :each do
+    @a = [1, 2]
+    @b = [3, 4]
+    @m = Matrix.columns([@a, @b])
+  end
+
+  it "creates a Matrix from argument columns" do
+    @m.should be_an_instance_of(Matrix)
+    @m.column(0).to_a.should == @a
+    @m.column(1).to_a.should == @b
+  end
+
+  it "accepts Vectors as argument columns" do
+    m = Matrix.columns([Vector[*@a], Vector[*@b]])
+    m.should == @m
+    m.column(0).to_a.should == @a
+    m.column(1).to_a.should == @b
+  end
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "handles empty matrices" do
+      e = Matrix.columns([])
+      e.row_size.should == 0
+      e.column_size.should == 0
+      e.should == Matrix[]
+
+      v = Matrix.columns([[],[],[]])
+      v.row_size.should == 0
+      v.column_size.should == 3
+      v.should == Matrix[[], [], []].transpose
+    end
+  end
+
+  ruby_bug "redmine #5307", "1.9.3" do
+    describe "for a subclass of Matrix" do
+      it "returns an instance of that subclass" do
+        MatrixSub.columns([[1]]).should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/conj_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../shared/conjugate', __FILE__)
+
+ruby_version_is "1.9" do
+  describe "Matrix#conj" do
+    it_behaves_like(:matrix_conjugate, :conj)
+  end
+end

data/spec/conjugate_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../shared/conjugate', __FILE__)
+
+ruby_version_is "1.9" do
+  describe "Matrix#conjugate" do
+    it_behaves_like(:matrix_conjugate, :conjugate)
+  end
+end

data/spec/constructor_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe "Matrix.[]" do
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "requires arrays as parameters" do
+      lambda { Matrix[5] }.should raise_error(TypeError)
+      lambda { Matrix[nil] }.should raise_error(TypeError)
+      lambda { Matrix[1..2] }.should raise_error(TypeError)
+      lambda { Matrix[[1, 2], 3] }.should raise_error(TypeError)
+    end
+
+    it "creates an empty Matrix with no arguments" do
+      m = Matrix[]
+      m.column_size.should == 0
+      m.row_size.should == 0
+    end
+
+    it "raises for non-rectangular matrices" do
+      lambda{ Matrix[ [0], [0,1] ] }.should \
+        raise_error(Matrix::ErrDimensionMismatch)
+      lambda{ Matrix[ [0,1], [0,1,2], [0,1] ]}.should \
+        raise_error(Matrix::ErrDimensionMismatch)
+    end
+
+    it "accepts vector arguments" do
+      a = Matrix[Vector[1, 2], Vector[3, 4]]
+      a.should be_an_instance_of(Matrix)
+      a.should == Matrix[ [1, 2], [3, 4] ]
+    end
+
+    it "tries to calls :to_ary on arguments" do
+      array = mock('ary')
+      array.should_receive(:to_ary).and_return([1,2])
+      Matrix[array, [3,4] ].should == Matrix[ [1,2], [3,4] ]
+    end
+
+  end
+
+  it "returns a Matrix object" do
+    Matrix[ [1] ].should be_an_instance_of(Matrix)
+  end
+
+  it "can create an nxn Matrix" do
+    m = Matrix[ [20,30], [40.5, 9] ]
+    m.row_size.should == 2
+    m.column_size.should == 2
+    m.column(0).should == Vector[20, 40.5]
+    m.column(1).should == Vector[30, 9]
+    m.row(0).should == Vector[20, 30]
+    m.row(1).should == Vector[40.5, 9]
+  end
+
+  it "can create a 0xn Matrix" do
+    m = Matrix[ [], [], [] ]
+    m.row_size.should == 3
+    m.column_size.should == 0
+  end
+
+  ruby_bug "redmine #5307", "1.9.3" do
+    describe "for a subclass of Matrix" do
+      it "returns an instance of that subclass" do
+        MatrixSub[ [20,30], [40.5, 9] ].should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/det_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../shared/determinant', __FILE__)
+require 'matrix'
+
+describe "Matrix#det" do
+  it_behaves_like(:determinant, :det)
+end

data/spec/determinant_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../shared/determinant', __FILE__)
+require 'matrix'
+
+describe "Matrix#determinant" do
+  it_behaves_like(:determinant, :determinant)
+end

data/spec/diagonal_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe "Matrix.diagonal" do
+  before(:each) do
+    @m = Matrix.diagonal(10, 11, 12, 13, 14)
+  end
+
+  it "returns an object of type Matrix" do
+    @m.should be_kind_of(Matrix)
+  end
+
+  it "returns a square Matrix of the right size" do
+    @m.column_size.should == 5
+    @m.row_size.should == 5
+  end
+
+  it "sets the diagonal to the arguments" do
+    (0..4).each do |i|
+      @m[i, i].should == i + 10
+    end
+  end
+
+  it "fills all non-diagonal cells with 0" do
+    (0..4).each do |i|
+      (0..4).each do |j|
+        if i != j
+          @m[i, j].should == 0
+        end
+      end
+    end
+  end
+
+  describe "for a subclass of Matrix" do
+    it "returns an instance of that subclass" do
+      MatrixSub.diagonal(1).should be_an_instance_of(MatrixSub)
+    end
+  end
+end
+
+ruby_version_is "1.9.3" do
+  describe "Matrix.diagonal?" do
+    it "returns true for a diagonal Matrix" do
+      Matrix.diagonal([1, 2, 3]).diagonal?.should be_true
+    end
+
+    it "returns true for a zero square Matrix" do
+      Matrix.zero(3).diagonal?.should be_true
+    end
+
+    it "returns false for a non diagonal square Matrix" do
+      Matrix[[0, 1], [0, 0]].diagonal?.should be_false
+      Matrix[[1, 2, 3], [1, 2, 3], [1, 2, 3]].diagonal?.should be_false
+    end
+
+    it "returns true for an empty 0x0 matrix" do
+      Matrix.empty(0,0).diagonal?.should be_true
+    end
+
+    it "raises an error for rectangular matrices" do
+      [
+        Matrix[[0], [0]],
+        Matrix[[0, 0]],
+        Matrix.empty(0, 2),
+        Matrix.empty(2, 0),
+      ].each do |rectangual_matrix|
+        lambda {
+          rectangual_matrix.diagonal?
+        }.should raise_error(Matrix::ErrDimensionMismatch)
+      end
+    end
+  end
+end