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)
To access elements:
-
#[](i)
To enumerate the elements:
-
#each2(v)
-
#collect2(v)
Properties of vectors:
-
#angle_with(v)
-
Vector.independent?(*vs)
-
#independent?(*vs)
Vector arithmetic:
-
#*(x) “is matrix or number”
-
#+(v)
-
#-(v)
-
#+@
-
#-@
Vector functions:
-
#inner_product(v), dot(v)
-
#cross_product(v), cross(v)
-
#collect
-
#magnitude
-
#map
-
#map2(v)
-
#norm
-
#normalize
-
#r
-
#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.
Instance Method Summary collapse
-
#*(x) ⇒ Object
Multiplies the vector by
x
, wherex
is a number or another vector. -
#+(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)
Returns element number
i
(starting at zero) of the vector. - #[]=(i, v) ⇒ Object (also: #set_element, #set_component)
-
#angle_with(v) ⇒ Object
Returns an angle with another vector.
-
#clone ⇒ Object
Returns a copy of the vector.
-
#coerce(other) ⇒ Object
The coerce method provides support for Ruby type coercion.
-
#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
-
#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.
-
#size ⇒ Object
Returns the number of elements in the vector.
-
#to_a ⇒ Object
Returns the elements of the vector in an array.
-
#to_s ⇒ Object
Overrides Object#to_s.
Methods included from Matrix::CoercionHelper
Constructor Details
#initialize(array) ⇒ Vector
Vector.new is private; use Vector[] or Vector.elements to create.
1770 1771 1772 1773 |
# File 'lib/matrix.rb', line 1770 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, ...]
1742 1743 1744 |
# File 'lib/matrix.rb', line 1742 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]
1759 1760 1761 1762 1763 1764 1765 |
# File 'lib/matrix.rb', line 1759 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.
1750 1751 1752 |
# File 'lib/matrix.rb', line 1750 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
1852 1853 1854 1855 1856 1857 1858 1859 |
# File 'lib/matrix.rb', line 1852 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 |
Instance Method Details
#*(x) ⇒ Object
Multiplies the vector by x
, where x
is a number or another vector.
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 |
# File 'lib/matrix.rb', line 1912 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) ⇒ Object
Vector addition.
1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 |
# File 'lib/matrix.rb', line 1929 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 |
#+@ ⇒ Object
1977 1978 1979 |
# File 'lib/matrix.rb', line 1977 def +@ self end |
#-(v) ⇒ Object
Vector subtraction.
1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'lib/matrix.rb', line 1947 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 |
#-@ ⇒ Object
1981 1982 1983 |
# File 'lib/matrix.rb', line 1981 def -@ collect {|e| -e } end |
#/(x) ⇒ Object
Vector division.
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 |
# File 'lib/matrix.rb', line 1965 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) ⇒ Object
Returns true
iff the two vectors have the same elements in the same order.
1881 1882 1883 1884 |
# File 'lib/matrix.rb', line 1881 def ==(other) return false unless Vector === other @elements == other.elements end |
#[](i) ⇒ Object Also known as: element, component
Returns element number i
(starting at zero) of the vector.
1780 1781 1782 |
# File 'lib/matrix.rb', line 1780 def [](i) @elements[i] end |
#[]=(i, v) ⇒ Object Also known as: set_element, set_component
1786 1787 1788 |
# File 'lib/matrix.rb', line 1786 def []=(i, v) @elements[i]= v end |
#angle_with(v) ⇒ Object
2086 2087 2088 2089 2090 2091 2092 2093 |
# File 'lib/matrix.rb', line 2086 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 ⇒ Object
Returns a copy of the vector.
1894 1895 1896 |
# File 'lib/matrix.rb', line 1894 def clone self.class.elements(@elements) 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.
2135 2136 2137 2138 2139 2140 2141 2142 |
# File 'lib/matrix.rb', line 2135 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.
2041 2042 2043 2044 2045 |
# File 'lib/matrix.rb', line 2041 def collect(&block) # :yield: e return to_enum(:collect) unless block_given? els = @elements.collect(&block) self.class.elements(els, false) end |
#collect2(v) ⇒ Object
Collects (as in Enumerable#collect) over the elements of this vector and v
in conjunction.
1830 1831 1832 1833 1834 1835 1836 1837 |
# File 'lib/matrix.rb', line 1830 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 |
#covector ⇒ Object
Creates a single-row matrix from this vector.
2102 2103 2104 |
# File 'lib/matrix.rb', line 2102 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]
2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 |
# File 'lib/matrix.rb', line 2016 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 |
#each(&block) ⇒ Object
Iterate over the elements of this vector
1807 1808 1809 1810 1811 |
# File 'lib/matrix.rb', line 1807 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.
1816 1817 1818 1819 1820 1821 1822 1823 1824 |
# File 'lib/matrix.rb', line 1816 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 |
#elements_to_f ⇒ Object
2113 2114 2115 2116 |
# File 'lib/matrix.rb', line 2113 def elements_to_f warn "#{caller(1)[0]}: warning: Vector#elements_to_f is deprecated" map(&:to_f) end |
#elements_to_i ⇒ Object
2118 2119 2120 2121 |
# File 'lib/matrix.rb', line 2118 def elements_to_i warn "#{caller(1)[0]}: warning: Vector#elements_to_i is deprecated" map(&:to_i) end |
#elements_to_r ⇒ Object
2123 2124 2125 2126 |
# File 'lib/matrix.rb', line 2123 def elements_to_r warn "#{caller(1)[0]}: warning: Vector#elements_to_r is deprecated" map(&:to_r) end |
#eql?(other) ⇒ Boolean
1886 1887 1888 1889 |
# File 'lib/matrix.rb', line 1886 def eql?(other) return false unless Vector === other @elements.eql? other.elements end |
#hash ⇒ Object
Returns a hash-code for the vector.
1901 1902 1903 |
# File 'lib/matrix.rb', line 1901 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
1870 1871 1872 |
# File 'lib/matrix.rb', line 1870 def independent?(*vs) self.class.independent?(self, *vs) end |
#inner_product(v) ⇒ Object Also known as: dot
1993 1994 1995 1996 1997 1998 1999 2000 2001 |
# File 'lib/matrix.rb', line 1993 def inner_product(v) Vector.Raise ErrDimensionMismatch if size != v.size p = 0 each2(v) {|v1, v2| p += v1 * v2.conj } p end |
#inspect ⇒ Object
Overrides Object#inspect
2158 2159 2160 |
# File 'lib/matrix.rb', line 2158 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
2052 2053 2054 |
# File 'lib/matrix.rb', line 2052 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.
2061 2062 2063 2064 2065 |
# File 'lib/matrix.rb', line 2061 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
2075 2076 2077 2078 2079 |
# File 'lib/matrix.rb', line 2075 def normalize n = magnitude raise ZeroVectorError, "Zero vectors can not be normalized" if n == 0 self / n end |
#size ⇒ Object
Returns the number of elements in the vector.
1796 1797 1798 |
# File 'lib/matrix.rb', line 1796 def size @elements.size end |
#to_a ⇒ Object
Returns the elements of the vector in an array.
2109 2110 2111 |
# File 'lib/matrix.rb', line 2109 def to_a @elements.dup end |
#to_s ⇒ Object
Overrides Object#to_s
2151 2152 2153 |
# File 'lib/matrix.rb', line 2151 def to_s "Vector[" + @elements.join(", ") + "]" end |