rubysl-matrix 1.0.0

data/spec/shared/collect.rb

@@ -0,0 +1,29 @@
+require 'matrix'
+
+describe :collect, :shared => true do
+  before :all do
+    @m = Matrix[ [1, 2], [1, 2] ]
+  end
+
+  it "returns an instance of Matrix" do
+    @m.send(@method){|n| n * 2 }.should be_kind_of(Matrix)
+  end
+
+  it "returns a Matrix where each element is the result of the block" do
+    @m.send(@method) { |n| n * 2 }.should == Matrix[ [2, 4], [2, 4] ]
+  end
+
+  ruby_bug "#1531", "1.8.7" do
+    it "returns an enumerator if no block is given" do
+      @m.send(@method).should be_an_instance_of(enumerator_class)
+    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.send(@method){1}.should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/shared/conjugate.rb

@@ -0,0 +1,21 @@
+require 'matrix'
+
+describe :matrix_conjugate, :shared => true do
+  it "returns a matrix with all entries 'conjugated'" do
+    Matrix[ [1,   2], [3, 4] ].send(@method).should == Matrix[ [1,   2], [3, 4] ]
+    Matrix[ [1.9, Complex(1,1)], [3, 4] ].send(@method).should == Matrix[ [1.9, Complex(1,-1)], [3, 4] ]
+  end
+
+  it "returns empty matrices on the same size if empty" do
+    Matrix.empty(0, 3).send(@method).should == Matrix.empty(0, 3)
+    Matrix.empty(3, 0).send(@method).should == Matrix.empty(3, 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.ins.send(@method).should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/shared/determinant.rb

@@ -0,0 +1,53 @@
+require 'matrix'
+
+describe :determinant, :shared => true do
+  # Ruby versions less than 1.9.0, AFAICT, return the wrong determinant in
+  # most non-trivial cases. As the rdoc for Matrix suggests, "require 'mathn'"
+  # seems to fix this, but as Matrix doesn't require that library itself, the
+  # bug remains. I've reported http://redmine.ruby-lang.org/issues/show/1516 ,
+  # which is ostensibly about the documentation for #determinant not
+  # reflecting this bug, but raises the question of why 1.8.7 doesn't handle
+  # this properly.
+  ruby_bug "#1516", "1.8.7" do
+    it "returns the determinant of a square Matrix" do
+      m = Matrix[ [7,6], [3,9] ]
+      m.send(@method).should == 45
+
+      m = Matrix[ [9, 8], [6,5] ]
+      m.send(@method).should == -3
+
+      m = Matrix[ [9,8,3], [4,20,5], [1,1,1] ]
+      m.send(@method).should == 95
+    end
+  end
+
+  it "returns the determinant of a single-element Matrix" do
+    m = Matrix[ [2] ]
+    m.send(@method).should == 2
+  end
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "returns 1 for an empty Matrix" do
+      m = Matrix[ ]
+      m.send(@method).should == 1
+    end
+  end
+
+  ruby_bug "#1531", "1.8.7" do
+    it "returns the determinant even for Matrices containing 0 as first entry" do
+      Matrix[[0,1],[1,0]].send(@method).should == -1
+    end
+  end
+
+  ruby_bug "#2770", "1.8.7" do
+    it "raises an error for rectangular matrices" do
+      lambda {
+        Matrix[[1], [2], [3]].send(@method)
+      }.should raise_error(Matrix::ErrDimensionMismatch)
+
+      lambda {
+        Matrix.empty(3,0).send(@method)
+      }.should raise_error(Matrix::ErrDimensionMismatch)
+    end
+  end
+end

data/spec/shared/equal_value.rb

@@ -0,0 +1,35 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe :equal, :shared => true do
+  before do
+    @matrix = Matrix[ [1, 2, 3, 4, 5], [2, 3, 4, 5, 6] ]
+  end
+
+  it "returns true for self" do
+    @matrix.send(@method, @matrix).should be_true
+  end
+
+  it "returns true for equal matrices" do
+    @matrix.send(@method, Matrix[ [1, 2, 3, 4, 5], [2, 3, 4, 5, 6] ]).should be_true
+  end
+
+  it "returns false for different matrices" do
+    @matrix.send(@method, Matrix[ [42, 2, 3, 4, 5], [2, 3, 4, 5, 6] ]).should be_false
+    @matrix.send(@method, Matrix[ [1, 2, 3, 4, 5, 6], [2, 3, 4, 5, 6, 7] ]).should be_false
+    @matrix.send(@method, Matrix[ [1, 2, 3], [2, 3, 4] ]).should be_false
+  end
+
+  ruby_version_is "1.8.8" do
+    it "returns false for different empty matrices" do
+      Matrix.empty(42, 0).send(@method, Matrix.empty(6, 0)).should be_false
+      Matrix.empty(0, 42).send(@method, Matrix.empty(0, 6)).should be_false
+      Matrix.empty(0, 0).send(@method, Matrix.empty(6, 0)).should be_false
+      Matrix.empty(0, 0).send(@method, Matrix.empty(0, 6)).should be_false
+    end
+  end
+
+  it "doesn't distinguish on subclasses" do
+    MatrixSub.ins.send(@method, Matrix.I(2)).should be_true
+  end
+end

data/spec/shared/identity.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe :matrix_identity, :shared => true do
+  it "returns a Matrix" do
+    Matrix.send(@method, 2).should be_kind_of(Matrix)
+  end
+
+  it "returns a n x n identity matrix" do
+    Matrix.send(@method, 3).should == Matrix.scalar(3, 1)
+    Matrix.send(@method, 100).should == Matrix.scalar(100, 1)
+  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.send(@method, 2).should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/shared/imaginary.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe :matrix_imaginary, :shared => true do
+  it "returns a matrix with the imaginary part of the elements of the receiver" do
+    Matrix[ [1,   2], [3, 4] ].send(@method).should == Matrix[ [0,   0], [0, 0] ]
+    Matrix[ [1.9, Complex(1,1)], [Complex(-2,0.42), 4] ].send(@method).should == Matrix[ [0, 1], [0.42, 0] ]
+  end
+
+  it "returns empty matrices on the same size if empty" do
+    Matrix.empty(0, 3).send(@method).should == Matrix.empty(0, 3)
+    Matrix.empty(3, 0).send(@method).should == Matrix.empty(3, 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.ins.send(@method).should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/shared/inverse.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe :inverse, :shared => true do
+
+  it "returns a Matrix" do
+    Matrix[ [1,2], [2,1] ].send(@method).should be_an_instance_of(Matrix)
+  end
+
+  it "returns the inverse of the Matrix" do
+    Matrix[
+      [1, 3, 3],     [1, 4, 3],  [1, 3, 4]
+    ].send(@method).should ==
+    Matrix[
+      [7, -3, -3],   [-1, 1, 0], [-1, 0, 1]
+    ]
+  end
+
+  ruby_bug "?", "1.8.7" do
+    it "returns the inverse of the Matrix (other case)" do
+      Matrix[
+        [1, 2, 3],    [0, 1, 4],     [5, 6, 0]
+      ].send(@method).should be_close_to_matrix([
+        [-24, 18, 5], [20, -15, -4], [-5, 4, 1]
+      ])
+    end
+  end
+
+  it "raises a ErrDimensionMismatch if the Matrix is not square" do
+    lambda{
+      Matrix[ [1,2,3], [1,2,3] ].send(@method)
+    }.should raise_error(Matrix::ErrDimensionMismatch)
+  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.send(@method).should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/shared/rectangular.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe :matrix_rectangular, :shared => true do
+  it "returns [receiver.real, receiver.imag]" do
+    m = Matrix[ [1.2, Complex(1,2)], [Complex(-2,0.42), 4] ]
+    m.send(@method).should == [m.real, m.imag]
+
+    m = Matrix.empty(3, 0)
+    m.send(@method).should == [m.real, m.imag]
+  end
+
+  ruby_bug "redmine #5307", "1.9.3" do
+    describe "for a subclass of Matrix" do
+      it "returns instances of that subclass" do
+        MatrixSub.ins.send(@method).each{|m| m.should be_an_instance_of(MatrixSub) }
+      end
+    end
+  end
+end

data/spec/shared/trace.rb

@@ -0,0 +1,14 @@
+require 'matrix'
+
+describe :trace, :shared => true do
+  it "returns the sum of diagonal elements in a square Matrix" do
+    Matrix[[7,6], [3,9]].trace.should == 16
+  end
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "returns the sum of diagonal elements in a rectangular Matrix" do
+      lambda{ Matrix[[1,2,3], [4,5,6]].trace}.should raise_error(Matrix::ErrDimensionMismatch)
+    end
+  end
+
+end

data/spec/shared/transpose.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../../fixtures/classes', __FILE__)
+require 'matrix'
+
+describe :matrix_transpose, :shared => true do
+  it "returns a transposed matrix" do
+    Matrix[[1, 2], [3, 4], [5, 6]].send(@method).should == Matrix[[1, 3, 5], [2, 4, 6]]
+  end
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "can transpose empty matrices" do
+      m = Matrix[[], [], []]
+      m.send(@method).send(@method).should == m
+    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.send(@method).should be_an_instance_of(MatrixSub)
+      end
+    end
+  end
+end

data/spec/singular_spec.rb

@@ -0,0 +1,34 @@
+require 'matrix'
+
+describe "Matrix#singular?" do
+  ruby_bug "#1020", "1.8.7" do
+    it "returns true for singular matrices" do
+      m = Matrix[ [1,2,3], [3,4,3], [0,0,0] ]
+      m.singular?.should be_true
+
+      m = Matrix[ [1,2,9], [3,4,9], [1,2,9] ]
+      m.singular?.should be_true
+    end
+
+    it "returns false if the Matrix is regular" do
+      Matrix[ [0,1], [1,0] ].singular?.should be_false
+    end
+  end
+
+  ruby_bug "", "1.8.7" do
+    it "returns false for an empty 0x0 matrix" do
+      Matrix.empty(0,0).singular?.should be_false
+    end
+
+    it "raises an error for rectangular matrices" do
+       lambda {
+         Matrix[[1], [2], [3]].singular?
+       }.should raise_error(Matrix::ErrDimensionMismatch)
+
+       lambda {
+         Matrix.empty(3,0).singular?
+       }.should raise_error(Matrix::ErrDimensionMismatch)
+     end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+class BeCloseToMatrixMatcher
+  def initialize(expected, tolerance = TOLERANCE)
+    SpecExpectation.matcher! rescue "Used with the balance_should_and_match branch of mspec"
+    @expected = Matrix[*expected]
+    @tolerance = tolerance
+  end
+
+  def matches?(actual)
+    @actual = actual
+    return false unless @actual.is_a? Matrix
+    return false unless @actual.row_size == @expected.row_size
+    @actual.row_size.times do |i|
+      a, e = @actual.row(i), @expected.row(i)
+      return false unless a.size == e.size
+      a.size.times do |j|
+        return false unless (a[j] - e[j]).abs < @tolerance
+      end
+    end
+    true
+  end
+
+  def failure_message
+    ["Expected #{@expected}", "to be within +/- #{@tolerance} of #{@actual}"]
+  end
+
+  def negative_failure_message
+    ["Expected #{@expected}", "not to be within +/- #{@tolerance} of #{@actual}"]
+  end
+end
+
+class Object
+  def be_close_to_matrix(expected, tolerance = TOLERANCE)
+    BeCloseToMatrixMatcher.new(expected, tolerance)
+  end
+end

data/spec/square_spec.rb

@@ -0,0 +1,29 @@
+require 'matrix'
+
+describe "Matrix#square?" do
+
+  it "returns true when the Matrix is square" do
+    Matrix[ [1,2], [2,4] ].square?.should be_true
+    Matrix[ [100,3,5], [9.5, 4.9, 8], [2,0,77] ].square?.should be_true
+  end
+
+  it "returns true when the Matrix has only one element" do
+    Matrix[ [9] ].square?.should be_true
+  end
+
+  it "returns false when the Matrix is rectangular" do
+    Matrix[ [1, 2] ].square?.should be_false
+  end
+
+  it "returns false when the Matrix is rectangular" do
+    Matrix[ [1], [2] ].square?.should be_false
+  end
+
+  ruby_bug "redmine:1532", "1.8.7" do
+    it "returns handles empty matrices" do
+      Matrix[].square?.should be_true
+      Matrix[[]].square?.should be_false
+      Matrix.columns([[]]).square?.should be_false
+    end
+  end
+end

data/spec/symmetric_spec.rb

@@ -0,0 +1,30 @@
+require 'matrix'
+
+ruby_version_is "1.9.3" do
+  describe "Matrix.symmetric?" do
+    it "returns true for a symmetric Matrix" do
+      Matrix[[1, 2, Complex(0, 3)], [2, 4, 5], [Complex(0, 3), 5, 6]].symmetric?.should be_true
+    end
+
+    it "returns true for a 0x0 empty matrix" do
+      Matrix.empty.symmetric?.should be_true
+    end
+
+    it "returns false for an assymetric Matrix" do
+      Matrix[[1, 2],[-2, 1]].symmetric?.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.symmetric?
+        }.should raise_error(Matrix::ErrDimensionMismatch)
+      end
+    end
+  end
+end

data/spec/t_spec.rb

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

data/spec/to_a_spec.rb

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

data/spec/to_s_spec.rb

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