Class: Vector

Inherits:
Object
  • Object
show all
Extended by:
Matrix::ConversionHelper
Includes:
Enumerable, ExceptionForMatrix, Matrix::CoercionHelper
Defined in:
lib/matrix.rb

Overview

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:

  • Vector.[](*array)

  • Vector.elements(array, copy = true)

  • Vector.basis(size: n, index: k)

  • Vector.zero(n)

To access elements:

  • #[](i)

To set elements:

  • #[]=(i, v)

To enumerate the elements:

  • #each2(v)

  • #collect2(v)

Properties of vectors:

  • #angle_with(v)

  • Vector.independent?(*vs)

  • #independent?(*vs)

  • #zero?

Vector arithmetic:

Vector functions:

  • #inner_product(v), #dot(v)

  • #cross_product(v), #cross(v)

  • #collect

  • #collect!

  • #magnitude

  • #map

  • #map!

  • #map2(v)

  • #norm

  • #normalize

  • #r

  • #round

  • #size

Conversion to other data types:

  • #covector

  • #to_a

  • #coerce(other)

String representations:

  • #to_s

  • #inspect

Defined Under Namespace

Classes: ZeroVectorError

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Matrix::CoercionHelper

check_int, check_range, coerce_to, coerce_to_int, coerce_to_matrix

Constructor Details

#initialize(array) ⇒ Vector

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


2020
2021
2022
2023
# File 'lib/matrix.rb', line 2020

def initialize(array)
  # No checking is done at this point.
  @elements = array
end

Class Method Details

.[](*array) ⇒ Object

Creates a Vector from a list of elements.

Vector[7, 4, ...]

1981
1982
1983
# File 'lib/matrix.rb', line 1981

def Vector.[](*array)
  new convert_to_array(array, false)
end

.basis(size:, index:) ⇒ Object

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

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

Raises:

  • (ArgumentError)

1998
1999
2000
2001
2002
2003
2004
# File 'lib/matrix.rb', line 1998

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) ⇒ Object

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


1989
1990
1991
# File 'lib/matrix.rb', line 1989

def Vector.elements(array, copy = true)
  new convert_to_array(array, copy)
end

.independent?(*vs) ⇒ Boolean

Returns whether all of vectors are linearly independent.

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

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

Returns:

  • (Boolean)

2145
2146
2147
2148
2149
2150
2151
2152
# File 'lib/matrix.rb', line 2145

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

.zero(size) ⇒ Object

Return a zero vector.

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

Raises:

  • (ArgumentError)

2011
2012
2013
2014
2015
# File 'lib/matrix.rb', line 2011

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

Instance Method Details

#*(x) ⇒ Object

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


2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
# File 'lib/matrix.rb', line 2222

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

#+(v) ⇒ Object

Vector addition.


2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
# File 'lib/matrix.rb', line 2239

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

#[email protected]Object


2287
2288
2289
# File 'lib/matrix.rb', line 2287

def [email protected]
  self
end

#-(v) ⇒ Object

Vector subtraction.


2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
# File 'lib/matrix.rb', line 2257

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

#[email protected]Object


2291
2292
2293
# File 'lib/matrix.rb', line 2291

def [email protected]
  collect {|e| -e }
end

#/(x) ⇒ Object

Vector division.


2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
# File 'lib/matrix.rb', line 2275

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

#==(other) ⇒ Object

Returns whether the two vectors have the same elements in the same order.


2198
2199
2200
2201
# File 'lib/matrix.rb', line 2198

def ==(other)
  return false unless Vector === other
  @elements == other.elements
end

#[](i) ⇒ Object Also known as: element, component

:call-seq:

vector[range]
vector[integer]

Returns element or elements of the vector.


2034
2035
2036
# File 'lib/matrix.rb', line 2034

def [](i)
  @elements[i]
end

#[]=(i, v) ⇒ Object Also known as: set_element, set_component

:call-seq:

vector[range] = new_vector
vector[range] = row_matrix
vector[range] = new_element
vector[integer] = new_element

Set element or elements of vector.

Raises:

  • (FrozenError)

2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
# File 'lib/matrix.rb', line 2049

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

#angle_with(v) ⇒ Object

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

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

Raises:

  • (TypeError)

2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'lib/matrix.rb', line 2407

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

#coerce(other) ⇒ Object

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.


2467
2468
2469
2470
2471
2472
2473
2474
# File 'lib/matrix.rb', line 2467

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(&block) ⇒ Object Also known as: map

Like Array#collect.


2351
2352
2353
2354
2355
# File 'lib/matrix.rb', line 2351

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

#collect!(&block) ⇒ Object Also known as: map!

Like Array#collect!

Raises:

  • (FrozenError)

2361
2362
2363
2364
2365
2366
# File 'lib/matrix.rb', line 2361

def collect!(&block)
  return to_enum(:collect!) unless block_given?
  raise FrozenError, "can't modify frozen Vector" if frozen?
  @elements.collect!(&block)
  self
end

#collect2(v) ⇒ Object

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

Raises:

  • (TypeError)

2123
2124
2125
2126
2127
2128
2129
2130
# File 'lib/matrix.rb', line 2123

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

#covectorObject

Creates a single-row matrix from this vector.


2427
2428
2429
# File 'lib/matrix.rb', line 2427

def covector
  Matrix.row_vector(self)
end

#cross_product(*vs) ⇒ Object Also known as: cross

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]

2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
# File 'lib/matrix.rb', line 2326

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

#each(&block) ⇒ Object

Iterate over the elements of this vector


2100
2101
2102
2103
2104
# File 'lib/matrix.rb', line 2100

def each(&block)
  return to_enum(:each) unless block_given?
  @elements.each(&block)
  self
end

#each2(v) ⇒ Object

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

Raises:

  • (TypeError)

2109
2110
2111
2112
2113
2114
2115
2116
2117
# File 'lib/matrix.rb', line 2109

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

#elements_to_fObject


2445
2446
2447
2448
# File 'lib/matrix.rb', line 2445

def elements_to_f
  warn "Vector#elements_to_f is deprecated", uplevel: 1
  map(&:to_f)
end

#elements_to_iObject


2450
2451
2452
2453
# File 'lib/matrix.rb', line 2450

def elements_to_i
  warn "Vector#elements_to_i is deprecated", uplevel: 1
  map(&:to_i)
end

#elements_to_rObject


2455
2456
2457
2458
# File 'lib/matrix.rb', line 2455

def elements_to_r
  warn "Vector#elements_to_r is deprecated", uplevel: 1
  map(&:to_r)
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean)

2203
2204
2205
2206
# File 'lib/matrix.rb', line 2203

def eql?(other)
  return false unless Vector === other
  @elements.eql? other.elements
end

#freezeObject

Makes the matrix frozen and Ractor-shareable


2177
2178
2179
2180
# File 'lib/matrix.rb', line 2177

def freeze
  @elements.freeze
  super
end

#hashObject

Returns a hash-code for the vector.


2211
2212
2213
# File 'lib/matrix.rb', line 2211

def hash
  @elements.hash
end

#independent?(*vs) ⇒ Boolean

Returns whether all of vectors are linearly independent.

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

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

Returns:

  • (Boolean)

2163
2164
2165
# File 'lib/matrix.rb', line 2163

def independent?(*vs)
  self.class.independent?(self, *vs)
end

#inner_product(v) ⇒ Object Also known as: dot

Returns the inner product of this vector with the other.

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

2303
2304
2305
2306
2307
2308
2309
2310
2311
# File 'lib/matrix.rb', line 2303

def inner_product(v)
  raise ErrDimensionMismatch if size != v.size

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

#inspectObject

Overrides Object#inspect


2490
2491
2492
# File 'lib/matrix.rb', line 2490

def inspect
  "Vector" + @elements.inspect
end

#magnitudeObject Also known as: r, norm

Returns the modulus (Pythagorean distance) of the vector.

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

2373
2374
2375
# File 'lib/matrix.rb', line 2373

def magnitude
  Math.sqrt(@elements.inject(0) {|v, e| v + e.abs2})
end

#map2(v, &block) ⇒ Object

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


2382
2383
2384
2385
2386
# File 'lib/matrix.rb', line 2382

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

#normalizeObject

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

Raises:


2396
2397
2398
2399
2400
# File 'lib/matrix.rb', line 2396

def normalize
  n = magnitude
  raise ZeroVectorError, "Zero vectors can not be normalized" if n == 0
  self / n
end

#round(ndigits = 0) ⇒ Object

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


2082
2083
2084
# File 'lib/matrix.rb', line 2082

def round(ndigits=0)
  map{|e| e.round(ndigits)}
end

#sizeObject

Returns the number of elements in the vector.


2089
2090
2091
# File 'lib/matrix.rb', line 2089

def size
  @elements.size
end

#to_aObject

Returns the elements of the vector in an array.


2434
2435
2436
# File 'lib/matrix.rb', line 2434

def to_a
  @elements.dup
end

#to_matrixObject

Return a single-column matrix from this vector


2441
2442
2443
# File 'lib/matrix.rb', line 2441

def to_matrix
  Matrix.column_vector(self)
end

#to_sObject

Overrides Object#to_s


2483
2484
2485
# File 'lib/matrix.rb', line 2483

def to_s
  "Vector[" + @elements.join(", ") + "]"
end

#zero?Boolean

Returns whether all elements are zero.

Returns:

  • (Boolean)

2170
2171
2172
# File 'lib/matrix.rb', line 2170

def zero?
  all?(&:zero?)
end