NumPy配列の要素が1つでも条件を満たすか確認するany()の使い方

numpy.any()は、配列内に1つでも条件を満たす要素があるかどうかを確認するために使う関数です。具体的には、配列内の要素が1つでも True であれば True を返します。一方で、配列内の全ての要素が False の場合に False を返します。

これと似たものにnumpy.all()というものもあります。こちらは、配列内の全ての要素が条件を満たすかどうかを確認することができる関数です。具体的には、配列内の全ての要素が True の場合のみ True を返します。そして、配列内の要素に1つでも False があれば False を返します。これについては、以下のページで解説しています。

• 『NumPy配列の全要素が条件を満たすか確認するall()の使い方』

これらを使うことで配列の要素の確認を効率化することができます。このページでは、このうちnumpy.any()について解説します。

1. 書式

まずは、基本的な書き方を確認しましょう。

np.any(a, axis=None, out=None, keepdims=<no value>)

2. サンプルコード

それでは、np.any()の使い方をサンプルコードで確認していきましょう。

この関数は、渡した配列の要素が1つでも True であれば True を返します。

# Trueの要素が1つでもあればTrueを返す。
import numpy as np
x = np.array([True, False])
np.any(x)

True

True が1つも含まれていない場合のみ False を返します。

# Trueが含まれていない場合のみFalseを返す。
x = np.array([False, False])
np.any(x)

False

なお、False と判定されるのは、全ての要素がブール値 False または数値の 0 の場合です。数値の 0 も False と判定される理由は、Pythonでは False と 0 は同じ値として処理されるためです。

#  全ての要素がFalseか0の場合のみFalseと判定
np.any([False])

False

np.any(0)

False

具体的な使い方

この関数は、具体的には次のように、配列内に1つでも条件を満たす要素があるかどうかを確認するために使います。

# 配列 x を作成
x = np.arange(5)
x

array([0, 1, 2, 3, 4])

# 配列内に 4 以上の要素が1つでも存在するかどうかを確認
np.any(x >= 4)

True

# 配列内に 5 以上の要素が1つでも存在するかどうかを確認
np.any(x >= 5)

False

多次元配列を渡す場合

np.any()に多次元配列を渡した場合、全ての次元軸の要素を同時に判定します。

# 配列を作成
x = np.arange(6).reshape(2, 3)
x

array([[0, 1, 2],
       [3, 4, 5]])

# 多次元配列の全ての要素を対象に判定
np.any(x <= 1)

True

次元軸を指定

オプション引数 axis= で判定を行う次元軸を指定することができます。

# 指定した軸(列)ごとに判定
np.any(x <= 1, axis=0)

array([ True,  True, False])

# 指定した軸(行)ごとに判定
np.any(x <= 1, axis=1)

array([ True, False])

次元数を維持

オプション引数 keepdims=True で次元数を維持することができます。この場合、指定していない軸の要素数が1になります。つまり、shape(m, n)の配列の場合、axis=None なら shape(1, 1) の配列を作成します。axis=0 なら shape(1, n) の配列を作成します。axis=1 なら shape(m, 1) の配列を作成します。覚えておくとブロードキャストが楽になります。

# keepdimsで元の次元数を維持
np.any(x <= 1, keepdims=True)

array([[ True]])

np.any(x <= 1, axis=0, keepdims=True)

array([[ True,  True, False]])

np.any(x <= 1, axis=1, keepdims=True)

array([[ True],
       [False]])

既存の配列を上書き

オプション引数 out= で、判定結果の配列で既存の配列を上書きすることができます。この場合、出力される配列と上書きされる配列のshapeが合致している必要があります。また要素の型は上書きされる配列のものがそのまま引き継がれます。つまり、上書きされる配列のデータが数値の場合、True の要素は 1 、False の要素は 0 に上書きされます。

#  判定用の配列
x = np.arange(6).reshape(2, 3)
x

array([[0, 1, 2],
       [3, 4, 5]])

# 上書き用の配列
a = np.array([0.0, 0.0])
a

array([0., 0.])

# 判定結果で a を上書き
np.any(x >= 3, axis=1, out=a)

array([0., 1.])

ndarray.anyメソッド

なお、np.any()関数とまったく同じ、ndarray.any()メソッドもあります。オプション引数はすべて同じです。

#  メソッドとして使用することも可能
x = np.arange(6).reshape(2, 3)
(x>4).any(axis=1)

array([False,  True])

(x>=4).any(axis=1, keepdims=True)

array([[False],
       [ True]])

3. まとめ

以上、np.any()は、配列内に1つでも条件を満たす要素が存在するかどうかを確認するための関数です。