W3cubDocs

/Ruby 3

class Vector

Parent:
Object
Included modules:
ExceptionForMatrix, Enumerable

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:

To access elements:

To set elements:

To enumerate the elements:

Properties of vectors:

Vector arithmetic:

Vector functions:

Conversion to other data types:

String representations:

Attributes

elements[R]

INSTANCE CREATION

Public Class Methods

[](*array) Show source 
# File lib/matrix.rb, line 1952
def Vector.[](*array)
  new convert_to_array(array, false)
end

Creates a Vector from a list of elements.

Vector[7, 4, ...]
basis(size:, index:) Show source 
# File lib/matrix.rb, line 1969
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

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

Vector.basis(size:, index:) # => Vector[0, 1, 0]
elements(array, copy = true) Show source 
# File lib/matrix.rb, line 1960
def Vector.elements(array, copy = true)
  new convert_to_array(array, copy)
end

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

independent?(*vs) Show source 
# File lib/matrix.rb, line 2116
def Vector.independent?(*vs)
  vs.each do |v|
    raise TypeError, "expected Vector, got #{v.class}" unless v.is_a?(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

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
new(array) Show source 
# File lib/matrix.rb, line 1991
def initialize(array)
  # No checking is done at this point.
  @elements = array
end

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

zero(size) Show source 
# File lib/matrix.rb, line 1982
def Vector.zero(size)
  raise ArgumentError, "invalid size (#{size} for 0..)" if size < 0
  array = Array.new(size, 0)
  new convert_to_array(array, false)
end

Return a zero vector.

Vector.zero(3) # => Vector[0, 0, 0]

Public Instance Methods

# File lib/matrix.rb, line 2193
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
    raise ErrOperationNotDefined, ["*", self.class, x.class]
  else
    apply_through_coercion(x, __method__)
  end
end

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

# File lib/matrix.rb, line 2210
def +(v)
  case v
  when 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

Vector addition.

# File lib/matrix.rb, line 2258
def +@
  self
end
# File lib/matrix.rb, line 2228
def -(v)
  case v
  when 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

Vector subtraction.

# File lib/matrix.rb, line 2262
def -@
  collect {|e| -e }
end
# File lib/matrix.rb, line 2246
def /(x)
  case x
  when Numeric
    els = @elements.collect{|e| e / x}
    self.class.elements(els, false)
  when Matrix, Vector
    raise ErrOperationNotDefined, ["/", self.class, x.class]
  else
    apply_through_coercion(x, __method__)
  end
end

Vector division.

==(other) Show source 
# File lib/matrix.rb, line 2169
def ==(other)
  return false unless Vector === other
  @elements == other.elements
end

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

vector[range] Show source
vector[integer] 
# File lib/matrix.rb, line 2005
def [](i)
  @elements[i]
end

Returns element or elements of the vector.

Also aliased as: element, component
vector[range] = new_vector Show source
vector[range] = row_matrix
vector[range] = new_element
vector[integer] = new_element 
# File lib/matrix.rb, line 2020
def []=(i, v)
  raise FrozenError, "can't modify frozen Vector" if frozen?
  if i.is_a?(Range)
    range = Matrix::CoercionHelper.check_range(i, size, :vector)
    set_range(range, v)
  else
    index = Matrix::CoercionHelper.check_int(i, size, :index)
    set_value(index, v)
  end
end

Set element or elements of vector.

Also aliased as: set_element, set_component
angle_with(v) Show source 
# File lib/matrix.rb, line 2378
def angle_with(v)
  raise TypeError, "Expected a Vector, got a #{v.class}" unless v.is_a?(Vector)
  raise ErrDimensionMismatch if size != v.size
  prod = magnitude * v.magnitude
  raise ZeroVectorError, "Can't get angle of zero vector" if prod == 0
  dot = inner_product(v)
  if dot.abs >= prod
    dot.positive? ? 0 : Math::PI
  else
    Math.acos(dot / prod)
  end
end

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

Vector[1,0].angle_with(Vector[0,1])
# => Math::PI / 2
coerce(other) Show source 
# File lib/matrix.rb, line 2438
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

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.

collect() { |e| ... } Show source 
# File lib/matrix.rb, line 2322
def collect(&block) # :yield: e
  return to_enum(:collect) unless block_given?
  els = @elements.collect(&block)
  self.class.elements(els, false)
end

Like Array#collect.

Also aliased as: map
collect!(&block) Show source 
# File lib/matrix.rb, line 2332
def collect!(&block)
  return to_enum(:collect!) unless block_given?
  raise FrozenError, "can't modify frozen Vector" if frozen?
  @elements.collect!(&block)
  self
end

Like Array#collect!

Also aliased as: map!
collect2(v) { |e1, e2| ... } Show source 
# File lib/matrix.rb, line 2094
def collect2(v) # :yield: e1, e2
  raise TypeError, "Integer is not like Vector" if v.kind_of?(Integer)
  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

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

Alias for: []
covector() Show source 
# File lib/matrix.rb, line 2398
def covector
  Matrix.row_vector(self)
end

Creates a single-row matrix from this vector.

cross(*vs)
Alias for: cross_product
cross_product(*vs) Show source 
# File lib/matrix.rb, line 2297
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
    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

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]
Also aliased as: cross
dot(v)
Alias for: inner_product
each(&block) Show source 
# File lib/matrix.rb, line 2071
def each(&block)
  return to_enum(:each) unless block_given?
  @elements.each(&block)
  self
end

Iterate over the elements of this vector

each2(v) { |e1, e2| ... } Show source 
# File lib/matrix.rb, line 2080
def each2(v) # :yield: e1, e2
  raise TypeError, "Integer is not like Vector" if v.kind_of?(Integer)
  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

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

Alias for: []
elements_to_f() Show source 
# File lib/matrix.rb, line 2416
def elements_to_f
  warn "Vector#elements_to_f is deprecated", uplevel: 1
  map(&:to_f)
end
elements_to_i() Show source 
# File lib/matrix.rb, line 2421
def elements_to_i
  warn "Vector#elements_to_i is deprecated", uplevel: 1
  map(&:to_i)
end
elements_to_r() Show source 
# File lib/matrix.rb, line 2426
def elements_to_r
  warn "Vector#elements_to_r is deprecated", uplevel: 1
  map(&:to_r)
end
eql?(other) Show source 
# File lib/matrix.rb, line 2174
def eql?(other)
  return false unless Vector === other
  @elements.eql? other.elements
end
freeze() Show source 
# File lib/matrix.rb, line 2148
def freeze
  @elements.freeze
  super
end

Makes the matrix frozen and Ractor-shareable

Calls superclass method Object#freeze
hash() Show source 
# File lib/matrix.rb, line 2182
def hash
  @elements.hash
end

Returns a hash-code for the vector.

independent?(*vs) Show source 
# File lib/matrix.rb, line 2134
def independent?(*vs)
  self.class.independent?(self, *vs)
end

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
inner_product(v) Show source 
# File lib/matrix.rb, line 2274
def inner_product(v)
  raise ErrDimensionMismatch if size != v.size

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

Returns the inner product of this vector with the other.

Vector[4,7].inner_product Vector[10,1] # => 47
Also aliased as: dot
inspect() Show source 
# File lib/matrix.rb, line 2461
def inspect
  "Vector" + @elements.inspect
end

Overrides Object#inspect

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

Returns the modulus (Pythagorean distance) of the vector.

Vector[5,8,2].r # => 9.643650761
Also aliased as: r, norm
map()
Alias for: collect
map!(&block)
Alias for: collect!
map2(v) { |e1, e2| ... } Show source 
# File lib/matrix.rb, line 2353
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

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

norm()
Alias for: magnitude
normalize() Show source 
# File lib/matrix.rb, line 2367
def normalize
  n = magnitude
  raise ZeroVectorError, "Zero vectors can not be normalized" if n == 0
  self / n
end

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
r()
Alias for: magnitude
round(ndigits=0) Show source 
# File lib/matrix.rb, line 2053
def round(ndigits=0)
  map{|e| e.round(ndigits)}
end

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

size() Show source 
# File lib/matrix.rb, line 2060
def size
  @elements.size
end

Returns the number of elements in the vector.

to_a() Show source 
# File lib/matrix.rb, line 2405
def to_a
  @elements.dup
end

Returns the elements of the vector in an array.

to_matrix() Show source 
# File lib/matrix.rb, line 2412
def to_matrix
  Matrix.column_vector(self)
end

Return a single-column matrix from this vector

to_s() Show source 
# File lib/matrix.rb, line 2454
def to_s
  "Vector[" + @elements.join(", ") + "]"
end

Overrides Object#to_s

zero?() Show source 
# File lib/matrix.rb, line 2141
def zero?
  all?(&:zero?)
end

Returns true iff all elements are zero.

Private Instance Methods

initialize_copy(v) Show source 
# File lib/matrix.rb, line 2156
        def initialize_copy(v)
  super
  @elements = @elements.dup unless frozen?
end

Called for dup & clone.

Calls superclass method
Alias for: []=
Alias for: []=
set_range(range, value) Show source 
# File lib/matrix.rb, line 2038
        def set_range(range, value)
  if value.is_a?(Vector)
    raise ArgumentError, "vector to be set has wrong size" unless range.size == value.size
    @elements[range] = value.elements
  elsif value.is_a?(Matrix)
    raise ErrDimensionMismatch unless value.row_count == 1
    @elements[range] = value.row(0).elements
  else
    @elements[range] = Array.new(range.size, value)
  end
end
set_value(index, value) Show source 
# File lib/matrix.rb, line 2034
        def set_value(index, value)
  @elements[index] = value
end

Ruby Core © 1993–2020 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.