Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > matrixライブラリ > Matrixクラス
クラスの継承リスト: Matrix < Enumerable < Object < Kernel < BasicObject
数Numericを要素とする行列を扱うクラスです。
行列
m * n 個の数a(i,j)を
[ a(0,0) a(0,1) a(0,2) a(0,3) ... a(0,n-1) ] [ a(1,0) a(1,1) a(1,2) a(1,3) ... a(1,n-1) ] [ a(2,0) a(2,1) a(2,2) a(2,3) ... a(2,n-1) ] [ ] [ a(m-1,0) a(m-1,n-1) ]
のように、縦横の表にあらわしたものを(m,n)型の行列といいます。 m=nの行列をm次の正方行列(square matrix)といいます。 インデックスは 0 から始まることに注意してください。
上からi番目の横の数の並びを第i行(the i-th row)、 左からj番目の縦の数の並びを第j列(the j-th column)といいます。
(m,n)型行列は、 大きさnの行(横)ベクトルをm個縦に並べたものとみなすこともできますし、 大きさmの列(縦)ベクトルをn個横に並べたものとみなすこともできます。
第i行、第j列にある数a(i,j)を(i,j)要素(the (i,j)-th element)といいます。
i=jの要素a(i,j)を対角要素(diagonal element)、 それ以外の要素を非対角要素(nondiagonal element)といいます。
require 'complex'することによって、 Matrixオブジェクトの要素はComplexクラスに拡張されます。 多くのメソッドは、この拡張されたMatrixクラスでも、期待通りに動作します。
次の例は、各要素を共役複素数に置換するメソッド Matrix#conjugate です。
require 'matrix'
require 'complex'
class Matrix
def conjugate
collect{|e| e.conjugate }
end
end
identity(n) -> Matrix[permalink][rdoc]unit(n) -> MatrixI(n) -> Matrixn次の単位行列を生成します。
単位行列とは、対角要素が全て1で非対角要素が全て0であるような行列のことです。
self[*rows] -> Matrix[permalink][rdoc]rows[i] を第 i 行とする行列を生成します。
例:
m = Matrix[[11, 12], [21, 22]]
p m #=> Matrix[[11, 12], [21, 22]]
# [11, 12]
# [21, 22]
build(row_size, column_size = row_size) {|row, col| ... } -> Matrix[permalink][rdoc]build(row_size, column_size = row_size) -> Enumerablerow_size×column_sizeの行列をブロックの返り値から生成します。
行列の各要素の位置がブロックに渡され、それの返り値が行列の要素となります。
ブロックを省略した場合は Enumerator を返します。
m = Matrix.build(2, 4) {|row, col| col - row }
=> Matrix[[0, 1, 2, 3], [-1, 0, 1, 2]]
m = Matrix.build(3) { rand }
=> a 3x3 matrix with random elements
column_vector(column) -> Matrix[permalink][rdoc]要素がcolumnの(n,1)型の行列(列ベクトル)を生成します。
columns(columns) -> Matrix[permalink][rdoc]引数 columns を列ベクトルの集合とする行列を生成します。
Matrix.rows との違いは引数として渡す配列の配列を列ベクトルの配列とみなして行列を生成します。
例:
require 'matrix'
a1 = [1, 2, 3]
a2 = [4, 5, 6]
a3 = [-1, -2, -3]
# 配列を行ベクトルとして生成
m = Matrix.rows([a1, a2, a3], true)
p m #=> Matrix[[1, 2, 3], [4, 5, 6], [-1, -2, -3]]
# 行列としてのイメージ => [ 1, 2, 3]
# [ 4, 5, 6]
# [-1, -2, -3]
# 配列を列ベクトルとして生成
m = Matrix.columns([a1, a2, a3])
p m #=> Matrix[[1, 4, -1], [2, 5, -2], [3, 6, -3]]
# 行列としてのイメージ => [1, 4, -1]
# [2, 5, -2]
# [3, 6, -3]
diagonal(*values) -> Matrix[permalink][rdoc]対角要素がvaluesで、非対角要素が全て0であるような 正方行列を生成します。
valuesに一次元Arrayを1個指定すると、そのArrayを唯一の要素とした1×1の行列が生成されます。
例:
require 'matrix' m = Matrix.diagonal(1, 2, 3) p m # => Matrix[[1, 0, 0], [0, 2, 0], [0, 0, 3]] a = [1,2,3] m = Matrix.diagonal(a) p m # => Matrix[[[1, 2, 3]]]
empty(row_size=0, column_size=0) -> Matrix[permalink][rdoc]要素を持たない行列を返します。
「要素を持たない」とは、行数もしくは列数が0の行列のことです。
row_size 、 column_size のいずれか一方は0である必要があります。
m = Matrix.empty(2, 0) m == Matrix[ [], [] ] # => true n = Matrix.empty(0, 3) n == Matrix.columns([ [], [], [] ]) # => true m * n # => Matrix[[0, 0, 0], [0, 0, 0]]
row_vector(row) -> Matrix[permalink][rdoc]要素がrowの(1,n)型の行列(行ベクトル)を生成します。
rows(rows, copy = true) -> Matrix[permalink][rdoc]引数 rows を行ベクトルの列とする行列を生成します。
引数 copy が偽(false)ならば、rows の複製を行いません。
例:
require 'matrix' a1 = [1, 2, 3] a2 = [10, 15, 20] m = Matrix.rows([a1, a2], false) # 配列を複製せずに行列を生成 p m #=> Matrix[[1, 2, 3], [10, 15, 20]] a2[1] = 1000 # 配列のデータを変更 p m #=> Matrix[[1, 2, 3], [10, 1000, 20]]
scalar(n, value) -> Matrix[permalink][rdoc]対角要素が全てvalue(数)で、非対角要素が全て0であるようなn次の正方行列を生成します。
例:
require 'matrix' m = Matrix.scalar(3, 2.5) p m # => Matrix[[2.5, 0, 0], [0, 2.5, 0], [0, 0, 2.5]]
zero(n) -> Matrix[permalink][rdoc]n × n の零行列（要素が全て 0 の行列）を生成して返します。
self * m -> Matrix | Vector[permalink][rdoc]self に行列またはベクトル m を右から乗じた行列を返します。
m が Vector オブジェクトなら返り値も Vector オブジェクトになります。
self * other -> Matrix[permalink][rdoc]self の各成分に数 other を掛けた行列を返します。
self ** n -> Matrix[permalink][rdoc]self の n 乗を返します。
self + m -> Matrix[permalink][rdoc]self に行列 m を加算した行列を返します。 self の column_size が 1 なら Vector オブジェクトも指定出来ます。
self - m -> Matrix[permalink][rdoc]self から行列mを減算した行列を返します。 self の column_size が 1 なら Vector オブジェクトも指定出来ます。
self / m -> Matrix[permalink][rdoc]self に行列 m の逆行列を右から乗じた行列を返します。
self / other -> Matrix[permalink][rdoc]self の各成分を数 other で割った行列を返します。
self == other -> bool[permalink][rdoc]eql?(other) -> bool自分自身と other を比較し、同値であれば真(true)を返します。
self[i, j] -> ()[permalink][rdoc]element(i, j) -> ()component(i, j) -> ()(i,j)要素を返します。 行列の範囲外の値を指定した場合には nil を返します。
例:
a1 = [1, 2, 3] a2 = [10, 15, 20] a3 = [-1, 2, 1.5] m = Matrix[a1, a2, a3] p m[0, 0] #=> 1 p m[1, 1] #=> 15 p m[1, 2] #=> 20 p m[1, 3] #=> nil
clone -> Matrix[permalink][rdoc]自分自身のコピーを返します。
coerce(other) -> Array[permalink][rdoc]他の数値オブジェクトとの変換を行います。
他の数値オブジェクトをMatrix::Scalarのオブジェクトに変換し、selfとの組を配列として返します。
例:
a1 = [1, 2] a2 = [-1.25, 2.2] m = Matrix[a1, a2] r = Rational(1, 2) p m.coerce(r) #=> [#<Matrix::Scalar:0x832df18 @value=(1/2)>, Matrix[[1, 2], [-1.25, 2.2]]]
collect {|x| ... } -> Matrix[permalink][rdoc]map {|x| ... } -> Matrix行列の各要素に対してブロックの適用を繰り返した結果を、要素として持つ行列を生成します。
例:
a1 = [ 1, 2, 3]
a2 = [10, 15, 20]
a3 = [-1, -2, 1.5]
m = Matrix[a1, a2, a3]
# 行列mのすべての要素に100を加える。
p m.collect { |x|
x + 100
} #=> Matrix[[101, 102, 103], [110, 115, 120], [99, 98, 101.5]]
column(j) -> Vector | nil[permalink][rdoc]column(j) {|x| ... } -> selfj 番目の列を Vector オブジェクトで返します。 j 番目の列が存在しない場合は nil を返します。 ブロックが与えられた場合はその列の各要素についてブロックを繰り返します。
例:
a1 = [ 1, 2, 3]
a2 = [10, 15, 20]
a3 = [-1, -2, 1.5]
m = Matrix[a1, a2, a3]
p m.column(1) #=> Vector[2, 15, -2]
cnt = 0
m.column(0) { |x|
cnt = cnt + x
}
p cnt #=> 24.5
column_size -> Fixnum[permalink][rdoc]column_count -> Fixnum行列の列数を返します。
column_vectors -> [Vector][permalink][rdoc]自分自身を列ベクトルの配列として返します。
例:
a1 = [ 1, 2, 3] a2 = [10, 15, 20] a3 = [-1, -2, 1.5] m = Matrix[a1, a2, a3] p m.row_vectors #=> [Vector[1, 10, -1], Vector[2, 15, -2], Vector[3, 20, 1.5]]
conjugate -> Matrix[permalink][rdoc]conj -> Matrix複素共役を取った行列を返します。
Matrix[[Complex(1,2), Complex(0,1), 0], [1, 2, 3]]
=> 1+2i i 0
1 2 3
Matrix[[Complex(1,2), Complex(0,1), 0], [1, 2, 3]].conjugate
=> 1-2i -i 0
1 2 3
determinant -> Rational | Float[permalink][rdoc]det -> Rational | Float行列式 (determinant) の値を返します。
determinant_e -> Rational | Float[permalink][rdoc]det_e -> Rational | Float不正な値を返します。 Matrix#determinant を代わりに使ってください。
diagonal? -> bool[permalink][rdoc]行列が対角行列ならば真を返します。
each(which = :all) {|e| ... } -> self[permalink][rdoc]each(which = :all) -> Enumerator行列の各要素を引数としてブロックを呼び出します。
0行目、1行目、…という順番で処理します。 which に以下の Symbol を指定することで 引数として使われる要素を限定することができます。
ブロックを省略した場合、 Enumerator を返します。
Matrix[ [1,2], [3,4] ].each { |e| puts e }
# => prints the numbers 1 to 4
Matrix[ [1,2], [3,4] ].each(:strict_lower).to_a # => [3]
[SEE_ALSO] Matrix#each_with_index
each_with_index(which = :all) {|e, row, col| ... } -> self[permalink][rdoc]each_with_index(which = :all) -> Enumerator行列の各要素をその位置とともに引数としてブロックを呼び出します。
which で処理する要素の範囲を指定することができます。 Matrix#each と同じなのでそちらを参照してください。
ブロックを省略した場合、 Enumerator を返します。
Matrix[ [1,2], [3,4] ].each_with_index do |e, row, col|
puts "#{e} at #{row}, #{col}"
end
# => 1 at 0, 0
# => 2 at 0, 1
# => 3 at 1, 0
# => 4 at 1, 1
[SEE_ALSO] Matrix#each
eigen -> Matrix::EigenvalueDecomposition[permalink][rdoc]eigensystem -> Matrix::EigenvalueDecomposition行列の固有値と左右の固有ベクトルを保持したオブジェクトを返します。
Matrix::EigenvalueDecomposition は to_ary を定義しているため、 多重代入によって3つの行列(右固有ベクトル、固有値行列、左固有ベクトル) を得ることができます。 これを [V, D, W] と書くと、 (元の行列が対角化可能ならば)、 D は対角行列で、 self == V*D*W, V = W.inverse を満たします。 D のそれぞれの対角成分が行列の固有値です。
m = Matrix[[1, 2], [3, 4]] v, d, v_inv = m.eigensystem d.diagonal? # => true v.inv == v_inv # => true (v * d * v_inv).round(5) == m # => true
[SEE_ALSO] Matrix::EigenvalueDecomposition
elements_to_f -> Matrix[permalink][rdoc]各要素を浮動小数点数 Float に変換した行列を返します。
このメソッドは deprecated です。 map(&:to_f) を使ってください。
elements_to_i -> Matrix[permalink][rdoc]各要素を整数 Integer に変換した行列を返します。
このメソッドは deprecated です。 map(&:to_i) を使ってください。
elements_to_r -> Matrix[permalink][rdoc]各要素を有理数 Rational に変換した行列を返します。
このメソッドは deprecated です。 map(&:to_r) を使ってください。
empty? -> bool[permalink][rdoc]行列が要素を持たないならば真を返します。
要素を持たないとは、行数か列数のいずれかが0であることを意味します。
[SEE_ALSO] Matrix.empty
index(value, selector = :all) -> [Integer, Integer] | nil[permalink][rdoc]index(selector = :all) {|e| ... } -> [Integer, Integer] | nilindex(selector = :all) -> Enumeratorfind_index(value, selector = :all) -> [Integer, Integer] | nilfind_index(selector = :all) {|e| ... } -> [Integer, Integer] | nilfind_index(selector = :all) -> Enumerator指定した値と一致する要素の位置を [row, column] という配列で返します。 ブロックを与えた場合は各要素を引数としてブロックを呼び出し、 返り値が真であった要素の位置を返します。
複数の位置で値が一致する/ブロックが真を返す、場合は最初 に見つかった要素の位置を返します。
selector で行列のどの部分を探すかを指定します。この引数の意味は Matrix#each を参照してください。
Matrix[ [1,2], [3,4] ].index(&:even?) # => [0, 1] Matrix[ [1,1], [1,1] ].index(1, :strict_lower) # => [1, 0]
value を指定せず、さらにブロックを省略した場合、 Enumerator を返します。
hash -> Fixnum[permalink][rdoc]行列のHash値を返します。
hermitian? -> bool[permalink][rdoc]行列がエルミートならば真を返します。
imaginary -> Matrix[permalink][rdoc]imag -> Matrix行列の虚部を返します。
Matrix[[Complex(1,2), Complex(0,1), 0], [1, 2, 3]] # => 1+2i i 0 # 1 2 3 Matrix[[Complex(1,2), Complex(0,1), 0], [1, 2, 3]].imaginary # => 2i i 0 # 0 0 0
inspect -> String[permalink][rdoc]自分自身を見やすい形式に文字列化し、その文字列を返します。
例:
a1 = [1, 2] a2 = [3, 4.5] m = Matrix[a1, a2] p m.to_s #=> "Matrix[[1, 2], [3, 4.5]]"
inverse -> Matrix[permalink][rdoc]inv -> Matrix逆行列を返します。
lower_triangular? -> bool[permalink][rdoc]行列が下三角行列ならば真を返します。
lup -> Matrix::LUPDecomposition[permalink][rdoc]lup_decomposition -> Matrix::LUPDecomposition行列の LUP 分解を保持したオブジェクトを返します。
Matrix::LUPDecomposition は to_ary を定義しているため、 多重代入によって3つの行列(下三角行列、上三角行列、置換行列) を得ることができます。これを [L, U, P] と書くと、 L*U = P*self を満たします。
a = Matrix[[1, 2], [3, 4]] l, u, p = a.lup l.lower_triangular? # => true u.upper_triangular? # => true p.permutation? # => true l * u == p * a # => true a.lup.solve([2, 5]) # => Vector[(1/1), (1/2)]
[SEE_ALSO] Matrix::LUPDecomposition
minor(from_row, row_size, from_col, col_size) -> Matrix[permalink][rdoc]minor(from_row..to_row, from_col..to_col) -> Matrixselfの部分行列を返します。
自分自身の部分行列を返します。 ただし、パラメータは次の方法で指定します。
例:
a1 = [ 1, 2, 3, 4, 5] a2 = [11, 12, 13, 14, 15] a3 = [21, 22, 23, 24, 25] a4 = [31, 32, 33, 34, 35] a5 = [51, 52, 53, 54, 55] m = Matrix[a1, a2, a3, a4, a5] p m.minor(0, 2, 1, 2) #=> Matrix[[2, 3], [12, 13]]
normal? -> bool[permalink][rdoc]行列が正規行列ならば真を返します。
orthogonal? -> bool[permalink][rdoc]行列が直交行列ならば真を返します。
permutation? -> bool[permalink][rdoc]行列が置換行列ならば真を返します。
rank -> Fixnum[permalink][rdoc]階数 (rank) を返します。
selfの行列の階数(rank)を返します。 行列の成分がFloatの場合は正しい値を返さない場合があります。 その場合は行列成分に Rational もしくは BigDecimal を使用してください。
rank_e -> Fixnum[permalink][rdoc]階数 (rank) を返します。
このメソッドは obsolete です。Matrix#rank を代わりに 使ってください。
real -> Matrix[permalink][rdoc]行列の実部を返します。
Matrix[[Complex(1,2), Complex(0,1), 0], [1, 2, 3]] # => 1+2i i 0 # 1 2 3 Matrix[[Complex(1,2), Complex(0,1), 0], [1, 2, 3]].real # => 1 0 0 # 1 2 3
real? -> bool[permalink][rdoc]行列の全要素が実(Numeric#real?)であれば真を返します。
Complexオブジェクトを要素に持つ場合は虚部が0でも偽を返します。
例:
Matrix[[1, 0], [0, 1]].real? #=> true Matrix[[Complex(0, 1), 0], [0, 1]].real? #=> false # 要素が実数であっても Complex オブジェクトなら偽を返す。 Matrix[[Complex(1, 0), 0], [0, 1]].real? #=> false
rectangular -> [Matrix, Matrix][permalink][rdoc]rect -> [Matrix, Matrix]行列を実部と虚部に分解したものを返します。
m.rect == [m.real, m.imag] # ==> true for all matrices m
[SEE_ALSO] Matrix#imaginary, Matrix#real
regular? -> bool[permalink][rdoc]行列が正方で正則なら真を、特異なら偽を返します。
行列が正則であるとは、正方行列であり、かつ、その逆行列が存在することです。 行列式が0でないことと同値です。
正方行列でない場合には例外 ExceptionForMatrix::ErrDimensionMismatch を 発生させます。
例:
a1 = [ 1, 2, 3] a2 = [10, 15, 20] a3 = [-1, -2, 1.5] m = Matrix[a1, a2, a3] p m.regular? #=> true a1 = [ 1, 2, 3] a2 = [10, 15, 20] a3 = [-1, -2, -3] m = Matrix[a1, a2, a3] p m.regular? #=> false a1 = [ 1, 2, 3] a2 = [10, 15, 20] a3 = [-1, -2, 1.5] a4 = [1, 1, 1] m = Matrix[a1, a2, a3, a4] p m.regular? #=> raise ExceptionForMatrix::ErrDimensionMismatch
round(ndigits = 0) -> Matrix[permalink][rdoc]行列の各要素を指定した桁数で丸めた行列を返します。
[SEE_ALSO] Float#round
row(i) -> Vector | nil[permalink][rdoc]row(i) {|x| ... } -> selfi 番目の行を Vector オブジェクトで返します。 i 番目の行が存在しない場合は nil を返します。 ブロックが与えられた場合はその行の各要素についてブロックを繰り返します。
Vector オブジェクトは Matrix オブジェクトとの演算の際には列ベクトルとして扱われることに注意してください。
例:
a1 = [1, 2, 3]
a2 = [10, 15, 20]
a3 = [-1, -2, 1.5]
m = Matrix[a1, a2, a3]
p m.row(1) #=> Vector[10, 15, 20]
cnt = 0
m.row(0) { |x|
cnt = cnt + x
}
p cnt #=> 6
row_size -> Fixnum[permalink][rdoc]row_count -> Fixnum行列の行数を返します。
row_vectors -> [Vector][permalink][rdoc]自分自身を行ベクトルの配列として返します。
例:
a1 = [ 1, 2, 3] a2 = [10, 15, 20] a3 = [-1, -2, 1.5] m = Matrix[a1, a2, a3] p m.row_vectors #=> [Vector[1, 2, 3], Vector[10, 15, 20], Vector[-1, -2, 1.5]]
singular? -> bool[permalink][rdoc]行列が正方で特異なら真を/正則なら偽を返します。
行列が特異(singular)であるとは、正則でないことです。 行列式が0であること同値です。
正方行列でない場合には例外 ExceptionForMatrix::ErrDimensionMismatch を 発生させます。
square? -> bool[permalink][rdoc]正方行列であるなら、真を返します。
symmetric? -> bool[permalink][rdoc]行列が対称ならば真を返します。
transpose -> Matrix[permalink][rdoc]t -> Matrix転置行列 (transpose matrix) を返します。
self をMatrixのオブジェクトで、(m,n)型行列としたとき a(j,i) を (i,j) 要素とする (n,m) 型行列を返します。
to_a -> Array[permalink][rdoc]自分自身をArrayに変換したものを返します。
行ベクトルを配列(Array)としたものの配列(つまり配列の配列)として返します。
例:
a1 = [ 1, 2, 3] a2 = [10, 15, 20] a3 = [-1, -2, 1.5] m = Matrix[a1, a2, a3] p m.to_a #=> [[1, 2, 3], [10, 15, 20], [-1, -2, 1.5]]
to_s -> String[permalink][rdoc]行列を文字列化し、その文字列を返します。
例:
a1 = [1, 2] a2 = [3, 4.5] m = Matrix[a1, a2] p m.to_s #=> "Matrix[[1, 2], [3, 4.5]]"
trace -> Fixnum | Float | Rational[permalink][rdoc]tr -> Fixnum | Float | Rationalトレース (trace) を返します。
行列のトレース (trace) とは、対角要素の和です。
例:
Matrix[[7,6], [3,9]].trace #=> 16
trace は正方行列でのみ定義されます。
unitary? -> bool[permalink][rdoc]行列がユニタリならば真を返します。
upper_triangular? -> bool[permalink][rdoc]行列が上三角行列ならば真を返します。
zero? -> bool[permalink][rdoc]行列が零行列ならば真を返します。