NumPyのnumpy.diag()徹底解説：対角行列の操作をマスター

1. 既存の配列から対角要素を抽出する
2. 1次元配列から対角行列を作成する

既存の配列から対角要素を抽出する

numpy.diag(v, k=0) を行列（2次元配列）に適用すると、その行列の対角要素を1次元配列として抽出します。

• k: 対角要素のオフセットを指定します。
  • k = 0 (デフォルト): 主対角線（メインの対角線）の要素を抽出します。
  • k > 0: 主対角線より上の対角線（右上方向）の要素を抽出します。例えば k=1 は主対角線のすぐ上の対角線を意味します。
  • k < 0: 主対角線より下の対角線（左下方向）の要素を抽出します。例えば k=-1 は主対角線のすぐ下の対角線を意味します。
• v: 対角要素を抽出したい配列（通常は2次元配列）。

例

import numpy as np

# 2次元配列（行列）
matrix = np.array([[1, 2, 3],
                   [4, 5, 6],
                   [7, 8, 9]])

# 主対角線の要素を抽出
main_diag = np.diag(matrix)
print("主対角線:", main_diag)  # 出力: [1 5 9]

# k=1 の対角線を抽出
diag_k1 = np.diag(matrix, k=1)
print("k=1 の対角線:", diag_k1)  # 出力: [2 6]

# k=-1 の対角線を抽出
diag_k_neg1 = np.diag(matrix, k=-1)
print("k=-1 の対角線:", diag_k_neg1) # 出力: [4 8]

numpy.diag(v, k=0) を1次元配列に適用すると、その1次元配列の要素を対角要素とする2次元の対角行列を作成します。他の要素はすべて0になります。

• k: 対角要素を配置する位置のオフセットを指定します。
  • k = 0 (デフォルト): 主対角線に要素を配置します。
  • k > 0: 主対角線より上の対角線に要素を配置します。
  • k < 0: 主対角線より下の対角線に要素を配置します。
• v: 対角要素として使用したい1次元配列。

例

import numpy as np

# 1次元配列
vector = np.array([10, 20, 30])

# 主対角線に要素を配置する対角行列を作成
diag_matrix_main = np.diag(vector)
print("主対角行列:\n", diag_matrix_main)
# 出力:
# [[10  0  0]
#  [ 0 20  0]
#  [ 0  0 30]]

# k=1 の位置に要素を配置する対角行列を作成
diag_matrix_k1 = np.diag(vector, k=1)
print("k=1 の対角行列:\n", diag_matrix_k1)
# 出力:
# [[ 0 10  0  0]
#  [ 0  0 20  0]
#  [ 0  0  0 30]
#  [ 0  0  0  0]]

# k=-1 の位置に要素を配置する対角行列を作成
diag_matrix_k_neg1 = np.diag(vector, k=-1)
print("k=-1 の対角行列:\n", diag_matrix_k_neg1)
# 出力:
# [[ 0  0  0  0]
#  [10  0  0  0]
#  [ 0 20  0  0]
#  [ 0  0 30  0]]

numpy.diag() は、入力が2次元配列（行列）か1次元配列かによって挙動が変わる、非常に柔軟な関数です。

• 入力が1次元配列の場合
  特定の位置に要素を配置する対角行列を生成する。
• 入力が2次元配列の場合
  特定の対角要素を抽出する。

---

入力の次元に関する誤解

numpy.diag() の最も一般的な誤解は、入力の次元によって挙動が大きく変わるという点です。

• 1次元配列を入力した場合
  その要素を対角要素とする2次元の対角行列を生成します。
• 2次元配列 (行列) を入力した場合
  対角要素を抽出します。結果は1次元配列になります。

よくある間違い

• 「1次元配列から対角線を取り出そうとしたらエラーになった！」
  • 例: np.diag(np.array([1, 2, 3])) から [1, 2, 3] を期待しているが、上記のように2次元配列が生成されるため、その2次元配列からさらに対角要素を抽出するという意味不明な操作を試みようとすると混乱する。
• 「1次元配列を入力したのに、1次元配列が返ってこない！」
  • 例: np.diag(np.array([1, 2, 3])) が [[1, 0, 0], [0, 2, 0], [0, 0, 3]] を返すことに驚く。
  • トラブルシューティング
    これは正しい挙動です。1次元配列から対角行列を生成するのが numpy.diag() の役割の一つです。もし1次元配列のまま対角要素を取り出したいだけなら、そもそも numpy.diag() を使う必要はありません。例えば、行列の特定の行や列を取り出すようにインデックス指定を検討しましょう。

空の配列や0次元配列の扱い

• 0次元配列 (スカラー)
  np.diag(np.array(5)) は [[5]] (1x1の行列) を返します。スカラーを1x1の対角行列とみなすためです。
• 空の1次元配列
  np.diag(np.array([])) は空の2次元配列 [] を返します。これは直感的ではないかもしれませんが、空の対角行列として扱われます。

よくある間違い

• トラブルシューティング
  空の配列やスカラーが入力として渡される可能性がある場合は、if 文などで入力の形状をチェックし、それに応じた処理を記述することをおすすめします。
• これらの特殊なケースで、期待する形状や値と異なる結果になることがあります。

k 引数の誤用

k 引数は対角線のオフセットを指定しますが、これを誤解すると予期せぬ結果になります。

• k の値が大きすぎたり小さすぎたりすると、空の配列が返されることがあります。これは、指定されたオフセットに要素が存在しないためです。

例

import numpy as np

matrix = np.array([[1, 2, 3],
                   [4, 5, 6],
                   [7, 8, 9]])

# 存在しない対角線を指定
result = np.diag(matrix, k=3)
print(result) # 出力: []

# 負の方向で存在しない対角線を指定
result_neg = np.diag(matrix, k=-3)
print(result_neg) # 出力: []

トラブルシューティング

• 特に、抽出したい対角線が本当にそのオフセットにあるのか、視覚的に確認してみるのも良いでしょう。
• k の値が、対象の配列の次元範囲内に収まっているか確認してください。

numpy.diag() と numpy.diagonal() の混同

NumPyには numpy.diag() と ndarray.diagonal() という似た名前の関数があります。

• ndarray.diagonal() (または array.diagonal()): 既存の2次元以上の配列から対角要素を抽出する ことに特化しており、対角行列の生成はできません。
• numpy.diag(): 上記で説明したように、対角要素の抽出 と 対角行列の生成 の両方をこなす。

よくある間違い

• 「行列から対角要素を取り出したいだけで numpy.diag() と ndarray.diagonal() のどちらを使えばいいか迷う。」
• 「1次元配列から対角行列を作りたいのに array.diagonal() を使ったらエラーになった！」
  • np.array([1, 2, 3]).diagonal() はエラーになります。diagonal() メソッドは1次元配列には存在しないためです。

トラブルシューティング

• それぞれの関数のドキュメントを確認し、用途を理解しておくことが重要です。
• 1次元配列から対角行列を生成したい場合
  numpy.diag() を使います。
• 対角要素を抽出したいだけの場合
  ndarray.diagonal() を使う方が意図が明確で、コードの可読性が高まります。

非常に大きな1次元配列から numpy.diag() を使って対角行列を作成しようとすると、メモリ不足エラーが発生する可能性があります。これは、N 個の要素を持つ1次元配列から N x N の2次元配列が生成されるため、メモリ使用量が劇的に増加するためです。

例

import numpy as np

# 極端に大きな配列
# vector = np.random.rand(10000000) # これを実行するとメモリ不足になる可能性が高い

# diag_matrix = np.diag(vector)

トラブルシューティング

• もし対角要素以外がほとんど0である巨大な行列を扱う必要がある場合は、SciPy の疎行列 (sparse matrix) 機能 の利用を検討してください。scipy.sparse.diags のような関数は、非ゼロ要素のみを保存することでメモリを節約します。
• 生成しようとしている対角行列が本当に必要なのか、そのサイズが適切なのかを再検討してください。

import numpy as np
from scipy.sparse import diags

# 大きな配列
vector = np.random.rand(100000)

# 疎行列として対角行列を作成 (メモリ効率が良い)
sparse_diag_matrix = diags(vector)
print(sparse_diag_matrix)

numpy.diag() はNumPyの強力な機能の一つですが、その挙動は入力の次元に依存するため、この点を理解しておくことが重要です。エラーに遭遇した場合は、以下の点をチェックしてみてください。

• 生成される配列のサイズが大きすぎてメモリを圧迫していないか？ (必要であれば疎行列を検討)
• numpy.diag() と ndarray.diagonal() のどちらが目的に合っているか？
• k 引数の値は適切か？
• 期待する出力の次元は何か？ (1次元配列か2次元行列か)
• 入力配列の次元は何か？ (1次元か2次元か)

---

行列から対角要素を抽出する

最も一般的な使用法の一つです。2次元配列（行列）を与えると、その対角線上の要素を1次元配列として返します。

例 1: 主対角線の抽出

import numpy as np

# 3x3 の行列を作成
matrix = np.array([[1, 2, 3],
                   [4, 5, 6],
                   [7, 8, 9]])

print("元の行列:\n", matrix)

# 主対角線 (k=0, デフォルト) の要素を抽出
main_diagonal = np.diag(matrix)
print("\n主対角線 (k=0):\n", main_diagonal)
# 出力: [1 5 9]

例 2: 主対角線より上の対角線 (super-diagonal) の抽出

k 引数に正の整数を指定すると、主対角線より上の対角線（右上方向）の要素を抽出できます。

import numpy as np

matrix = np.array([[1, 2, 3],
                   [4, 5, 6],
                   [7, 8, 9]])

# k=1 の対角線 (主対角線のすぐ上) を抽出
super_diagonal = np.diag(matrix, k=1)
print("\nk=1 の対角線:\n", super_diagonal)
# 出力: [2 6]

# k=2 の対角線 (さらに上) を抽出
super_diagonal_k2 = np.diag(matrix, k=2)
print("k=2 の対角線:\n", super_diagonal_k2)
# 出力: [3]

例 3: 主対角線より下の対角線 (sub-diagonal) の抽出

import numpy as np

matrix = np.array([[1, 2, 3],
                   [4, 5, 6],
                   [7, 8, 9]])

# k=-1 の対角線 (主対角線のすぐ下) を抽出
sub_diagonal = np.diag(matrix, k=-1)
print("\nk=-1 の対角線:\n", sub_diagonal)
# 出力: [4 8]

# k=-2 の対角線 (さらに下) を抽出
sub_diagonal_k2 = np.diag(matrix, k=-2)
print("k=-2 の対角線:\n", sub_diagonal_k2)
# 出力: [7]

1次元配列を numpy.diag() に渡すと、その要素を対角線上に配置した2次元の対角行列が生成されます。対角線以外の要素はすべてゼロになります。

例 4: 主対角行列の生成

import numpy as np

# 1次元配列を作成
vector = np.array([10, 20, 30])

print("元の1次元配列:\n", vector)

# 1次元配列から主対角行列を作成
diag_matrix_main = np.diag(vector)
print("\n主対角行列:\n", diag_matrix_main)
# 出力:
# [[10  0  0]
#  [ 0 20  0]
#  [ 0  0 30]]

例 5: オフセットを指定して対角行列を生成

k 引数を使って、対角要素を主対角線以外に配置した行列を生成することもできます。

import numpy as np

vector = np.array([10, 20, 30])

# k=1 の位置に対角要素を配置する行列を作成
diag_matrix_k1 = np.diag(vector, k=1)
print("\nk=1 の対角行列:\n", diag_matrix_k1)
# 出力:
# [[ 0 10  0  0]
#  [ 0  0 20  0]
#  [ 0  0  0 30]
#  [ 0  0  0  0]]
# (自動的にサイズが調整される)

# k=-1 の位置に対角要素を配置する行列を作成
diag_matrix_k_neg1 = np.diag(vector, k=-1)
print("k=-1 の対角行列:\n", diag_matrix_k_neg1)
# 出力:
# [[ 0  0  0  0]
#  [10  0  0  0]
#  [ 0 20  0  0]
#  [ 0  0 30  0]]

例 6: 抽出した対角要素から新しい対角行列を作成

numpy.diag() の出力を再び numpy.diag() の入力として使うことで、元の行列の対角要素のみを持つ新しい対角行列を作成できます。

import numpy as np

matrix = np.array([[1, 2, 3],
                   [4, 5, 6],
                   [7, 8, 9]])

print("元の行列:\n", matrix)

# 1. 主対角線を抽出
main_diagonal = np.diag(matrix)
print("\n抽出した主対角線:\n", main_diagonal) # [1 5 9]

# 2. 抽出した1次元配列から新しい対角行列を作成
new_diag_matrix = np.diag(main_diagonal)
print("\n抽出した対角線から作成した新しい対角行列:\n", new_diag_matrix)
# 出力:
# [[1 0 0]
#  [0 5 0]
#  [0 0 9]]

例 7: numpy.diagonal() との比較

行列から対角要素を抽出するだけなら、ndarray.diagonal() メソッドも利用できます。こちらは、抽出に特化しており、より明確な意図をコードに示せます。

import numpy as np

matrix = np.array([[1, 2, 3],
                   [4, 5, 6],
                   [7, 8, 9]])

print("元の行列:\n", matrix)

# numpy.diag() を使用
diag_with_func = np.diag(matrix)
print("\nnumpy.diag() で抽出:\n", diag_with_func)

# ndarray.diagonal() を使用
diag_with_method = matrix.diagonal()
print("matrix.diagonal() で抽出:\n", diag_with_method)

# k引数も同様に使える
diag_with_method_k1 = matrix.diagonal(offset=1)
print("matrix.diagonal(offset=1) で抽出:\n", diag_with_method_k1)

---

行列から対角要素を抽出する代替方法

numpy.diag() を使って行列から対角要素を抽出する代わりに、以下の方法が考えられます。

a. ndarray.diagonal() メソッド

これは numpy.diag() の抽出機能に特化したメソッドであり、最も直接的な代替手段です。

import numpy as np

matrix = np.array([[1, 2, 3],
                   [4, 5, 6],
                   [7, 8, 9]])

print("元の行列:\n", matrix)

# numpy.diag() の代替として .diagonal() を使用
main_diagonal_alt = matrix.diagonal()
print("\n.diagonal() で抽出した主対角線:\n", main_diagonal_alt)
# 出力: [1 5 9]

# オフセットも指定可能
super_diagonal_alt = matrix.diagonal(offset=1)
print(".diagonal(offset=1) で抽出した対角線:\n", super_diagonal_alt)
# 出力: [2 6]

利点

• numpy.diag() のように「1次元配列から対角行列を生成する」という機能と混同する心配がないため、コードの意図がより明確になります。

欠点

• NumPy 配列のメソッドとして呼び出す必要があります (np.diagonal(matrix) のようには使えません)。

b. インデックス操作と np.arange()

より低レベルな操作で対角要素を抽出することも可能です。これは主に主対角線に限定されます。

import numpy as np

matrix = np.array([[1, 2, 3],
                   [4, 5, 6],
                   [7, 8, 9]])

print("元の行列:\n", matrix)

# 行と列のインデックスが同じ要素を抽出
# np.arange(matrix.shape[0]) は [0, 1, 2] を生成
diagonal_elements = matrix[np.arange(matrix.shape[0]), np.arange(matrix.shape[1])]
print("\nインデックス操作で抽出した主対角線:\n", diagonal_elements)
# 出力: [1 5 9]

# 注: この方法は正方行列でない場合や、k!=0 の対角線には直接適用しにくい

利点

• NumPy の基本的なインデックス操作の理解を深めるのに役立ちます。

欠点

• 正方行列でない場合、コードが複雑になったり、エラーになったりする可能性があります。
• k 引数のようなオフセットを考慮するのが複雑になります。

numpy.diag() を使って1次元配列から対角行列を生成する代わりに、以下の方法が考えられます。

a. numpy.zeros() とインデックス操作

まずゼロで埋められた行列を作成し、その後、目的の対角要素を挿入する方法です。

import numpy as np

vector = np.array([10, 20, 30])
n = len(vector)

print("元の1次元配列:\n", vector)

# N x N のゼロ行列を作成
diag_matrix_alt = np.zeros((n, n), dtype=vector.dtype)

# 主対角線に要素を代入
diag_matrix_alt[np.arange(n), np.arange(n)] = vector
print("\nzeros() とインデックス操作で作成した主対角行列:\n", diag_matrix_alt)
# 出力:
# [[10  0  0]
#  [ 0 20  0]
#  [ 0  0 30]]

# k=1 の対角行列を作成する場合
# より大きな行列が必要になる点に注意
m = n + 1 # 例: 3x3 のベクトルから k=1 で対角行列を作るなら 4x4
diag_matrix_k1_alt = np.zeros((m, m), dtype=vector.dtype)
row_indices = np.arange(n)
col_indices = np.arange(n) + 1 # k=1 のオフセット
diag_matrix_k1_alt[row_indices, col_indices] = vector
print("\nzeros() とインデックス操作で作成した k=1 の対角行列:\n", diag_matrix_k1_alt)
# 出力:
# [[ 0 10  0  0]
#  [ 0  0 20  0]
#  [ 0  0  0 30]
#  [ 0  0  0  0]]

利点

• 行列の初期化と要素の代入という、より基本的な操作の組み合わせなので、NumPy の動作原理を理解するのに役立ちます。

欠点

• k 引数を再現しようとすると、行列のサイズ計算やインデックスのオフセット調整が複雑になります。
• numpy.diag() に比べてコードが冗長になります。

b. numpy.eye() を活用する (単位行列の変形)

numpy.eye() は単位行列（主対角線が1で、他が0の行列）を生成する関数です。これを活用して対角行列を作成することもできます。

import numpy as np

vector = np.array([10, 20, 30])
n = len(vector)

print("元の1次元配列:\n", vector)

# 単位行列を作成し、要素ごとの乗算で対角行列に変換
# np.eye(n) は n x n の単位行列を生成
diag_matrix_eye = np.eye(n) * vector
print("\neye() と乗算で作成した主対角行列:\n", diag_matrix_eye)
# 出力:
# [[10.  0.  0.]
#  [ 0. 20.  0.]
#  [ 0.  0. 30.]]

# k引数に相当する機能は直接ありませんが、
# scipy.sparse.eye と組み合わせてオフセット付きの単位行列を作成し、
# それに乗算する方法も考えられますが、複雑になります。

利点

• 主対角行列を生成する場合には、比較的簡潔で読みやすいコードになります。

欠点

• 浮動小数点型になるため、整数型が必要な場合は型変換が必要です。
• k 引数のようにオフセットを持つ対角行列を直接生成することはできません。

c. SciPy の疎行列 (scipy.sparse.diags)

非常に大きな対角行列を扱う場合、対角要素以外のほとんどがゼロであるため、通常の NumPy 配列として保持するとメモリが無駄になります。このような場合、SciPy ライブラリの疎行列機能を利用するのが効果的です。scipy.sparse.diags は、numpy.diag() と同様にオフセット付きで対角行列を生成できますが、メモリ効率が大幅に向上します。

import numpy as np
from scipy.sparse import diags

vector = np.array([10, 20, 30])

print("元の1次元配列:\n", vector)

# 主対角の疎行列を生成
sparse_diag_main = diags(vector)
print("\nscipy.sparse.diags で作成した主対角行列 (疎行列形式):\n", sparse_diag_main)
# 出力例:
# (0, 0)        10.0
# (1, 1)        20.0
# (2, 2)        30.0

# k=1 の疎行列を生成
sparse_diag_k1 = diags(vector, offsets=1)
print("\nscipy.sparse.diags で作成した k=1 の対角行列 (疎行列形式):\n", sparse_diag_k1)
# 出力例:
# (0, 1)        10.0
# (1, 2)        20.0
# (2, 3)        30.0

# 疎行列を通常の密行列に変換（必要に応じて）
dense_matrix = sparse_diag_k1.toarray()
print("\n疎行列を密行列に変換:\n", dense_matrix)
# 出力:
# [[ 0. 10.  0.  0.]
#  [ 0.  0. 20.  0.]
#  [ 0.  0.  0. 30.]
#  [ 0.  0.  0.  0.]]

利点

• numpy.diag() と同様に、オフセット (k) を指定して対角線を配置できます。
• 非常に大きな対角行列を扱う際に、メモリ使用量を大幅に削減できます。

• 疎行列形式のままだと、通常の NumPy 配列のような直感的なインデックス操作が一部異なります。密行列に変換する手間が発生する場合があります。
• SciPy ライブラリの導入が必要です。

目的	numpy.diag() の代替方法	主な利点	主な欠点
対角要素の抽出	ndarray.diagonal()	意図が明確、抽出に特化	配列メソッドとして呼び出す必要がある
	インデックス操作 (matrix[np.arange(n), np.arange(n)])	基本的な操作の理解を深める	k 引数や非正方行列の対応が複雑になる
対角行列の生成	numpy.zeros() + インデックス操作	基本的な操作の組み合わせ	コードが冗長、k 引数対応が複雑
	numpy.eye() + 要素ごとの乗算	主対角行列なら簡潔	k 引数に対応しない、型変換が必要な場合あり
	scipy.sparse.diags	大規模データでのメモリ効率が良い	SciPy 導入が必要、疎行列の特性を理解する必要がある