Spec-Zone.ru › Ruby 3

класс Vector

Родитель:
Объект
Включенные модули:
ИсключениеДляМатрицы, Перечислимый

Класс Vector представляет собой математический вектор, который полезен сам по себе и также образует строку или столбец Matrix.

Method Каталог

Для создания вектора:

  • Vector.[](*array)

  • Vector.elements(массив, копировать = true)

  • Vector.basis(размер: n, индекс: k)

  • Vector.zero(n)

Для доступа к элементам:

  • [](i)

Для установки элементов:

  • []=(i, v)

Для перечисления элементов:

  • each2(v)

  • collect2(v)

Свойства векторов:

  • angle_with(v)

  • Vector.independent?(*vs)

  • independent?(*vs)

  • zero?

Vector арифметика:

  • *(x) «является матрицей или числом»

  • +(v)

  • -(v)

  • #/(v)

  • +@

  • -@

Vector функции:

  • inner_product(v), dot(v)

  • cross_product(v), cross(v)

  • collect

  • collect!

  • magnitude

  • map

  • map!

  • map2(v)

  • norm

  • normalize

  • r

  • round

  • size

Преобразование в другие типы данных:

  • covector

  • to_a

  • coerce(other)

String представления:

  • to_s

  • inspect

Атрибуты

elements[R]

СОЗДАНИЕ ЭКЗЕМПЛЯРА

Общедоступные методы класса

[](*array) Показать исходный код
# File lib/matrix.rb, line 1952
def Vector.[](*array)
  new convert_to_array(array, false)
end

Создаёт Vector из списка элементов.

Vector[7, 4, ...]
basis(size:, index:) Показать исходный код
# File lib/matrix.rb, line 1969
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

Возвращает стандартный базисный n-вектор, где k — индекс.

Vector.basis(size:, index:) # => Vector[0, 1, 0]
elements(array, copy = true) Показать исходный код
# File lib/matrix.rb, line 1960
def Vector.elements(array, copy = true)
  new convert_to_array(array, copy)
end

Создаёт вектор из Array. Необязательный второй аргумент указывает, используется ли сам массив или его копия.

independent?(*vs) Показать исходный код
# File lib/matrix.rb, line 2116
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

Возвращает true тогда и только тогда, когда все векторы линейно независимы.

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

Vector.independent?(Vector[1,2], Vector[2,4])
#  => false
new(array) Показать исходный код
# File lib/matrix.rb, line 1991
def initialize(array)
  # No checking is done at this point.
  @elements = array
end

Vector.new является закрытым; используйте Vector[] или Vector.elements для создания.

zero(size) Показать исходный код
# File lib/matrix.rb, line 1982
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

Возвращает нулевой вектор.

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

Общедоступные методы экземпляра

*(x) Показать исходный код
# File lib/matrix.rb, line 2193
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

Умножает вектор на x, где x — это число или матрица.

+(v) Показать исходный код
# File lib/matrix.rb, line 2210
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

Vector сложение.

+@() Показать исходный код
# File lib/matrix.rb, line 2258
def +@
  self
end
-(v) Показать исходный код
# File lib/matrix.rb, line 2228
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

Vector вычитание.

-@() Показать исходный код
# File lib/matrix.rb, line 2262
def -@
  collect {|e| -e }
end
/(x) Показать исходный код
# File lib/matrix.rb, line 2246
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

Vector деление.

==(other) Показать исходный код
# File lib/matrix.rb, line 2169
def ==(other)
  return false unless Vector === other
  @elements == other.elements
end

Возвращает true тогда и только тогда, когда два вектора имеют одинаковые элементы в том же порядке.

vector[range] Показать исходный код
vector[integer]
# File lib/matrix.rb, line 2005
def [](i)
  @elements[i]
end

Возвращает элемент или элементы вектора.

Также алиас: элемент, компонент
vector[range] = new_vector Показать исходный код
vector[range] = row_matrix
vector[range] = new_element
vector[integer] = new_element
# File lib/matrix.rb, line 2020
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 элемент или элементы вектора.

Также алиас: установить_элемент, установить_компонент
angle_with(v) Показать исходный код
# File lib/matrix.rb, line 2378
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

Возвращает угол с другим вектором. Результат находится в пределах [0..Math::PI].

Vector[1,0].angle_with(Vector[0,1])
# => Math::PI / 2
coerce(other) Показать исходный код
# File lib/matrix.rb, line 2438
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

Метод coerce предоставляет поддержку приведения типов в Ruby. Этот механизм приведения типов используется Ruby для обработки операций с числами смешанного типа: он предназначен для поиска совместимого общего типа между двумя операндами оператора. См. также Numeric#coerce.

collect() { |e| ... } Показать исходный код
# File lib/matrix.rb, line 2322
def collect(&block) # :yield: e
  return to_enum(:collect) unless block_given?
  els = @elements.collect(&block)
  self.class.elements(els, false)
end

Как в Array#collect.

Также алиас: map
collect!(&block) Показать исходный код
# File lib/matrix.rb, line 2332
def collect!(&block)
  return to_enum(:collect!) unless block_given?
  raise FrozenError, "can't modify frozen Vector" if frozen?
  @elements.collect!(&block)
  self
end

Как в Array#collect!

Также алиас: map!
collect2(v) { |e1, e2| ... } Показать исходный код
# File lib/matrix.rb, line 2094
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

Сбор (как в Enumerable#collect) по элементам этого вектора и v совместно.

Псевдоним для: []
covector() Показать исходный код
# File lib/matrix.rb, line 2398
def covector
  Matrix.row_vector(self)
end

Создаёт матрицу из этого вектора с одной строкой.

cross(*vs)
Псевдоним для: cross_product
cross_product(*vs) Показать исходный код
# File lib/matrix.rb, line 2297
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

Возвращает векторное произведение этого вектора с другими.

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]
Также алиас: cross
dot(v)
Псевдоним для: inner_product
each(&block) Показать исходный код
# File lib/matrix.rb, line 2071
def each(&block)
  return to_enum(:each) unless block_given?
  @elements.each(&block)
  self
end

Итерироваться по элементам этого вектора

each2(v) { |e1, e2| ... } Показать исходный код
# File lib/matrix.rb, line 2080
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

Итерироваться по элементам этого вектора и v совместно.

Псевдоним для: []
elements_to_f() Показать исходный код
# File lib/matrix.rb, line 2416
def elements_to_f
  warn "Vector#elements_to_f is deprecated", uplevel: 1
  map(&:to_f)
end
elements_to_i() Показать исходный код
# File lib/matrix.rb, line 2421
def elements_to_i
  warn "Vector#elements_to_i is deprecated", uplevel: 1
  map(&:to_i)
end
elements_to_r() Показать исходный код
# File lib/matrix.rb, line 2426
def elements_to_r
  warn "Vector#elements_to_r is deprecated", uplevel: 1
  map(&:to_r)
end
eql?(other) Показать исходный код
# File lib/matrix.rb, line 2174
def eql?(other)
  return false unless Vector === other
  @elements.eql? other.elements
end
freeze() Показать исходный код
# File lib/matrix.rb, line 2148
def freeze
  @elements.freeze
  super
end

Делает матрицу неизменяемой и доступной для совместного использования Ractor

Вызывается метод суперкласса Object#freeze
hash() Показать исходный код
# File lib/matrix.rb, line 2182
def hash
  @elements.hash
end

Возвращает хэш-код для вектора.

independent?(*vs) Показать исходный код
# File lib/matrix.rb, line 2134
def independent?(*vs)
  self.class.independent?(self, *vs)
end

Возвращает true , если все векторы линейно независимы.

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

Vector[1,2].independent?(Vector[2,4])
# => false
inner_product(v) Показать исходный код
# File lib/matrix.rb, line 2274
def inner_product(v)
  raise ErrDimensionMismatch if size != v.size

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

Возвращает скалярное произведение этого вектора с другим вектором.

Vector[4,7].inner_product Vector[10,1] # => 47
Также алиас: dot
inspect() Показать исходный код
# File lib/matrix.rb, line 2461
def inspect
  "Vector" + @elements.inspect
end

Переопределяет Object#inspect

magnitude() Показать исходный код
# File lib/matrix.rb, line 2344
def magnitude
  Math.sqrt(@elements.inject(0) {|v, e| v + e.abs2})
end

Возвращает модуль (расстояние по Пифагору) вектора.

Vector[5,8,2].r # => 9.643650761
Также алиас: r, norm
map()
Псевдоним для: collect
map!(&block)
Псевдоним для: collect!
map2(v) { |e1, e2| ... } Показать исходный код
# File lib/matrix.rb, line 2353
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

Как Vector#collect2, но возвращает Vector вместо Array.

norm()
Псевдоним для: magnitude
normalize() Показать исходный код
# File lib/matrix.rb, line 2367
def normalize
  n = magnitude
  raise ZeroVectorError, "Zero vectors can not be normalized" if n == 0
  self / n
end

Возвращает новый вектор с тем же направлением, но с нормой 1.

v = Vector[5,8,2].normalize
# => Vector[0.5184758473652127, 0.8295613557843402, 0.20739033894608505]
v.norm # => 1.0
r()
Псевдоним для: magnitude
round(ndigits=0) Показать исходный код
# File lib/matrix.rb, line 2053
def round(ndigits=0)
  map{|e| e.round(ndigits)}
end

Возвращает вектор с элементами, округленными до заданной точности (см. Float#round)

size() Показать исходный код
# File lib/matrix.rb, line 2060
def size
  @elements.size
end

Возвращает количество элементов в векторе.

to_a() Показать исходный код
# File lib/matrix.rb, line 2405
def to_a
  @elements.dup
end

Возвращает элементы вектора в массиве.

to_matrix() Показать исходный код
# File lib/matrix.rb, line 2412
def to_matrix
  Matrix.column_vector(self)
end

Возвращает матрицу из одного столбца из этого вектора

to_s() Показать исходный код
# File lib/matrix.rb, line 2454
def to_s
  "Vector[" + @elements.join(", ") + "]"
end

Переопределяет Object#to_s

zero?() Показать исходный код
# File lib/matrix.rb, line 2141
def zero?
  all?(&:zero?)
end

Возвращает true , если все элементы равны нулю.

Приватные методы экземпляра

initialize_copy(v) Показать исходный код
# File lib/matrix.rb, line 2156
        def initialize_copy(v)
  super
  @elements = @elements.dup unless frozen?
end

Вызывается для dup & clone.

Вызывает метод суперкласса
Псевдоним для: []=
Псевдоним для: []=
set_range(range, value) Показать исходный код
# File lib/matrix.rb, line 2038
        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 lib/matrix.rb, line 2034
        def set_value(index, value)
  @elements[index] = value
end

Ruby Core © 1993–2020 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API