Ruby 2.6.0 リファレンスマニュアル > ライブラリ一覧 > matrixライブラリ > Vectorクラス

class Vector

クラスの継承リスト: Vector < Enumerable < Object < Kernel < BasicObject

要約

Numeric を要素とするベクトルを扱うクラスです。 Vector オブジェクトは Matrix オブジェクトとの演算においては列ベクトルとして扱われます。

ベクトルの要素のインデックスは 0 から始まることに注意してください。

目次

特異メソッド
[] basis elements independent? zero
インスタンスメソッド
* + +@ - -@ / == eql? [] component element angle_with clone collect map collect2 covector cross cross_product dot inner_product each each2 elements_to_f elements_to_i elements_to_r hash independent? inspect magnitude norm r map2 normalize size to_a to_s zero?

特異メソッド

self[*a] -> Vector[permalink][rdoc]

可変個引数を要素とするベクトルを生成します。

Vector[a1, a2, a3, ... ]としたとき、 引数a1, a2, a3, ... を要素とするベクトルを生成します。

[PARAM] a:
ベクトルの要素


require 'matrix'
v1 = Vector[1, 3, 5, 7]
v2 = Vector[5.25, 10.5]
p v1   # => Vector[1, 3, 5, 7]
p v2   # => Vector[5.25, 10.5]
basis(size:, index:) -> Vector[permalink][rdoc]

size 次元ベクトル空間の index 番目の標準基底を返します。



require 'matrix'
Vector.basis(size: 3, index: 1) # => Vector[0, 1, 0]
[PARAM] size:
ベクトルの次元
[PARAM] index:
標準基底の何番目か。0 origin
elements(a, copy = true) -> Vector[permalink][rdoc]

配列 a を要素とするベクトルを生成します。 ただし、オプション引数 copy が偽 (false) ならば、複製を行いません。

[PARAM] a:
Vectorを生成する際の要素の配列
[PARAM] copy:
引数の配列 a のコピーをするかどうかのフラグ


require 'matrix'
a = [1, 2, 3, 4]
v1 = Vector.elements(a, true)
v2 = Vector.elements(a, false)
p v1        # => Vector[1, 2, 3, 4]
p v2        # => Vector[1, 2, 3, 4]
a[0] = -1
p v1        # => Vector[1, 2, 3, 4]
p v2        # => Vector[-1, 2, 3, 4]
independent?(*vectors) -> bool[permalink][rdoc]

ベクトルの列 vectors が線形独立であれば true を返します。

[PARAM] vectors:
線形独立性を判定するベクトル列
zero(size) -> Vector[permalink][rdoc]

零ベクトルを返します。



require 'matrix'
Vector.zero(3) # => Vector[0, 0, 0]
[PARAM] size:
ベクトルの次元

インスタンスメソッド

self * other -> Vector[permalink][rdoc]

self の各要素に数 other を乗じたベクトルを返します。

[PARAM] other:
self の各要素に掛ける Numeric オブジェクトを指定します。


require 'matrix'
a = [1, 2, 3.5, 100]
v1 = Vector.elements(a)
p v1.*(2)     # => Vector[2, 4, 7.0, 200]
p v1.*(-1.5)  # => Vector[-1.5, -3.0, -5.25, -150.0]
self * m -> Matrix[permalink][rdoc]

自分自身を列ベクトル(行列)に変換して (実際には Matrix.column_vector(self) を適用) から、行列 m を右から乗じた行列 (Matrix クラス) を返します。

[PARAM] m:
右から乗算を行う行列
[EXCEPTION] ExceptionForMatrix::ErrDimensionMismatch:
次元が合わない場合に発生します

注意

引数の行列 m は自分自身を列ベクトルとした場合に乗算が定義できる行列である必要があります。



require 'matrix'

v = Vector[1, 2]
a = [4, 5, 6]
m = Matrix[a]

p v * m # => Matrix[[4, 5, 6], [8, 10, 12]]
self + v -> Vector | Matrix[permalink][rdoc]

self にベクトル v を加えたベクトルを返します。

v には column_size が 1 の Matrix オブジェクトも指定できます。 その場合は返り値も Matrix オブジェクトになります。

[PARAM] v:
加算するベクトル。加算可能な行列やベクトルを指定します。
[EXCEPTION] ExceptionForMatrix::ErrDimensionMismatch:
自分自身と引数のベクト ルの要素の数(次元)が異なっていたときに発生します。
+ self -> self[permalink][rdoc]

単項演算子の + です。 self を返します。

self - v -> Vector | Matrix[permalink][rdoc]

self からベクトル v を減じたベクトルを返します。

v には column_size が 1 の Matrix オブジェクトも指定できます。 その場合は返り値も Matrix オブジェクトになります。

[PARAM] v:
減算するベクトル。減算可能な行列やベクトルを指定します。
[EXCEPTION] ExceptionForMatrix::ErrDimensionMismatch:
自分自身と引数のベクト ルの要素の数(次元)が異なっていたときに発生します。
- self -> self[permalink][rdoc]

単項演算子の - です。 各要素の符号を反転したベクトルを返します。

self / other -> Vector[permalink][rdoc]

self の各要素を数 other で割ったベクトルを返します。

[PARAM] other:
self の各要素を割る Numeric オブジェクトを指定します。
[EXCEPTION] ExceptionForMatrix::ErrOperationNotDefined:
other が Vector や Matrix の場合に発生します
self == v -> bool[permalink][rdoc]
eql?(v) -> bool

自分自身と引数 v を比較し、true/false を返します。

[PARAM] v:
比較対象ベクトル
self[i] -> object | nil[permalink][rdoc]
element(i) -> object | nil
component(i) -> object | nil

i 番目の要素を返します。インデックスは 0 から開始します。 要素が存在しないインデックスを指定した時には nil を返します。

[PARAM] i:
取得する要素のインデックスを整数値で指定します。 インデックスは 0 から始めます。
angle_with(v) -> Float[permalink][rdoc]

v と self がなす角度を返します。



require 'matrix'
Vector[1, 0].angle_with(Vector[0, 1]) # => Math::PI/2
[PARAM] v:
このベクトルと self とがなす角度を計算します
[EXCEPTION] ZeroVectorError:
self もしくは v のどちらかが零ベクトルである場合に 発生します
[EXCEPTION] ExceptionForMatrix::ErrDimensionMismatch:
v と self の ベクトルの次元が異なる場合に発生します。
clone() -> Vector[permalink][rdoc]

自分自身をコピーしたベクトルを返します。

collect {|x| ... } -> Vector[permalink][rdoc]
map {|x| ... } -> Vector
collect -> Enumerator
map -> Enumerator

ベクトルの各要素に対してブロックを評価した結果を、要素として持つベクトルを生成します。

ブロックを省略した場合は Enumerator を返します。



require 'matrix'
a = [1, 2, 3.5, -10]
v1 = Vector.elements(a)
p v1 # => Vector[1, 2, 3.5, -10]
v2 =  v1.map{|x|
  x * -1
}
p v2 # => Vector[-1, -2, -3.5, 10]
collect2(v) {|x, y| ... } -> Array[permalink][rdoc]
collect2(v) -> Enumerator

ベクトルの各要素と引数 v の要素との組に対してブロックを評価し、その結果を要素として持つ配列を返します。

ベクトルの各要素と、それに対応するインデックスを持つ引数 v (ベクトル or 配列)の要素との組に対して (2引数の) ブロックを評価し、その結果を要素として持つ配列を返します。

ブロックを省略した場合は Enumerator を返します。

[PARAM] v:
ブロック内で評価される(ベクトル or 配列)
[EXCEPTION] ExceptionForMatrix::ErrDimensionMismatch:
自分自身と引数のベクト ルの要素の数(次元)が異なっていたときに発生します。

[SEE_ALSO] Vector#map2

次の例は、2つのベクトルの要素毎の積を要素とする配列を生成します。



require 'matrix'

v1 = Vector[2, 3, 5]
v2 = Vector[7, 9, 11]
a = Array[7, 9, 11]

z = v1.collect2(v2){ |x, y| x * y }
p z # => [14, 27, 55]

z = v1.collect2(a) { |x, y| x * y } # Array でも OK
p z # => [14, 27, 55]
covector -> Matrix[permalink][rdoc]

Matrix オブジェクトへ変換します。

列ベクトル (行列)、すなわち、(n, 1) 型の行列に変換します。 実際には Matrix.row_vector(self) を適用します。



require 'matrix'

v = Vector[2, 3, 5]
p v # => Vector[2, 3, 5]
m = v.covector
p m # => Matrix[[2, 3, 5]]
cross_product(*vs) -> Vector[permalink][rdoc]
cross(*vs) -> Vector

self とベクトル vs とのクロス積を返します。

self が3次元ベクトル空間のときは 普通のクロス積です。 それ以外の場合は拡張されたクロス積で n-1個のn次元ベクトルが張る空間と 直交するベクトルを返します。

self の次元が n であるとき、 vs は n-2 個の n次元ベクトルでなければなりません。

[PARAM] vs:
クロス積を取るベクトルの集合
[EXCEPTION] ExceptionForMatrix::ErrOperationNotDefined:
self の 次元が1以下であるときに発生します。
[EXCEPTION] ArgumentError:
vs のベクトルの個数が n-2 以外である場合に発生します。
inner_product(v) -> Float[permalink][rdoc]
dot(v) -> Float

ベクトル v との内積を返します。

[PARAM] v:
内積を求めるベクトル
[EXCEPTION] ExceptionForMatrix::ErrDimensionMismatch:
自分自身と引数のベクト ルの要素の数(次元)が異なっていたときに発生します。
each {|e| ... } -> self[permalink][rdoc]
each -> Enumerator

ベクトルの各要素をブロックの引数として順にブロックを呼び出します。

このクラスは Enumerable を include しているため、 このメソッドを経由して Enumerable の各メソッドを使うことができます。

ブロックを省略した場合は Enumerator を返します。

each2(v) {|x, y| ... } -> self[permalink][rdoc]
each2(v) -> Enumerator

ベクトルの各要素と、それに対応するインデックスを持つ引数 v の要素との組に対して (2引数の) ブロックを繰返し評価します。

v は配列互換(size メソッドと [] メソッドを持つ)オブジェクトです。 Vector も使えます。

ブロックを省略した場合は Enumerator を返します。

[PARAM] v:
各要素と組を取るためのオブジェクト
[EXCEPTION] ExceptionForMatrix::ErrDimensionMismatch:
自分自身と引数のベクト ルの要素の数(次元)が異なっていたときに発生します。

[SEE_ALSO] Array#zip

elements_to_f -> Vector[permalink][rdoc]

ベクトルの各成分をFloatに変換したベクトルを返します。

このメソッドは deprecated です。 map(&:to_f) を使ってください。



require 'matrix'

v = Vector.elements([2, 3, 5, 7, 9])
vf = v.elements_to_f
p vf # => "Vector[2.0, 3.0, 5.0, 7.0, 9.0]"
elements_to_i -> Vector[permalink][rdoc]

ベクトルの各成分をIntegerに変換したベクトルを返します。

このメソッドは deprecated です。 map(&:to_i) を使ってください。



require 'matrix'
v = Vector.elements([2.5, 3.0, 5.01, 7])
vi = v.elements_to_i
p vi # => "Vector[2, 3, 5, 7]"
elements_to_r -> Vector[permalink][rdoc]

ベクトルの各成分をRationalに変換したベクトルを返します。

このメソッドは deprecated です。 map(&:to_r) を使ってください。



require 'matrix'

v = Vector.elements([2.5, 3.0, 5.75, 7])
vr = v.elements_to_r
p vr # => "Vector[Rational(5, 2), Rational(3, 1), Rational(23, 4), Rational(7, 1)]"
hash() -> Integer[permalink][rdoc]

自分自身のハッシュ値を返します。

independent?(*vectors) -> bool[permalink][rdoc]

self とベクトルの列 vectors が線形独立であれば true を返します。

require 'matrix'
Vector.independent?(self, *vectors)

と同じです。

[PARAM] vectors:
線形独立性を判定するベクトル列
inspect() -> String[permalink][rdoc]

オブジェクトの内容を文字列化します。

r -> Float[permalink][rdoc]
magnitude -> Float
norm -> Float

ベクトルの大きさ(ノルム)を返します。



require 'matrix'
Vector[3, 4].norm # => 5.0
Vector[Complex(0, 1), 0].norm # => 1.0

[SEE_ALSO] Vector#normalize

map2(v) {|x, y| ... } -> Vector[permalink][rdoc]

ベクトルの各要素と引数 v の要素との組に対してブロックを評価し、その結果を要素として持つベクトルを返します。

ベクトルの各要素と、それに対応するインデックスを持つ引数 (ベクトル or 配列) の要素との組に対して (2引数の) ブロックを評価した結果を、要素として持つベクトルを返します。

ブロックを省略した場合は Enumerator を返します。

[PARAM] v:
ブロック内で評価される(ベクトル or 配列)
[EXCEPTION] ExceptionForMatrix::ErrDimensionMismatch:
自分自身と引数のベクト ルの要素の数(次元)が異なっていたときに発生します。

[SEE_ALSO] Vector#collect2

次の例は、2つのベクトルの要素毎の積を要素として持つベクトルを生成します。



require 'matrix'

v1 = Vector[2, 3, 5]
v2 = Vector[7, 9, 11]
a = Array[7, 9, 11]

z = v1.map2(v2) { |x, y| x * y }
p z # => Vector[14, 27, 55]

z = v1.map2(a) { |x, y| x * y } # Array でも OK
p z # => Vector[14, 27, 55]
normalize -> Vector[permalink][rdoc]

自身を Vector#norm で正規化したベクトルを返します。

[EXCEPTION] Vector::ZeroVectorError:
ベクトルが0である場合に発生します。


require 'matrix'
v = Vector[2, 6, 9].normalize
# => Vector[0.18181818181818182, 0.5454545454545454, 0.8181818181818182]
v.norm # => 1.0

[SEE_ALSO] Vector#norm

size() -> Integer[permalink][rdoc]

ベクトルの要素数(次元)を返します。

to_a -> Array[permalink][rdoc]

ベクトル(Vector)から配列 (Array) に変換します。



require 'matrix'

v = Vector[2, 3, 5, 7, 9]
a = v.to_a
p a # => [2, 3, 5, 7, 9]
to_s -> String[permalink][rdoc]

ベクトル(Vector)から文字列 (String) に変換します。



require 'matrix'

v = Vector[2, 3, 5, 7, 9]
s = v.to_s
p s # => "Vector[2, 3, 5, 7, 9]"
zero? -> bool[permalink][rdoc]

すべての要素がゼロであれば true を返します。