Class: Vector
- Inherits:
-
Object
- Object
- Vector
- 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:
-
#*(x) “is matrix or number”
-
#+(v)
-
#-(v)
-
#/(v)
-
#+@
-
#-@
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
-
.[](*array) ⇒ Object
Creates a Vector from a list of elements.
-
.basis(size:, index:) ⇒ Object
Returns a standard basis
n
-vector, where k is the index. -
.elements(array, copy = true) ⇒ Object
Creates a vector from an Array.
-
.independent?(*vs) ⇒ Boolean
Returns
true
iff all of vectors are linearly independent. -
.zero(size) ⇒ Object
Return a zero vector.
Instance Method Summary collapse
-
#*(x) ⇒ Object
Multiplies the vector by
x
, wherex
is a number or a matrix. -
#+(v) ⇒ Object
Vector addition.
- #+@ ⇒ Object
-
#-(v) ⇒ Object
Vector subtraction.
- #-@ ⇒ Object
-
#/(x) ⇒ Object
Vector division.
-
#==(other) ⇒ Object
Returns
true
iff the two vectors have the same elements in the same order. - #[](i) ⇒ Object (also: #element, #component)
- #[]=(i, v) ⇒ Object (also: #set_element, #set_component)
-
#angle_with(v) ⇒ Object
Returns an angle with another vector.
-
#coerce(other) ⇒ Object
The coerce method provides support for Ruby type coercion.
-
#collect(&block) ⇒ Object
(also: #map)
Like Array#collect.
-
#collect!(&block) ⇒ Object
(also: #map!)
Like Array#collect!.
-
#collect2(v) ⇒ Object
Collects (as in Enumerable#collect) over the elements of this vector and
v
in conjunction. -
#covector ⇒ Object
Creates a single-row matrix from this vector.
-
#cross_product(*vs) ⇒ Object
(also: #cross)
Returns the cross product of this vector with the others.
-
#each(&block) ⇒ Object
Iterate over the elements of this vector.
-
#each2(v) ⇒ Object
Iterate over the elements of this vector and
v
in conjunction. - #elements_to_f ⇒ Object
- #elements_to_i ⇒ Object
- #elements_to_r ⇒ Object
- #eql?(other) ⇒ Boolean
- #freeze ⇒ Object
-
#hash ⇒ Object
Returns a hash-code for the vector.
-
#independent?(*vs) ⇒ Boolean
Returns
true
iff all of vectors are linearly independent. -
#initialize(array) ⇒ Vector
constructor
Vector.new is private; use Vector[] or Vector.elements to create.
-
#inner_product(v) ⇒ Object
(also: #dot)
Returns the inner product of this vector with the other.
-
#inspect ⇒ Object
Overrides Object#inspect.
-
#magnitude ⇒ Object
(also: #r, #norm)
Returns the modulus (Pythagorean distance) of the vector.
-
#map2(v, &block) ⇒ Object
Like Vector#collect2, but returns a Vector instead of an Array.
-
#normalize ⇒ Object
Returns a new vector with the same direction but with norm 1.
-
#round(ndigits = 0) ⇒ Object
Returns a vector with entries rounded to the given precision (see Float#round).
-
#size ⇒ Object
Returns the number of elements in the vector.
-
#to_a ⇒ Object
Returns the elements of the vector in an array.
-
#to_matrix ⇒ Object
Return a single-column matrix from this vector.
-
#to_s ⇒ Object
Overrides Object#to_s.
-
#zero? ⇒ Boolean
Returns
true
iff all elements are zero.
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.
1937 1938 1939 1940 |
# File 'lib/matrix.rb', line 1937 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, ...]
1898 1899 1900 |
# File 'lib/matrix.rb', line 1898 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]
1915 1916 1917 1918 1919 1920 1921 |
# File 'lib/matrix.rb', line 1915 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.
1906 1907 1908 |
# File 'lib/matrix.rb', line 1906 def Vector.elements(array, copy = true) new convert_to_array(array, copy) end |
.independent?(*vs) ⇒ Boolean
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
2062 2063 2064 2065 2066 2067 2068 2069 |
# File 'lib/matrix.rb', line 2062 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 |
Instance Method Details
#*(x) ⇒ Object
Multiplies the vector by x
, where x
is a number or a matrix.
2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 |
# File 'lib/matrix.rb', line 2136 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.
2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 |
# File 'lib/matrix.rb', line 2153 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 |
#+@ ⇒ Object
2201 2202 2203 |
# File 'lib/matrix.rb', line 2201 def +@ self end |
#-(v) ⇒ Object
Vector subtraction.
2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 |
# File 'lib/matrix.rb', line 2171 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 |
#-@ ⇒ Object
2205 2206 2207 |
# File 'lib/matrix.rb', line 2205 def -@ collect {|e| -e } end |
#/(x) ⇒ Object
Vector division.
2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 |
# File 'lib/matrix.rb', line 2189 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 true
iff the two vectors have the same elements in the same order.
2112 2113 2114 2115 |
# File 'lib/matrix.rb', line 2112 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.
1951 1952 1953 |
# File 'lib/matrix.rb', line 1951 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.
1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 |
# File 'lib/matrix.rb', line 1966 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
2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 |
# File 'lib/matrix.rb', line 2321 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.
2381 2382 2383 2384 2385 2386 2387 2388 |
# File 'lib/matrix.rb', line 2381 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.
2265 2266 2267 2268 2269 |
# File 'lib/matrix.rb', line 2265 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!
2275 2276 2277 2278 2279 2280 |
# File 'lib/matrix.rb', line 2275 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.
2040 2041 2042 2043 2044 2045 2046 2047 |
# File 'lib/matrix.rb', line 2040 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 |
#covector ⇒ Object
Creates a single-row matrix from this vector.
2341 2342 2343 |
# File 'lib/matrix.rb', line 2341 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]
2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 |
# File 'lib/matrix.rb', line 2240 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
2017 2018 2019 2020 2021 |
# File 'lib/matrix.rb', line 2017 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.
2026 2027 2028 2029 2030 2031 2032 2033 2034 |
# File 'lib/matrix.rb', line 2026 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_f ⇒ Object
2359 2360 2361 2362 |
# File 'lib/matrix.rb', line 2359 def elements_to_f warn "Vector#elements_to_f is deprecated", uplevel: 1 map(&:to_f) end |
#elements_to_i ⇒ Object
2364 2365 2366 2367 |
# File 'lib/matrix.rb', line 2364 def elements_to_i warn "Vector#elements_to_i is deprecated", uplevel: 1 map(&:to_i) end |
#elements_to_r ⇒ Object
2369 2370 2371 2372 |
# File 'lib/matrix.rb', line 2369 def elements_to_r warn "Vector#elements_to_r is deprecated", uplevel: 1 map(&:to_r) end |
#eql?(other) ⇒ Boolean
2117 2118 2119 2120 |
# File 'lib/matrix.rb', line 2117 def eql?(other) return false unless Vector === other @elements.eql? other.elements end |
#freeze ⇒ Object
2091 2092 2093 2094 |
# File 'lib/matrix.rb', line 2091 def freeze @elements.freeze super end |
#hash ⇒ Object
Returns a hash-code for the vector.
2125 2126 2127 |
# File 'lib/matrix.rb', line 2125 def hash @elements.hash end |
#independent?(*vs) ⇒ Boolean
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
2080 2081 2082 |
# File 'lib/matrix.rb', line 2080 def independent?(*vs) self.class.independent?(self, *vs) end |
#inner_product(v) ⇒ Object Also known as: dot
2217 2218 2219 2220 2221 2222 2223 2224 2225 |
# File 'lib/matrix.rb', line 2217 def inner_product(v) raise ErrDimensionMismatch if size != v.size p = 0 each2(v) {|v1, v2| p += v1 * v2.conj } p end |
#inspect ⇒ Object
Overrides Object#inspect
2404 2405 2406 |
# File 'lib/matrix.rb', line 2404 def inspect "Vector" + @elements.inspect end |
#magnitude ⇒ Object Also known as: r, norm
Returns the modulus (Pythagorean distance) of the vector.
Vector[5,8,2].r => 9.643650761
2287 2288 2289 |
# File 'lib/matrix.rb', line 2287 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.
2296 2297 2298 2299 2300 |
# File 'lib/matrix.rb', line 2296 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 |
#normalize ⇒ Object
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
2310 2311 2312 2313 2314 |
# File 'lib/matrix.rb', line 2310 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)
1999 2000 2001 |
# File 'lib/matrix.rb', line 1999 def round(ndigits=0) map{|e| e.round(ndigits)} end |
#size ⇒ Object
Returns the number of elements in the vector.
2006 2007 2008 |
# File 'lib/matrix.rb', line 2006 def size @elements.size end |
#to_a ⇒ Object
Returns the elements of the vector in an array.
2348 2349 2350 |
# File 'lib/matrix.rb', line 2348 def to_a @elements.dup end |
#to_matrix ⇒ Object
Return a single-column matrix from this vector
2355 2356 2357 |
# File 'lib/matrix.rb', line 2355 def to_matrix Matrix.column_vector(self) end |
#to_s ⇒ Object
Overrides Object#to_s
2397 2398 2399 |
# File 'lib/matrix.rb', line 2397 def to_s "Vector[" + @elements.join(", ") + "]" end |
#zero? ⇒ Boolean
Returns true
iff all elements are zero.
2087 2088 2089 |
# File 'lib/matrix.rb', line 2087 def zero? all?(&:zero?) end |