Class: Vector
Relationships & Source Files | |
Namespace Children | |
Exceptions:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
Enumerable
|
|
Inherits: | Object |
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:
Vector
functions:
-
#inner_product(v), dot(v)
-
#cross_product(v), cross(v)
-
#map2(v)
Conversion to other data types:
String representations:
Class Method Summary
-
.[](*array)
Creates a
Vector
from a list of elements. -
.basis(size:, index:)
Returns a standard basis
n
-vector, where k is the index. -
.elements(array, copy = true)
Creates a vector from an Array.
-
.independent?(*vs) ⇒ Boolean
Returns
true
iff all of vectors are linearly independent. -
.new(array) ⇒ Vector
constructor
new
is private; use Vector[] or .elements to create.
Instance Attribute Summary
- #elements readonly protected
Instance Method Summary
-
#*(x)
Multiplies the vector by
x
, wherex
is a number or a matrix. -
#+(v)
Vector
addition. - #+@
-
#-(v)
Vector
subtraction. - #-@
-
#/(x)
Vector
division. -
#==(other)
Returns
true
iff the two vectors have the same elements in the same order. -
#[](i)
(also: #element, #component)
Returns element number
i
(starting at zero) of the vector. - #[]=(i, v) (also: #set_element, #set_component)
-
#angle_with(v)
Returns an angle with another vector.
-
#clone
Returns a copy of the vector.
-
#coerce(other)
The coerce method provides support for Ruby type coercion.
-
#collect(&block)
(also: #map)
Like
Array#collect
. -
#collect2(v)
Collects (as in
Enumerable#collect
) over the elements of this vector andv
in conjunction. -
#component(i)
Alias for #[].
-
#covector
Creates a single-row matrix from this vector.
-
#cross(*vs)
Alias for #cross_product.
-
#cross_product(*vs)
(also: #cross)
Returns the cross product of this vector with the others.
-
#dot(v)
Alias for #inner_product.
-
#each(&block)
Iterate over the elements of this vector.
-
#each2(v)
Iterate over the elements of this vector and
v
in conjunction. -
#element(i)
Alias for #[].
- #elements_to_f
- #elements_to_i
- #elements_to_r
- #eql?(other) ⇒ Boolean
-
#hash
Returns a hash-code for the vector.
-
#independent?(*vs) ⇒ Boolean
Returns
true
iff all of vectors are linearly independent. -
#inner_product(v)
(also: #dot)
Returns the inner product of this vector with the other.
-
#inspect
Overrides
Object#inspect
-
#magnitude
(also: #r, #norm)
Returns the modulus (Pythagorean distance) of the vector.
-
#map(&block)
Alias for #collect.
-
#map2(v, &block)
Like #collect2, but returns a
Vector
instead of an Array. -
#norm
Alias for #magnitude.
-
#normalize
Returns a new vector with the same direction but with norm 1.
-
#r
Alias for #magnitude.
-
#round(ndigits = 0)
Returns a vector with entries rounded to the given precision (see
Float#round
). -
#size
Returns the number of elements in the vector.
-
#to_a
Returns the elements of the vector in an array.
-
#to_s
Overrides
Object#to_s
-
#set_component(i, v)
private
Alias for #[]=.
-
#set_element(i, v)
private
Alias for #[]=.
Constructor Details
.new(array) ⇒ Vector
new
is private; use Vector[] or .elements to create.
# File 'lib/matrix.rb', line 1774
def initialize(array) # No checking is done at this point. @elements = array end
Class Method Details
.[](*array)
Creates a Vector
from a list of elements.
Vector[7, 4, ...]
# File 'lib/matrix.rb', line 1746
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 'lib/matrix.rb', line 1763
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 'lib/matrix.rb', line 1754
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
Instance Attribute Details
#elements (readonly, protected)
[ GitHub ]# File 'lib/matrix.rb', line 1739
attr_reader :elements
Instance Method Details
#*(x)
Multiplies the vector by x
, where x
is a number or a matrix.
# File 'lib/matrix.rb', line 1923
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.
#+@
[ GitHub ]# File 'lib/matrix.rb', line 1988
def +@ self end
#-(v)
Vector
subtraction.
#-@
[ GitHub ]# File 'lib/matrix.rb', line 1992
def -@ collect {|e| -e } end
#/(x)
Vector
division.
#==(other)
Returns true
iff the two vectors have the same elements in the same order.
# File 'lib/matrix.rb', line 1892
def ==(other) return false unless Vector === other @elements == other.elements end
#[](i) Also known as: #element, #component
Returns element number i
(starting at zero) of the vector.
# File 'lib/matrix.rb', line 1784
def [](i) @elements[i] end
#[]=(i, v) Also known as: #set_element, #set_component
[ GitHub ]# File 'lib/matrix.rb', line 1790
def []=(i, v) @elements[i]= v end
#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 'lib/matrix.rb', line 2097
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 'lib/matrix.rb', line 1905
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
.
#collect(&block) Also known as: #map
Like Array#collect
.
# File 'lib/matrix.rb', line 2052
def collect(&block) # :yield: e return to_enum(:collect) unless block_given? els = @elements.collect(&block) self.class.elements(els, false) end
#collect2(v)
Collects (as in Enumerable#collect
) over the elements of this vector and v
in conjunction.
#component(i)
Alias for #[].
# File 'lib/matrix.rb', line 1788
alias component []
#covector
Creates a single-row matrix from this vector.
# File 'lib/matrix.rb', line 2113
def covector Matrix.row_vector(self) end
#cross(*vs)
Alias for #cross_product.
# File 'lib/matrix.rb', line 2047
alias_method :cross, :cross_product
#cross_product(*vs) 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]
# File 'lib/matrix.rb', line 2027
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
#dot(v)
Alias for #inner_product.
# File 'lib/matrix.rb', line 2013
alias_method :dot, :inner_product
#each(&block)
Iterate over the elements of this vector
# File 'lib/matrix.rb', line 1818
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.
#element(i)
Alias for #[].
# File 'lib/matrix.rb', line 1787
alias element []
#elements_to_f
[ GitHub ]# File 'lib/matrix.rb', line 2124
def elements_to_f warn "#{caller(1)[0]}: warning: Vector#elements_to_f is deprecated" map(&:to_f) end
#elements_to_i
[ GitHub ]# File 'lib/matrix.rb', line 2129
def elements_to_i warn "#{caller(1)[0]}: warning: Vector#elements_to_i is deprecated" map(&:to_i) end
#elements_to_r
[ GitHub ]# File 'lib/matrix.rb', line 2134
def elements_to_r warn "#{caller(1)[0]}: warning: Vector#elements_to_r is deprecated" map(&:to_r) end
#eql?(other) ⇒ Boolean
# File 'lib/matrix.rb', line 1897
def eql?(other) return false unless Vector === other @elements.eql? other.elements end
#hash
Returns a hash-code for the vector.
# File 'lib/matrix.rb', line 1912
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
# File 'lib/matrix.rb', line 1881
def independent?(*vs) self.class.independent?(self, *vs) end
#inner_product(v) Also known as: #dot
Returns the inner product of this vector with the other.
Vector[4,7].inner_product Vector[10,1] => 47
#inspect
Overrides Object#inspect
# File 'lib/matrix.rb', line 2169
def inspect "Vector" + @elements.inspect end
#magnitude Also known as: #r, #norm
Returns the modulus (Pythagorean distance) of the vector.
Vector[5,8,2].r => 9.643650761
# File 'lib/matrix.rb', line 2063
def magnitude Math.sqrt(@elements.inject(0) {|v, e| v + e.abs2}) end
#map(&block)
Alias for #collect.
# File 'lib/matrix.rb', line 2057
alias map collect
#map2(v, &block)
Like #collect2, but returns a Vector
instead of an Array.
#norm
Alias for #magnitude.
# File 'lib/matrix.rb', line 2067
alias norm 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 'lib/matrix.rb', line 2086
def normalize n = magnitude raise ZeroVectorError, "Zero vectors can not be normalized" if n == 0 self / n end
#r
Alias for #magnitude.
# File 'lib/matrix.rb', line 2066
alias r magnitude
#round(ndigits = 0)
Returns a vector with entries rounded to the given precision (see Float#round
)
# File 'lib/matrix.rb', line 1800
def round(ndigits=0) map{|e| e.round(ndigits)} end
#set_component(i, v) (private)
Alias for #[]=.
# File 'lib/matrix.rb', line 1794
alias set_component []=
#set_element(i, v) (private)
Alias for #[]=.
# File 'lib/matrix.rb', line 1793
alias set_element []=
#size
Returns the number of elements in the vector.
# File 'lib/matrix.rb', line 1807
def size @elements.size end
#to_a
Returns the elements of the vector in an array.
# File 'lib/matrix.rb', line 2120
def to_a @elements.dup end
#to_s
Overrides Object#to_s
# File 'lib/matrix.rb', line 2162
def to_s "Vector[" + @elements.join(", ") + "]" end