类 Vector

Vector 类表示一个数学向量，它本身很有用，并且构成 Matrix 的一行或一列。

方法目录 ↑

创建 Vector

访问元素

设置元素

枚举元素

向量的属性

Vector 算术

Vector 函数

转换为其他数据类型

字符串表示

属性

elements[R]

实例创建

公共类方法

[](*array) 点击切换源代码

从元素列表创建 Vector。

Vector[7, 4, ...]
# File matrix-0.4.2/lib/matrix.rb, line 1981
def Vector.[](*array)
  new convert_to_array(array, false)
end
basis(size:, index:) 点击切换源代码

返回标准基 n 向量，其中 k 是索引。

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

# File matrix-0.4.2/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) 点击切换源代码

从数组创建一个向量。可选的第二个参数指定在内部使用数组本身还是副本。

# File matrix-0.4.2/lib/matrix.rb, line 1989
def Vector.elements(array, copy = true)
  new convert_to_array(array, copy)
end
independent?(*vs) 点击切换源代码

返回所有向量是否线性无关。

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

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

# File matrix-0.4.2/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
new(array) 点击切换源代码

Vector.new 是私有的；使用 Vector[] 或 Vector.elements 创建。

# File matrix-0.4.2/lib/matrix.rb, line 2020
def initialize(array)
  # No checking is done at this point.
  @elements = array
end
zero(size) 点击切换源代码

返回一个零向量。

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

# File matrix-0.4.2/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

公共实例方法

*(x) 点击切换源代码

将向量乘以 x，其中 x 是一个数字或一个矩阵。

# File matrix-0.4.2/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) 点击切换源代码

Vector 加法。

# File matrix-0.4.2/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
+@() 点击切换源代码
# File matrix-0.4.2/lib/matrix.rb, line 2287
def +@
  self
end
-(v) 点击切换源代码

Vector 减法。

# File matrix-0.4.2/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
-@() 点击切换源代码
# File matrix-0.4.2/lib/matrix.rb, line 2291
def -@
  collect {|e| -e }
end
/(x) 点击切换源代码

Vector 除法。

# File matrix-0.4.2/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) 点击切换源代码

返回两个向量是否具有相同的元素且顺序相同。

# File matrix-0.4.2/lib/matrix.rb, line 2198
def ==(other)
  return false unless Vector === other
  @elements == other.elements
end
vector[range] 点击切换源代码
vector[integer]

返回向量的元素或多个元素。

# File matrix-0.4.2/lib/matrix.rb, line 2034
def [](i)
  @elements[i]
end
也别名为：element, component
vector[range] = new_vector 点击切换源代码
vector[range] = row_matrix
vector[range] = new_element
vector[integer] = new_element

设置向量的元素或多个元素。

# File matrix-0.4.2/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
也别名为：set_element, set_component
angle_with(v) 点击切换源代码

返回与另一个向量的角度。结果在 [0..Math::PI] 范围内。

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

# File matrix-0.4.2/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) 点击切换源代码

coerce 方法为 Ruby 类型强制转换提供支持。Ruby 使用此强制转换机制来处理混合类型的数值运算：它旨在找到运算符的两个操作数之间兼容的公共类型。另请参见 Numeric#coerce。

# File matrix-0.4.2/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() { |e| ... } 点击切换源代码

类似于 Array#collect。

# File matrix-0.4.2/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
也别名为：map
collect!(&block) 点击切换源代码

类似于 Array#collect!

# File matrix-0.4.2/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
也别名为：map!
collect2(v) { |e1, e2| ... } 点击切换源代码

与此向量和 v 的元素一起收集（如在 Enumerable#collect 中）。

# File matrix-0.4.2/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
component(i)
别名为：[]
covector() 点击切换源代码

从此向量创建一个单行矩阵。

# File matrix-0.4.2/lib/matrix.rb, line 2427
def covector
  Matrix.row_vector(self)
end
cross(*vs)
别名为：cross_product
cross_product(*vs) 点击切换源代码

返回此向量与其他向量的叉积。

Vector[1, 0, 0].cross_product Vector[0, 1, 0]  # => Vector[0, 0, 1]

它被推广到其他维度，以返回一个与参数垂直的向量。

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 matrix-0.4.2/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
也别名为：cross
dot(v)
别名为：inner_product
each(&block) 点击切换源代码

遍历此向量的元素

# File matrix-0.4.2/lib/matrix.rb, line 2100
def each(&block)
  return to_enum(:each) unless block_given?
  @elements.each(&block)
  self
end
each2(v) { |e1, e2| ... } 点击切换源代码

遍历此向量和 v 的元素。

# File matrix-0.4.2/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
element(i)
别名为：[]
elements_to_f() 点击切换源代码
# File matrix-0.4.2/lib/matrix.rb, line 2445
def elements_to_f
  warn "Vector#elements_to_f is deprecated", uplevel: 1
  map(&:to_f)
end
elements_to_i() 点击切换源代码
# File matrix-0.4.2/lib/matrix.rb, line 2450
def elements_to_i
  warn "Vector#elements_to_i is deprecated", uplevel: 1
  map(&:to_i)
end
elements_to_r() 点击切换源代码
# File matrix-0.4.2/lib/matrix.rb, line 2455
def elements_to_r
  warn "Vector#elements_to_r is deprecated", uplevel: 1
  map(&:to_r)
end
eql?(other) 点击切换源代码
# File matrix-0.4.2/lib/matrix.rb, line 2203
def eql?(other)
  return false unless Vector === other
  @elements.eql? other.elements
end
freeze() 点击切换源代码

使矩阵冻结并可被 Ractor 共享

调用超类方法
# File matrix-0.4.2/lib/matrix.rb, line 2177
def freeze
  @elements.freeze
  super
end
hash() 点击切换源代码

返回向量的哈希码。

# File matrix-0.4.2/lib/matrix.rb, line 2211
def hash
  @elements.hash
end
independent?(*vs) 点击切换源代码

返回所有向量是否线性无关。

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

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

# File matrix-0.4.2/lib/matrix.rb, line 2163
def independent?(*vs)
  self.class.independent?(self, *vs)
end
inner_product(v) 点击切换源代码

返回此向量与另一个向量的内积。

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

# File matrix-0.4.2/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
也别名为：dot
inspect() 点击切换源代码

覆盖 Object#inspect

# File matrix-0.4.2/lib/matrix.rb, line 2490
def inspect
  "Vector" + @elements.inspect
end
magnitude() 点击切换源代码

返回向量的模（毕达哥拉斯距离）。

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

# File matrix-0.4.2/lib/matrix.rb, line 2373
def magnitude
  Math.sqrt(@elements.inject(0) {|v, e| v + e.abs2})
end
也别名为：r, norm
map()
别名为：collect
map!(&block)
别名为：collect!
map2(v) { |e1, e2| ... } 点击切换源代码

类似于 Vector#collect2，但返回 Vector 而不是数组。

# File matrix-0.4.2/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
norm()
别名为：magnitude
normalize() 点击切换源代码

返回一个具有相同方向但范数为 1 的新向量。

v = Vector[5,8,2].normalize
# => Vector[0.5184758473652127, 0.8295613557843402, 0.20739033894608505]
v.norm # => 1.0

# File matrix-0.4.2/lib/matrix.rb, line 2396
def normalize
  n = magnitude
  raise ZeroVectorError, "Zero vectors can not be normalized" if n == 0
  self / n
end
r()
别名为：magnitude
round(ndigits=0) 点击切换源代码

返回一个向量，其条目四舍五入到给定的精度（参见 Float#round）

# File matrix-0.4.2/lib/matrix.rb, line 2082
def round(ndigits=0)
  map{|e| e.round(ndigits)}
end
size() 点击切换源代码

返回向量中元素的数量。

# File matrix-0.4.2/lib/matrix.rb, line 2089
def size
  @elements.size
end
to_a() 点击切换源代码

返回数组中的向量元素。

# File matrix-0.4.2/lib/matrix.rb, line 2434
def to_a
  @elements.dup
end
to_matrix() 点击切换源代码

从此向量返回一个单列矩阵

# File matrix-0.4.2/lib/matrix.rb, line 2441
def to_matrix
  Matrix.column_vector(self)
end
to_s() 点击以切换源代码

重写 Object#to_s

# File matrix-0.4.2/lib/matrix.rb, line 2483
def to_s
  "Vector[" + @elements.join(", ") + "]"
end
zero?() 点击以切换源代码

返回是否所有元素都为零。

# File matrix-0.4.2/lib/matrix.rb, line 2170
def zero?
  all?(&:zero?)
end

私有实例方法

initialize_copy(v) 点击以切换源代码

为 dup & clone 调用。

调用超类方法
# File matrix-0.4.2/lib/matrix.rb, line 2185
        def initialize_copy(v)
  super
  @elements = @elements.dup unless frozen?
end
set_component(i, v)
别名: []=
set_element(i, v)
别名: []=
set_range(range, value) 点击以切换源代码
# File matrix-0.4.2/lib/matrix.rb, line 2067
        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) 点击以切换源代码
# File matrix-0.4.2/lib/matrix.rb, line 2063
        def set_value(index, value)
  @elements[index] = value
end