Class: Vector (Ruby 2.3.4)

Home Classes Methods

In Files

matrix.rb

Parent

Object

Namespace

CLASS Vector::ZeroVectorError

Methods

::[]
::basis
::elements
::independent?
::new
#*
#+
#+@
#-
#-@
#/
#==
#[]
#angle_with
#clone
#coerce
#collect
#collect2
#component
#covector
#cross
#cross_product
#dot
#each
#each2
#element
#elements_to_f
#elements_to_i
#elements_to_r
#eql?
#hash
#independent?
#inner_product
#inspect
#magnitude
#map
#map2
#norm
#normalize
#r
#round
#size
#to_a
#to_s

Included Modules

Enumerable

Class/Module Index

Vector

The Vector class represents a mathematical vector, which is useful in its own right, and also constitutes a row or column of a Matrix.

Method Catalogue¶ ↑

To create a Vector:

::[]
::elements(array, copy = true)
::basis(size: n, index: k)

To access elements:

[](i)

To enumerate the elements:

Properties of vectors:

Vector arithmetic:

#*(x) “is matrix or number”
#+(v)
#-(v)
#/(v)
#+@
#-@

Vector functions:

Conversion to other data types:

String representations:

to_s
inspect

Attributes

elements[R]

INSTANCE CREATION

Public Class Methods

[](*array)

Creates a Vector from a list of elements.

Vector[7, 4, ...]

 
               # File matrix.rb, line 1745
def Vector.[](*array)
  new convert_to_array(array, false)
end

basis(size:, index:)

Returns a standard basis n-vector, where k is the index.

Vector.basis(size:, index:) # => Vector[0, 1, 0]

 
               # File matrix.rb, line 1762
def Vector.basis(size,, index))
  raise ArgumentError, "invalid size (#{size} for 1..)" if size < 1
  raise ArgumentError, "invalid index (#{index} for 0...#{size})" unless 0 <= index && index < size
  array = Array.new(size, 0)
  array[index] = 1
  new convert_to_array(array, false)
end

elements(array, copy = true)

Creates a vector from an Array. The optional second argument specifies whether the array itself or a copy is used internally.

 
               # File matrix.rb, line 1753
def Vector.elements(array, copy = true)
  new convert_to_array(array, copy)
end

independent?(*vs)

Returns true iff all of vectors are linearly independent.

Vector.independent?(Vector[1,0], Vector[0,1])
  => true

Vector.independent?(Vector[1,2], Vector[2,4])
  => false

 
               # File matrix.rb, line 1862
def Vector.independent?(*vs)
  vs.each do |v|
    raise TypeError, "expected Vector, got #{v.class}" unless v.is_a?(Vector)
    Vector.Raise ErrDimensionMismatch unless v.size == vs.first.size
  end
  return false if vs.count > vs.first.size
  Matrix[*vs].rank.eql?(vs.count)
end

new(array)

::new is private; use Vector[] or ::elements to create.

 
               # File matrix.rb, line 1773
def initialize(array)
  # No checking is done at this point.
  @elements = array
end

Public Instance Methods

*(x)

Multiplies the vector by x, where x is a number or a matrix.

 
               # File matrix.rb, line 1922
def *(x)
  case x
  when Numeric
    els = @elements.collect{|e| e * x}
    self.class.elements(els, false)
  when Matrix
    Matrix.column_vector(self) * x
  when Vector
    Vector.Raise ErrOperationNotDefined, "*", self.class, x.class
  else
    apply_through_coercion(x, __method__)
  end
end

+(v)

Vector addition.

 
               # File matrix.rb, line 1939
def +(v)
  case v
  when Vector
    Vector.Raise ErrDimensionMismatch if size != v.size
    els = collect2(v) {|v1, v2|
      v1 + v2
    }
    self.class.elements(els, false)
  when Matrix
    Matrix.column_vector(self) + v
  else
    apply_through_coercion(v, __method__)
  end
end

+@()

 
               # File matrix.rb, line 1987
def +@
  self
end

-(v)

Vector subtraction.

 
               # File matrix.rb, line 1957
def -(v)
  case v
  when Vector
    Vector.Raise ErrDimensionMismatch if size != v.size
    els = collect2(v) {|v1, v2|
      v1 - v2
    }
    self.class.elements(els, false)
  when Matrix
    Matrix.column_vector(self) - v
  else
    apply_through_coercion(v, __method__)
  end
end

-@()

 
               # File matrix.rb, line 1991
def -@
  collect {|e| -e }
end

/(x)

Vector division.

 
               # File matrix.rb, line 1975
def /(x)
  case x
  when Numeric
    els = @elements.collect{|e| e / x}
    self.class.elements(els, false)
  when Matrix, Vector
    Vector.Raise ErrOperationNotDefined, "/", self.class, x.class
  else
    apply_through_coercion(x, __method__)
  end
end

==(other)

Returns true iff the two vectors have the same elements in the same order.

 
               # File matrix.rb, line 1891
def ==(other)
  return false unless Vector === other
  @elements == other.elements
end

[](i)

Returns element number i (starting at zero) of the vector.

 
               # File matrix.rb, line 1783
def [](i)
  @elements[i]
end

Also aliased as: element, component

angle_with(v)

Returns an angle with another vector. Result is within the [0…Math::PI].

Vector[1,0].angle_with(Vector[0,1])
# => Math::PI / 2

 
               # File matrix.rb, line 2096
def angle_with(v)
  raise TypeError, "Expected a Vector, got a #{v.class}" unless v.is_a?(Vector)
  Vector.Raise ErrDimensionMismatch if size != v.size
  prod = magnitude * v.magnitude
  raise ZeroVectorError, "Can't get angle of zero vector" if prod == 0

  Math.acos( inner_product(v) / prod )
end

clone()

Returns a copy of the vector.

 
               # File matrix.rb, line 1904
def clone
  self.class.elements(@elements)
end

coerce(other)

The coerce method provides support for Ruby type coercion. This coercion mechanism is used by Ruby to handle mixed-type numeric operations: it is intended to find a compatible common type between the two operands of the operator. See also Numeric#coerce.

 
               # File matrix.rb, line 2145
def coerce(other)
  case other
  when Numeric
    return Matrix::Scalar.new(other), self
  else
    raise TypeError, "#{self.class} can't be coerced into #{other.class}"
  end
end

collect()

Like Array#collect.

 
               # File matrix.rb, line 2051
def collect(&block) # :yield: e
  return to_enum(:collect) unless block_given?
  els = @elements.collect(&block)
  self.class.elements(els, false)
end

Also aliased as: map

collect2(v)

Collects (as in Enumerable#collect) over the elements of this vector and v in conjunction.

 
               # File matrix.rb, line 1840
def collect2(v) # :yield: e1, e2
  raise TypeError, "Integer is not like Vector" if v.kind_of?(Integer)
  Vector.Raise ErrDimensionMismatch if size != v.size
  return to_enum(:collect2, v) unless block_given?
  Array.new(size) do |i|
    yield @elements[i], v[i]
  end
end

component(i)

Alias for: []

covector()

Creates a single-row matrix from this vector.

 
               # File matrix.rb, line 2112
def covector
  Matrix.row_vector(self)
end

cross(*vs)

Alias for: cross_product

cross_product(*vs)

Returns the cross product of this vector with the others.

Vector[1, 0, 0].cross_product Vector[0, 1, 0]   => Vector[0, 0, 1]

It is generalized to other dimensions to return a vector perpendicular to the arguments.

Vector[1, 2].cross_product # => Vector[-2, 1]
Vector[1, 0, 0, 0].cross_product(
   Vector[0, 1, 0, 0],
   Vector[0, 0, 1, 0]
)  #=> Vector[0, 0, 0, 1]

 
               # File matrix.rb, line 2026
def cross_product(*vs)
  raise ErrOperationNotDefined, "cross product is not defined on vectors of dimension #{size}" unless size >= 2
  raise ArgumentError, "wrong number of arguments (#{vs.size} for #{size - 2})" unless vs.size == size - 2
  vs.each do |v|
    raise TypeError, "expected Vector, got #{v.class}" unless v.is_a? Vector
    Vector.Raise ErrDimensionMismatch unless v.size == size
  end
  case size
  when 2
    Vector[-@elements[1], @elements[0]]
  when 3
    v = vs[0]
    Vector[ v[2]*@elements[1] - v[1]*@elements[2],
      v[0]*@elements[2] - v[2]*@elements[0],
      v[1]*@elements[0] - v[0]*@elements[1] ]
  else
    rows = self, *vs, Array.new(size) {|i| Vector.basis(size: size, index: i) }
    Matrix.rows(rows).laplace_expansion(row: size - 1)
  end
end

Also aliased as: cross

dot(v)

Alias for: inner_product

each(&block)

Iterate over the elements of this vector

 
               # File matrix.rb, line 1817
def each(&block)
  return to_enum(:each) unless block_given?
  @elements.each(&block)
  self
end

each2(v)

Iterate over the elements of this vector and v in conjunction.

 
               # File matrix.rb, line 1826
def each2(v) # :yield: e1, e2
  raise TypeError, "Integer is not like Vector" if v.kind_of?(Integer)
  Vector.Raise ErrDimensionMismatch if size != v.size
  return to_enum(:each2, v) unless block_given?
  size.times do |i|
    yield @elements[i], v[i]
  end
  self
end

element(i)

Alias for: []

elements_to_f()

 
               # File matrix.rb, line 2123
def elements_to_f
  warn "#{caller(1)[0]}: warning: Vector#elements_to_f is deprecated"
  map(&:to_f)
end

elements_to_i()

 
               # File matrix.rb, line 2128
def elements_to_i
  warn "#{caller(1)[0]}: warning: Vector#elements_to_i is deprecated"
  map(&:to_i)
end

elements_to_r()

 
               # File matrix.rb, line 2133
def elements_to_r
  warn "#{caller(1)[0]}: warning: Vector#elements_to_r is deprecated"
  map(&:to_r)
end

eql?(other)

 
               # File matrix.rb, line 1896
def eql?(other)
  return false unless Vector === other
  @elements.eql? other.elements
end

hash()

Returns a hash-code for the vector.

 
               # File matrix.rb, line 1911
def hash
  @elements.hash
end

independent?(*vs)

Returns true iff all of vectors are linearly independent.

Vector[1,0].independent?(Vector[0,1])
  => true

Vector[1,2].independent?(Vector[2,4])
  => false

 
               # File matrix.rb, line 1880
def independent?(*vs)
  self.class.independent?(self, *vs)
end

inner_product(v)

Returns the inner product of this vector with the other.

Vector[4,7].inner_product Vector[10,1]  => 47

 
               # File matrix.rb, line 2003
def inner_product(v)
  Vector.Raise ErrDimensionMismatch if size != v.size

  p = 0
  each2(v) {|v1, v2|
    p += v1 * v2.conj
  }
  p
end

Also aliased as: dot

inspect()

Overrides Object#inspect

 
               # File matrix.rb, line 2168
def inspect
  "Vector" + @elements.inspect
end

magnitude()

Returns the modulus (Pythagorean distance) of the vector.

Vector[5,8,2].r => 9.643650761

 
               # File matrix.rb, line 2062
def magnitude
  Math.sqrt(@elements.inject(0) {|v, e| v + e.abs2})
end

Also aliased as: r, norm

map()

Alias for: collect

map2(v)

Like #collect2, but returns a Vector instead of an Array.

 
               # File matrix.rb, line 2071
def map2(v, &block) # :yield: e1, e2
  return to_enum(:map2, v) unless block_given?
  els = collect2(v, &block)
  self.class.elements(els, false)
end

norm()

Alias for: magnitude

normalize()

Returns a new vector with the same direction but with norm 1.

v = Vector[5,8,2].normalize
# => Vector[0.5184758473652127, 0.8295613557843402, 0.20739033894608505]
v.norm => 1.0

 
               # File matrix.rb, line 2085
def normalize
  n = magnitude
  raise ZeroVectorError, "Zero vectors can not be normalized" if n == 0
  self / n
end

r()

Alias for: magnitude

round(ndigits=0)

Returns a vector with entries rounded to the given precision (see Float#round)

 
               # File matrix.rb, line 1799
def round(ndigits=0)
  map{|e| e.round(ndigits)}
end

size()

Returns the number of elements in the vector.

 
               # File matrix.rb, line 1806
def size
  @elements.size
end

to_a()

Returns the elements of the vector in an array.

 
               # File matrix.rb, line 2119
def to_a
  @elements.dup
end

to_s()

Overrides Object#to_s

 
               # File matrix.rb, line 2161
def to_s
  "Vector[" + @elements.join(", ") + "]"
end