Cumulative sum and product

Compute cumulative sums or products along an axis.

Usage

mlx_cumsum(x, axis = NULL, reverse = FALSE, inclusive = TRUE)

mlx_cumprod(x, axis = NULL, reverse = FALSE, inclusive = TRUE)

Arguments

x

An mlx array.

axis

Optional axis along which to compute cumulative operation. If NULL (default), the array is flattened first.

reverse

If TRUE, compute in reverse order.

inclusive

If TRUE (default), include the current element in the cumulative operation. If FALSE, the cumulative operation is exclusive (starts from identity element).

Value

An mlx array with cumulative sums or products.

See also

cumsum(), cumprod(), mlx.core.cumsum, mlx.core.cumprod

Examples

x <- as_mlx(1:5)
mlx_cumsum(x)  # [1, 3, 6, 10, 15]
#> mlx array [5]
#>   dtype: float32
#>   device: gpu
#>   values:
#> [1]  1  3  6 10 15

mat <- as_mlx(matrix(1:12, 3, 4))
mlx_cumsum(mat, axis = 1)  # cumsum down rows
#> mlx array [3 x 4]
#>   dtype: float32
#>   device: gpu
#>   values:
#>      [,1] [,2] [,3] [,4]
#> [1,]    1    4    7   10
#> [2,]    3    9   15   21
#> [3,]    6   15   24   33