API · NumPy
Python numpy.argmax() 関数
numpy.argmax()関数は、与えられた NumPy 配列で最も高い値を持つ値のインデックスを返します。
このページの内容
Python NumPy の numpy.argmax() は、配列内の最大値そのものではなく、その最大値のインデックスを返します。返されたインデックスを使って値を取り出すか、axis を指定して各スライスのインデックスを1つずつ取得できます。最大値が複数ある場合は、最初に現れる位置が返されます。
numpy.argmax() が最大値のインデックスを選ぶ仕組み
既定の axis=None では、numpy.argmax() は配列の要素を1本の平坦化された列として扱って検索します。そのため、多次元配列の場合、返されるインデックスは平坦化後の列における位置です。代わりに軸を指定すると、その次元に沿って検索し、残りの各スライスについてインデックスを返します。
構文とパラメーター
関数のシグネチャは numpy.argmax(a, axis=None, out=None) です。引数 a は入力配列、または配列として扱えるオブジェクトです。axis は検索する次元を指定します。省略するか None にすると、入力は最初に平坦化されます。2次元配列では、axis=0 は各列を上から下へ検索して行インデックスを返し、axis=1 は各行を左から右へ検索して列インデックスを返します。指定した軸は結果の形状から取り除かれます。
省略可能な引数 out には結果を書き込む配列を指定します。その形状は結果の形状と一致し、データ型は返されるインデックスを格納できる必要があります。この関数はインデックス、またはインデックスの配列を返します。返された位置を使って、対応する最大値にアクセスできます。
1次元配列と多次元配列で最大値のインデックスを求める
次の例を実行します。
このセクションのコードと表示されるラベルや出力は英語のままです。
import numpy as np
a = np.array([2, 6, 1, 5])
index = np.argmax(a)
print(index)
print(a[index])
1
6
ここでは最大値は 6 で、その位置は 1 です。NumPy のインデックスは0から始まるためです。多次元配列でも、既定の設定では行と列の組ではなく、平坦化後の位置が1つ返されます。元の形状での座標が必要な場合は、numpy.unravel_index を使ってその位置を座標に変換します。
import numpy as np
a = np.array([[2, 1, 6],
[7, 4, 5]])
index = np.argmax(a)
print(index)
print(np.unravel_index(index, a.shape))
3
(np.int64(1), np.int64(0))
平坦化後の位置 3 は、値が 7 の行 1、列 0 を指します。
各スライスのインデックスを求める軸を選ぶ
形状が (2, 3) の2次元配列では、axis=0 は行方向を縮約するため、出力には各列につき行インデックスが1つずつ含まれます。axis=1 は列方向を縮約するため、各行につき列インデックスが1つずつ返されます。これらは検索対象の各スライス内での位置であり、元の配列を平坦化したときの位置ではありません。
このセクションのコードと表示されるラベルや出力は英語のままです。
import numpy as np
a = np.array([[2, 1, 6],
[7, 4, 5]])
print(np.argmax(a, axis=0))
print(np.argmax(a, axis=1))
[1 1 0]
[2 0]
たとえば、最初の列の最大値は 7 で、その行インデックスは 1 です。最初の行の最大値は 6 で、その列インデックスは 2 です。
同じ最大値を処理し、返されたインデックスを使う
最大値が複数ある場合、numpy.argmax() は検索順で最初に一致した位置を返します。軸を指定した場合、このルールは各スライスに個別に適用されます。次の1次元配列の例では、返された位置と、その位置にある値を確認できます。
このセクションのコードと表示されるラベルや出力は英語のままです。
import numpy as np
a = np.array([2, 6, 1, 6])
index = np.argmax(a)
print(index)
print(a[index])
1
6
最大値はいずれも 6 ですが、インデックス 1 は 3 より前にあります。軸を指定せず多次元配列を検索する場合、「最初」は平坦化後の順序を指します。軸を指定した場合は、各スライス内の順序を指します。
結果を out に書き込む
既存の配列に結果を書き込みたい場合は out を使います。配列の形状は結果に対応している必要があります。スカラー結果にはスカラー形状の配列を使い、軸を指定した検索では出力形状に合う配列を用意します。インデックスを格納できる整数型を選んでください。この関数呼び出しは、out に書き込むものと同じ結果も返します。
このセクションのコードと表示されるラベルや出力は英語のままです。
import numpy as np
a = np.array([[2, 1, 6],
[7, 4, 5]])
result = np.empty((), dtype=np.intp)
np.argmax(a, out=result)
print(result)
3
この既定の検索では結果の形状がスカラーなので、result は0次元配列です。軸を追加する場合は、結果のインデックス配列と同じ形状の out を用意してください。