NumPyの配列の累積合計を取得するcumsum関数の使い方

np.cumsumは、指定の軸に沿って配列の累積合計を戻す関数です。これと同じものでndarray.cumsumメソッドもあります。このページでは、これらについて解説していきます。

なお累積合計（累積和）というと聴き慣れない人には馴染みが浅いかもしれませんが、様々な状況で使える便利な和です。ここではサンプルコードを見ていくことで、累積和が何かということもわかります。

それでは実際のコードで、このnp.cumsumについて確認していきましょう。

1. 書式

まずは基本的な書き方を確認しましょう。ご確認頂くとおり複数のオプション引数がありますが、基本的にはaxisだけ抑えておけば十分です。

np.cumsum(a, axis=None, dtype=None, out=None)

ndarray.cumsum(axis=None, dtype=None, out=None)

Notes

np.cumsum()は空の配列を渡すと、そのまま空の配列が返ってきます。

import numpy as np
arr = np.array([])
print(np.cumsum(arr))

[]

2. サンプルコード

それでは、実際のコードを見ながら使い方を確認していきましょう。

1次元配列の場合

np.cumsum()は配列の累積合計を求める関数です。1次元配列を渡すと、累積合計を求めた新しい配列を生成します。以下の配列a を例に見てみましょう。

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

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

この配列a をnp.cumsum()に渡すと次のようになります。

# 多次元配列の場合も全要素の累積合計を返す
np.cumsum(a)

array([ 6, 11, 21, 27, 37])

ndarray.cumsum()メソッドも同様です。

# メソッド
a.cumsum()

array([ 6, 11, 21, 27, 37])

多次元配列の場合

多次元配列の場合も、デフォルトでは全要素の累積合計を算出します。以下の一連のコードをご確認ください。

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

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

# デフォルトでは全要素の累積和を求める
np.cumsum(a)

array([ 8, 14, 24, 31, 41, 41, 48, 56, 59, 63, 69, 73, 73, 81, 81])

# メソッド
a.cumsum()

array([ 8, 14, 24, 31, 41, 41, 48, 56, 59, 63, 69, 73, 73, 81, 81])

次元軸の指定(axis)

多次元配列では、axisで累積合計を求める次元軸を指定することができます。

以下は1次元軸（横軸）を指定した場合です。

# 1次元軸（横軸)方向の累積和を求める
np.cumsum(a, axis=-1)

array([[ 8, 14, 24, 31, 41],
       [ 0,  7, 15, 18, 22],
       [ 6, 10, 10, 18, 18]])

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

array([[ 8, 14, 24, 31, 41],
       [ 0,  7, 15, 18, 22],
       [ 6, 10, 10, 18, 18]])

以下は2次元軸（縦軸）を指定した場合です。

# 2次元軸（縦軸)方向の累積和を求める
np.cumsum(a, axis=0)

array([[ 8,  6, 10,  7, 10],
       [ 8, 13, 18, 10, 14],
       [14, 17, 18, 18, 14]])

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

array([[ 8,  6, 10,  7, 10],
       [ 8, 13, 18, 10, 14],
       [14, 17, 18, 18, 14]])

3. まとめ

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

• sum: 配列の要素の合計値を取得
• diff: 配列の軸方向の第n階差数列を取得