path: root/test/matrix/test_vector.rb

# frozen_string_literal: false
require 'test/unit'
require 'matrix'

class TestVector < Test::Unit::TestCase
  def setup
    @v1 = Vector[1,2,3]
    @v2 = Vector[1,2,3]
    @v3 = @v1.clone
    @v4 = Vector[1.0, 2.0, 3.0]
    @w1 = Vector[2,3,4]
  end

  def test_zero
    assert_equal Vector[0, 0, 0, 0], Vector.zero(4)
    assert_equal Vector[], Vector.zero(0)
    assert_raise(ArgumentError) { Vector.zero(-1) }
    assert Vector[0, 0, 0, 0].zero?
  end

  def test_basis
    assert_equal(Vector[1, 0, 0], Vector.basis(size: 3, index: 0))
    assert_raise(ArgumentError) { Vector.basis(size: -1, index: 2) }
    assert_raise(ArgumentError) { Vector.basis(size: 4, index: -1) }
    assert_raise(ArgumentError) { Vector.basis(size: 3, index: 3) }
    assert_raise(ArgumentError) { Vector.basis(size: 3) }
    assert_raise(ArgumentError) { Vector.basis(index: 3) }
  end

  def test_get_element
    assert_equal(@v1[0..], [1, 2, 3])
    assert_equal(@v1[0..1], [1, 2])
    assert_equal(@v1[2], 3)
    assert_equal(@v1[4], nil)
  end

  def test_set_element

    assert_block do
      v = Vector[5, 6, 7, 8, 9]
      v[1..2] = Vector[1, 2]
      v == Vector[5, 1, 2, 8, 9]
    end

    assert_block do
      v = Vector[6, 7, 8]
      v[1..2] = Matrix[[1, 3]]
      v == Vector[6, 1, 3]
    end

    assert_block do
      v = Vector[1, 2, 3, 4, 5, 6]
      v[0..2] = 8
      v == Vector[8, 8, 8, 4, 5, 6]
    end

    assert_block do
      v = Vector[1, 3, 4, 5]
      v[2] = 5
      v == Vector[1, 3, 5, 5]
    end

    assert_block do
      v = Vector[2, 3, 5]
      v[-2] = 13
      v == Vector[2, 13, 5]
    end

    assert_block do
      v = Vector[4, 8, 9, 11, 30]
      v[1..-2] = Vector[1, 2, 3]
      v == Vector[4, 1, 2, 3, 30]
    end

    assert_raise(IndexError) {Vector[1, 3, 4, 5][5..6] = 17}
    assert_raise(IndexError) {Vector[1, 3, 4, 5][6] = 17}
    assert_raise(Matrix::ErrDimensionMismatch) {Vector[1, 3, 4, 5][0..2] = Matrix[[1], [2], [3]]}
    assert_raise(ArgumentError) {Vector[1, 2, 3, 4, 5, 6][0..2] = Vector[1, 2, 3, 4, 5, 6]}
    assert_raise(FrozenError) { Vector[7, 8, 9].freeze[0..1] = 5}
  end

  def test_map!
    v1 = Vector[1, 2, 3]
    v2 = Vector[1, 3, 5].freeze
    v3 = Vector[].freeze
    assert_equal Vector[1, 4, 9], v1.map!{|e| e ** 2}
    assert_equal v1, v1.map!{|e| e - 8}
    assert_raise(FrozenError) { v2.map!{|e| e + 2 }}
    assert_raise(FrozenError){ v3.map!{} }
  end

  def test_freeze
    v = Vector[1,2,3]
    f = v.freeze
    assert_equal true, f.frozen?
    assert v.equal?(f)
    assert v.equal?(f.freeze)
    assert_raise(FrozenError){ v[1] = 56 }
    assert_equal v.dup, v
  end

  def test_clone
    a = Vector[4]
    def a.foo
      42
    end

    v = a.clone
    v[0] = 2
    assert_equal a, v * 2
    assert_equal 42, v.foo

    a.freeze
    v = a.clone
    assert v.frozen?
    assert_equal 42, v.foo
  end

  def test_dup
    a = Vector[4]
    def a.foo
      42
    end
    a.freeze

    v = a.dup
    v[0] = 2
    assert_equal a, v * 2
    assert !v.respond_to?(:foo)
  end

  def test_identity
    assert_same @v1, @v1
    assert_not_same @v1, @v2
    assert_not_same @v1, @v3
    assert_not_same @v1, @v4
    assert_not_same @v1, @w1
  end

  def test_equality
    assert_equal @v1, @v1
    assert_equal @v1, @v2
    assert_equal @v1, @v3
    assert_equal @v1, @v4
    assert_not_equal @v1, @w1
  end

  def test_hash_equality
    assert @v1.eql?(@v1)
    assert @v1.eql?(@v2)
    assert @v1.eql?(@v3)
    assert !@v1.eql?(@v4)
    assert !@v1.eql?(@w1)

    hash = { @v1 => :value }
    assert hash.key?(@v1)
    assert hash.key?(@v2)
    assert hash.key?(@v3)
    assert !hash.key?(@v4)
    assert !hash.key?(@w1)
  end

  def test_hash
    assert_equal @v1.hash, @v1.hash
    assert_equal @v1.hash, @v2.hash
    assert_equal @v1.hash, @v3.hash
  end

  def test_aref
    assert_equal(1, @v1[0])
    assert_equal(2, @v1[1])
    assert_equal(3, @v1[2])
    assert_equal(3, @v1[-1])
    assert_equal(nil, @v1[3])
  end

  def test_size
    assert_equal(3, @v1.size)
  end

  def test_each2
    a = []
    @v1.each2(@v4) {|x, y| a << [x, y] }
    assert_equal([[1,1.0],[2,2.0],[3,3.0]], a)
  end

  def test_collect
    a = @v1.collect {|x| x + 1 }
    assert_equal(Vector[2,3,4], a)
  end

  def test_collect2
    a = @v1.collect2(@v4) {|x, y| x + y }
    assert_equal([2.0,4.0,6.0], a)
  end

  def test_map2
    a = @v1.map2(@v4) {|x, y| x + y }
    assert_equal(Vector[2.0,4.0,6.0], a)
  end

  def test_independent?
    assert(Vector.independent?(@v1, @w1))
    assert(
      Vector.independent?(
        Vector.basis(size: 3, index: 0),
        Vector.basis(size: 3, index: 1),
        Vector.basis(size: 3, index: 2),
      )
    )

    refute(Vector.independent?(@v1, Vector[2,4,6]))
    refute(Vector.independent?(Vector[2,4], Vector[1,3], Vector[5,6]))

    assert_raise(TypeError) { Vector.independent?(@v1, 3) }
    assert_raise(Vector::ErrDimensionMismatch) { Vector.independent?(@v1, Vector[2,4]) }

    assert(@v1.independent?(Vector[1,2,4], Vector[1,3,4]))
  end

  def test_mul
    assert_equal(Vector[2,4,6], @v1 * 2)
    assert_equal(Matrix[[1, 4, 9], [2, 8, 18], [3, 12, 27]], @v1 * Matrix[[1,4,9]])
    assert_raise(Matrix::ErrOperationNotDefined) { @v1 * Vector[1,4,9] }
    o = Object.new
    def o.coerce(x)
      [1, 1]
    end
    assert_equal(1, Vector[1, 2, 3] * o)
  end

  def test_add
    assert_equal(Vector[2,4,6], @v1 + @v1)
    assert_equal(Matrix[[2],[6],[12]], @v1 + Matrix[[1],[4],[9]])
    o = Object.new
    def o.coerce(x)
      [1, 1]
    end
    assert_equal(2, Vector[1, 2, 3] + o)
  end

  def test_sub
    assert_equal(Vector[0,0,0], @v1 - @v1)
    assert_equal(Matrix[[0],[-2],[-6]], @v1 - Matrix[[1],[4],[9]])
    o = Object.new
    def o.coerce(x)
      [1, 1]
    end
    assert_equal(0, Vector[1, 2, 3] - o)
  end

  def test_uplus
    assert_equal(@v1, +@v1)
  end

  def test_negate
    assert_equal(Vector[-1, -2, -3], -@v1)
    assert_equal(@v1, -(-@v1))
  end

  def test_inner_product
    assert_equal(1+4+9, @v1.inner_product(@v1))
    assert_equal(1+4+9, @v1.dot(@v1))
  end

  def test_r
    assert_equal(5, Vector[3, 4].r)
  end

  def test_round
    assert_equal(Vector[1.234, 2.345, 3.40].round(2), Vector[1.23, 2.35, 3.4])
  end

  def test_covector
    assert_equal(Matrix[[1,2,3]], @v1.covector)
  end

  def test_to_s
    assert_equal("Vector[1, 2, 3]", @v1.to_s)
  end

  def test_to_matrix
    assert_equal Matrix[[1], [2], [3]], @v1.to_matrix
  end

  def test_inspect
    assert_equal("Vector[1, 2, 3]", @v1.inspect)
  end

  def test_magnitude
    assert_in_epsilon(3.7416573867739413, @v1.norm)
    assert_in_epsilon(3.7416573867739413, @v4.norm)
  end

  def test_complex_magnitude
    bug6966 = '[ruby-dev:46100]'
    v = Vector[Complex(0,1), 0]
    assert_equal(1.0, v.norm, bug6966)
  end

  def test_rational_magnitude
    v = Vector[Rational(1,2), 0]
    assert_equal(0.5, v.norm)
  end

  def test_cross_product
    v = Vector[1, 0, 0].cross_product Vector[0, 1, 0]
    assert_equal(Vector[0, 0, 1], v)
    v2 = Vector[1, 2].cross_product
    assert_equal(Vector[-2, 1], v2)
    v3 = Vector[3, 5, 2, 1].cross(Vector[4, 3, 1, 8], Vector[2, 9, 4, 3])
    assert_equal(Vector[16, -65, 139, -1], v3)
    assert_equal Vector[0, 0, 0, 1],
      Vector[1, 0, 0, 0].cross(Vector[0, 1, 0, 0], Vector[0, 0, 1, 0])
    assert_equal Vector[0, 0, 0, 0, 1],
      Vector[1, 0, 0, 0, 0].cross(Vector[0, 1, 0, 0, 0], Vector[0, 0, 1, 0, 0], Vector[0, 0, 0, 1, 0])
    assert_raise(Vector::ErrDimensionMismatch) { Vector[1, 2, 3].cross_product(Vector[1, 4]) }
    assert_raise(TypeError) { Vector[1, 2, 3].cross_product(42) }
    assert_raise(ArgumentError) { Vector[1, 2].cross_product(Vector[2, -1]) }
    assert_raise(Vector::ErrOperationNotDefined) { Vector[1].cross_product }
  end

  def test_angle_with
    assert_in_epsilon(Math::PI, Vector[1, 0].angle_with(Vector[-1, 0]))
    assert_in_epsilon(Math::PI/2, Vector[1, 0].angle_with(Vector[0, -1]))
    assert_in_epsilon(Math::PI/4, Vector[2, 2].angle_with(Vector[0, 1]))
    assert_in_delta(0.0, Vector[1, 1].angle_with(Vector[1, 1]), 0.00001)
    assert_equal(Vector[6, 6].angle_with(Vector[7, 7]), 0.0)
    assert_equal(Vector[6, 6].angle_with(Vector[-7, -7]), Math::PI)

    assert_raise(Vector::ZeroVectorError) { Vector[1, 1].angle_with(Vector[0, 0]) }
    assert_raise(Vector::ZeroVectorError) { Vector[0, 0].angle_with(Vector[1, 1]) }
    assert_raise(Matrix::ErrDimensionMismatch) { Vector[1, 2, 3].angle_with(Vector[0, 1]) }
  end
end