What is the numpy.cumsum() function in NumPy?

Overview

The numpy.cumsum() function in NumPy is used to compute the cumulative sum of elements in a given input array over a given axis.

Syntax

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

Parameter value

The numpy.cumsum() function takes the following parameter values:

  • a (required): The input array containing numbers is to be computed.
  • axis(optional): The axis along which the product is determined.
  • dtype (optional): The data type of the output array.
  • out (optional): The alternate array where the result is placed.

Return value

The numpy.cumsum() function returns an output array holding the result.

Example

import numpy as np
# creating an array
x = np.array([1, 2, 3])
# Implementing the numpy.cumsum() function
myarray = np.cumsum(x, axis=0)
print(x)
print(myarray)
Implementing the numpy.cumsum() function

Explanation

Here is a line-by-line explanation of the above code:

  • Line 1: We import the numpy module.
  • Line 4: We create an array, x, using the array() method.
  • Line 7: We implement the np.cumsum() function on the array. The result is assigned to a variable, myarray.
  • Line 9: We print the input array x.
  • Line 10: We print the variable myarray.

Free Resources