rubysl-matrix 1.0.0

data/spec/eql_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../shared/equal_value', __FILE__)
+require 'matrix'
+
+describe "Matrix#eql?" do
+  it_behaves_like(:equal, :eql?)
+
+  ruby_bug("[ruby-dev:36298]", "1.8.7") do
+    it "returns false if some elements are == but not eql?" do
+      Matrix[[1, 2],[3, 4]].eql?(Matrix[[1, 2],[3, 4.0]]).should be_false
+    end
+  end
+end

data/spec/equal_value_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../shared/equal_value', __FILE__)
+require 'matrix'
+
+describe "Matrix#==" do
+  it_behaves_like(:equal, :==)
+
+  it "returns true if some elements are == but not eql?" do
+    Matrix[[1, 2],[3, 4]].should == Matrix[[1, 2],[3, 4.0]]
+  end
+end

data/spec/exponent_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe "Matrix#**" do
+
+  describe "given an integer _n_" do
+    it "multiples the Matrix by itself _n_ times" do
+      m = Matrix[ [7,6], [3,9] ]
+      (m ** 1).should == m
+      (m ** 2).should == Matrix[ [67, 96], [48,99] ]
+      (m ** 2).should == m * m
+      (m ** 3).should == m * m * m
+      (m ** 4).should == m * m * m * m
+      (m ** 5).should == m * m * m * m * m
+    end
+
+    it "raises a ErrDimensionMismatch for non square matrices" do
+      m = Matrix[ [1, 1], [1, 2], [2, 3]]
+      lambda { m ** 3 }.should raise_error(Matrix::ErrDimensionMismatch)
+      lambda { m ** 0 }.should raise_error(Matrix::ErrDimensionMismatch)
+    end
+
+    describe "that is <= 0" do
+      it "returns the inverse of **(-n)" do
+        m = Matrix[ [1, 1], [1, 2] ]
+        (m ** -2).should == Matrix[ [5, -3], [-3, 2]]
+        (m ** -4).should == (m.inverse ** 4)
+      end
+
+      it "raises a ErrDimensionMismatch for irregular matrices" do
+        m = Matrix[ [1, 1], [1, 1] ]
+        lambda { m ** -2 }.should raise_error(Matrix::ErrNotRegular)
+        lambda { m ** 0 }.should raise_error(Matrix::ErrNotRegular)
+      end
+    end
+  end
+
+  ruby_version_is "" ... "1.9.1" do
+    it "raises a ErrOperationNotDefined exception for powers that aren't Integers" do
+      lambda {Matrix[ [1,2], [8,2] ] ** 2.5}.should \
+	raise_error(Matrix::ErrOperationNotDefined)
+    end
+  end
+
+  ruby_version_is "1.9.1" ... "1.9.3" do
+    it "raises a ErrOperationNotImplemented exception for powers that aren't Integers" do
+      lambda {Matrix[ [1,2], [8,2] ] ** 2.5}.should \
+	raise_error(Matrix::ErrOperationNotImplemented)
+    end
+  end
+
+  ruby_version_is "1.9.3" do
+    it "returns the power for non integer powers" do
+      a = Matrix[[5, 4], [4, 5]]
+      ((a ** 0.5) ** 2).round(8).should == a
+      a = Matrix[[7, 10], [15, 22]]
+      ((a ** 0.25) ** 4).round(8).should == a
+    end
+  end
+
+  describe "for a subclass of Matrix" do
+    it "returns an instance of that subclass" do
+      (MatrixSub.ins ** 1).should be_an_instance_of(MatrixSub)
+    end
+  end
+end

data/spec/find_index_spec.rb

@@ -0,0 +1,147 @@
+require 'matrix'
+
+ruby_version_is "1.9.3" do
+  describe "Matrix#find_index without any argument" do
+    before :all do
+      @m = Matrix[ [1, 2, 3, 4], [5, 6, 7, 8] ]
+    end
+
+    it "returns an Enumerator when called without a block" do
+      enum = @m.find_index
+      enum.should be_an_instance_of(enumerator_class)
+      enum.to_a.should == [1, 2, 3, 4, 5, 6, 7, 8]
+    end
+
+    it "returns nil if the block is always false" do
+      @m.find_index{false}.should be_nil
+    end
+
+    it "returns the first index for which the block is true" do
+      @m.find_index{|x| x >= 3}.should == [0, 2]
+    end
+  end
+
+  describe "Matrix#find_index with a subselection argument" do
+    before :all do
+      @tests = [
+      [  Matrix[ [1, 2, 3, 4], [5, 6, 7, 8] ], {
+          :diagonal => [1, 6]               ,
+          :off_diagonal => [2, 3, 4, 5, 7, 8],
+          :lower => [1, 5, 6]               ,
+          :strict_lower => [5]              ,
+          :strict_upper => [2, 3, 4, 7, 8]  ,
+          :upper => [1, 2, 3, 4, 6, 7, 8]   ,
+        }
+      ],
+      [  Matrix[ [1, 2], [3, 4], [5, 6], [7, 8] ], {
+          :diagonal => [1, 4]               ,
+          :off_diagonal => [2, 3, 5, 6, 7, 8],
+          :lower => [1, 3, 4, 5, 6, 7, 8]   ,
+          :strict_lower => [3, 5, 6, 7, 8]  ,
+          :strict_upper => [2]              ,
+          :upper => [1, 2, 4]               ,
+        }
+      ]]
+    end
+
+    describe "and no generic argument" do
+      it "returns an Enumerator when called without a block" do
+        @tests.each do |matrix, h|
+          h.each do |selector, result|
+            matrix.find_index(selector).should be_an_instance_of(enumerator_class)
+          end
+        end
+      end
+
+      it "yields the rights elements" do
+        @tests.each do |matrix, h|
+          h.each do |selector, result|
+            matrix.find_index(selector).to_a.should == result
+          end
+        end
+      end
+
+      it "returns the first index for which the block returns true" do
+        @tests.each do |matrix, h|
+          h.each do |selector, result|
+            cnt = result.size.div 2
+            which = result[cnt]
+            idx = matrix.find_index(selector){|x| cnt -= 1; x == which}
+            matrix[*idx].should == which
+            cnt.should == -1
+          end
+        end
+      end
+
+      it "returns nil if the block is always false" do
+        @tests.each do |matrix, h|
+          h.each do |selector, result|
+            matrix.find_index(selector){ nil }.should == nil
+          end
+        end
+      end
+
+    end
+
+    describe "and a generic argument" do
+      it "ignores a block" do
+        @m.find_index(42, :diagonal){raise "oups"}.should == nil
+      end
+
+      it "returns the index of the requested value" do
+        @tests.each do |matrix, h|
+          h.each do |selector, result|
+            cnt = result.size / 2
+            which = result[cnt]
+            idx = matrix.find_index(which, selector)
+            matrix[*idx].should == which
+          end
+        end
+      end
+
+      it "returns nil if the requested value is not found" do
+        @tests.each do |matrix, h|
+          h.each do |selector, result|
+            matrix.find_index(42, selector).should == nil
+          end
+        end
+      end
+    end
+
+  end
+
+  describe "Matrix#find_index with only a generic argument" do
+    before :all do
+      @m = Matrix[ [1, 2, 3, 4], [1, 2, 3, 4] ]
+    end
+
+    it "returns nil if the value is not found" do
+      @m.find_index(42).should be_nil
+    end
+
+    it "returns the first index for of the requested value" do
+      @m.find_index(3).should == [0, 2]
+    end
+
+    it "ignores a block" do
+      @m.find_index(4){raise "oups"}.should == [0, 3]
+    end
+  end
+
+  describe "Matrix#find_index with two arguments" do
+    it "raises an ArgumentError for an unrecognized last argument" do
+      lambda {
+        @m.find_index(1, "all"){}
+      }.should raise_error(ArgumentError)
+      lambda {
+        @m.find_index(1, nil){}
+      }.should raise_error(ArgumentError)
+      lambda {
+        @m.find_index(1, :left){}
+      }.should raise_error(ArgumentError)
+      lambda {
+        @m.find_index(:diagonal, 1){}
+      }.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/fixtures/classes.rb

@@ -0,0 +1,7 @@
+require 'matrix'
+
+class MatrixSub < Matrix
+  def self.ins
+    rows([[1, 0], [0, 1]])
+  end
+end

data/spec/hash_spec.rb

@@ -0,0 +1,14 @@
+require 'matrix'
+
+describe "Matrix#hash" do
+
+  it "returns a Fixnum" do
+    Matrix[ [1,2] ].hash.should be_an_instance_of(Fixnum)
+  end
+
+  it "returns the same value for the same matrix" do
+    data = [ [40,5], [2,7] ]
+    Matrix[ *data ].hash.should == Matrix[ *data ].hash
+  end
+
+end

data/spec/hermitian_spec.rb

@@ -0,0 +1,37 @@
+require 'matrix'
+
+ruby_version_is "1.9.3" do
+  describe "Matrix.hermitian?" do
+    it "returns true for a hermitian Matrix" do
+      Matrix[[1, 2, Complex(0, 3)], [2, 4, 5], [Complex(0, -3), 5, 6]].hermitian?.should be_true
+    end
+
+    it "returns true for a 0x0 empty matrix" do
+      Matrix.empty.hermitian?.should be_true
+    end
+
+    it "returns false for an assymetric Matrix" do
+      Matrix[[1, 2],[-2, 1]].hermitian?.should be_false
+    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.hermitian?
+        }.should raise_error(Matrix::ErrDimensionMismatch)
+      end
+    end
+
+    ruby_bug "redmine:6290", "1.9.3" do
+      it "returns false for a matrix with complex values on the diagonal" do
+        Matrix[[Complex(1,1)]].hermitian?.should be_false
+        Matrix[[Complex(1,0)]].hermitian?.should be_true
+      end
+    end
+  end
+end

data/spec/identity_spec.rb

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

data/spec/imag_spec.rb

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

data/spec/imaginary_spec.rb

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

data/spec/inspect_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe "Matrix#inspect" do
+
+  it "returns a stringified representation of the Matrix" do
+    Matrix[ [1,2], [2,1] ].inspect.should == "Matrix[[1, 2], [2, 1]]"
+  end
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "returns 'Matrix.empty(...)' for empty matrices" do
+      Matrix[ [], [], [] ].inspect.should == "Matrix.empty(3, 0)"
+      Matrix.columns([ [], [], [] ]).inspect.should == "Matrix.empty(0, 3)"
+    end
+  end
+
+  it "calls inspect on its contents" do
+    obj = mock("some_value")
+    obj.should_receive(:inspect).and_return("some_value")
+    Matrix[ [1, 2], [3, obj] ].inspect.should == "Matrix[[1, 2], [3, some_value]]"
+  end
+
+  ruby_bug "redmine #5307", "1.9.3" do
+    describe "for a subclass of Matrix" do
+      it "returns a string using the subclass' name" do
+        MatrixSub.ins.inspect.should == "MatrixSub[[1, 0], [0, 1]]"
+      end
+    end
+  end
+end

data/spec/inv_spec.rb

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

data/spec/inverse_from_spec.rb

@@ -0,0 +1,5 @@
+require 'matrix'
+
+describe "Matrix#inverse_from" do
+  it "needs to be reviewed for spec completeness"
+end

data/spec/inverse_spec.rb

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

data/spec/lower_triangular_spec.rb

@@ -0,0 +1,25 @@
+require 'matrix'
+
+ruby_version_is "1.9.3" do
+  describe "Matrix.lower_triangular?" do
+    it "returns true for a square lower triangular Matrix" do
+      Matrix[[1, 0, 0], [1, 2, 0], [1, 2, 3]].lower_triangular?.should be_true
+      Matrix.diagonal([1, 2, 3]).lower_triangular?.should be_true
+      Matrix[[1, 0], [1, 2], [1, 2], [1, 2]].lower_triangular?.should be_true
+      Matrix[[1, 0, 0, 0], [1, 2, 0, 0]].lower_triangular?.should be_true
+    end
+
+    it "returns true for an empty Matrix" do
+      Matrix.empty(3, 0).lower_triangular?.should be_true
+      Matrix.empty(0, 3).lower_triangular?.should be_true
+      Matrix.empty(0, 0).lower_triangular?.should be_true
+    end
+
+    it "returns false for a non lower triangular square Matrix" do
+      Matrix[[0, 1], [0, 0]].lower_triangular?.should be_false
+      Matrix[[1, 2, 3], [1, 2, 3], [1, 2, 3]].lower_triangular?.should be_false
+      Matrix[[0, 1], [0, 0], [0, 0], [0, 0]].lower_triangular?.should be_false
+      Matrix[[0, 0, 0, 1], [0, 0, 0, 0]].lower_triangular?.should be_false
+    end
+  end
+end

data/spec/lup_decomposition/determinant_spec.rb

@@ -0,0 +1,24 @@
+require 'matrix'
+
+ruby_version_is "1.9.3" do
+  describe "Matrix::LUPDecomposition#determinant" do
+    it "returns the determinant when the matrix is square" do
+      a = Matrix[[7, 8, 9], [14, 46, 51], [28, 82, 163]]
+      a.lup.determinant.should == 15120 # == a.determinant
+    end
+
+    ruby_bug "#7620", "1.9.3" do
+      it "raises an error for rectangular matrices" do
+        [
+          Matrix[[7, 8, 9], [14, 46, 51]],
+          Matrix[[7, 8], [14, 46], [28, 82]],
+        ].each do |m|
+          lup = m.lup
+          lambda {
+            lup.determinant
+          }.should raise_error(Matrix::ErrDimensionMismatch)
+        end
+      end
+    end
+  end
+end

data/spec/lup_decomposition/initialize_spec.rb

@@ -0,0 +1,14 @@
+require 'matrix'
+
+ruby_version_is "1.9.3" do
+  describe "Matrix::LUPDecomposition#initialize" do
+    it "raises an error if argument is not a matrix" do
+      lambda {
+        Matrix::LUPDecomposition.new([[]])
+      }.should raise_error(TypeError)
+      lambda {
+        Matrix::LUPDecomposition.new(42)
+      }.should raise_error(TypeError)
+    end
+  end
+end