NumPy配列の要素の合計を求めるsum関数の使い方

NumPyのsum関数は、指定の軸に沿って配列の合計値を求める関数です。ここでは、その使い方について解説していきます。なお同じ機能を持つメソッドにndarray.sumがあります。これについても解説します。それでは、早速見ていきましょう。

1. 書式

まずは、書き方を確認しましょう。

ご覧頂く通り、np.sumには多くのオプション引数があります。しかし全てを一度に理解しようとする必要はありません。最もよく使うのは axis なので、まずはこれを抑えておきましょう。他には initial, keepdims 辺りを優先的に抑えておくと良いでしょう。

np.sum(a, axis=None, dtype=None, out=None, keepdims=<no value>, initial=<no value>, where=<no value>)

ndarray.sum(axis=None, dtype=None, out=None, keepdims=False, initial=0, where=True)

Note

np.sumは整数(int型)を扱う場合はモジュラー計算であり、エラーの心配はありません。

ただし、浮動小数点数(float型)を扱う場合は、1つ1つの数値を個々に足し合わせるというステップを経るため、通常はそのような問題が起きないように対処されているとしても、1つ1つの足し算を行う度に丸めの問題が起きる可能性があります。そのため計算精度については以下の点を理解しておくと良いでしょう。

なお、np.sumに空の配列を渡すと、戻り値は0になります。

import numpy as np
np.sum([])

0.0

2. サンプルコード

それでは、軸の指定の仕方でどう計算結果が異なるかを、実際のコードを見ながら把握していきましょう。

1次元配列の場合

np.sum()は、引数に渡した配列の要素の合計を戻します。以下の1次元配列a を例にして見ていきましょう。

import numpy as np
rng = np.random.default_rng()
a = rng.integers(0, 11, (5, ))
a

array([3, 3, 6, 3, 5])

この1次元配列をnp.sum()に渡すと要素の合計値を返します。

# 合計値を取得
np.sum(a)

20

メソッドも同様です。メソッドの場合は、対象となる配列は引数に渡すのではなく前に書きます。

# ndarray.sum()メソッドも同様
a.sum()

20

多次元配列の場合

多次元配列の場合もデフォルトでは全要素の合計値を返します。以下の2次元配列を例に見てみましょう。

import numpy as np
rng = np.random.default_rng()
a = rng.integers(0, 31, (3,  5))
a

array([[27, 22, 17, 25,  9],
       [23, 12,  2,  9,  7],
       [19, 10, 21, 14,  5]])

np.sum()関数も、ndarray.sum()メソッドもともに全要素の合計を返します。

# 合計値を取得
np.sum(a)

222

# ndarray.sum()メソッドも同様
a.sum()

222

次元軸の指定

オプション引数 axis で合計値を求める次元軸を指定することができます。

以下は1次元軸(横軸)を指定しています。

# 1次元軸（横軸）を指定
np.sum(a, axis=-1)

array([100,  53,  69])

# メソッド
a.sum(axis=-1)

array([100,  53,  69])

以下は2次元軸(縦軸)を指定しています。

# 2次元軸(縦軸)を指定
np.sum(a, axis=0)

array([69, 44, 40, 48, 21])

# メソッド
a.sum(axis=0)

array([69, 44, 40, 48, 21])

要素の型(dtype)を指定

上のNoteで述べた通り、浮動小数点数(float型)の計算では、倍精度浮動小数点数(float64)が最も精度が高くなります。元の配列のデータ型が、低精度浮動小数点数(float32)以下の場合は、dtypeでfloat64を指定すると良いでしょう。

以下のコードをご確認ください。なお以降はメソッドのndarray.sum()のサンプルコードは割愛します。書き方は全く同じです。

import numpy as np
a = np.linspace(-10, 10, 100000, dtype=np.float32)

# float32型の計算は精度が低い
np.sum(a)

0.017578125

# float64型は精度が高い
np.sum(a, dtype=np.float64)

0.0

次元数を維持(keepdims)

np.sum()の引数に多次元配列を渡して、axis を指定した場合、合計値の配列の次元数は-1になります。この時、オプション引数で keepdims=True を指定した場合、元の配列の次元数を維持することができます。これを使いこなすことによって、配列のブロードキャストが楽になります。

以下の一連のコードで確認しましょう。

import numpy as np
rng = np.random.default_rng()
a = rng.integers(0, 11, (2, 5))
a

array([[ 6,  5,  3,  0,  3],
       [ 2,  1,  5,  8, 10]])

# 次元数を維持
np.sum(a, axis=-1, keepdims=True)

array([[17],
       [26]])

np.sum(a, axis=0, keepdims=True)

array([[ 8,  6,  8,  8, 13]])

足し算の開始値(initial)を指定

オプション引数 initial では足し算の開始値を指定することができます。以下の一連のコードをご覧ください。

import numpy as np
rng = np.random.default_rng()
a = rng.integers(0, 11, (5, ))
a

array([9, 5, 9, 3, 9])

# 足し算の開始値を指定
np.sum(a, initial=100)

135

特定の行や列のみの合計を求める(where)

オプション引数whereにブール値の配列や、配列のようなオブジェクト（リストやタプル）を渡すと、合計の対象となる行や列、要素を指定することができます。

これについては、ブロードキャストのルールを理解しておくとわかりやすいので、『覚えておくべきNumPy配列のブロードキャストのルール』を確認しておきましょう。

それでは以下の配列を例に見てみましょう。

import numpy as np
rng = np.random.default_rng()
a = rng.integers(0, 11, (3, 5))
a

array([[ 2,  2,  0,  6,  8],
       [ 3, 10,  5,  6,  0],
       [ 5,  5,  7,  8, 10]])

この配列の全要素の合計値は以下の通りです。

# 全要素の合計
np.sum(a)

77

以下のコードでは、オプション引数whereを使って、1行目と3行目の要素の合計を産出しています。

# 1行目と3行目の要素のみ足し算
np.sum(a, where=[[True], [False], [True]])

53

以下のコードでは、3列目の要素の合計値のみを算出しています。

# 3列目の要素のみ足し算
np.sum(a, where=[0, 0, 1, 0, 0 ])

12

3. まとめ

以上がnumpy.sumの使い方です。以下の関数も併せて確認しておくと良いでしょう。

• cumsum: 配列の要素の累積合計を取得
• mean: 配列の要素の算術平均を取得
• average: 配列の要素の加重平均を取得