colCumsums,xgCMatrix-method {sparseMatrixStats} | R Documentation

## Calculates the cumulative sum for each row (column) of a matrix-like object

### Description

Calculates the cumulative sum for each row (column) of a matrix-like object.

### Usage

    ## S4 method for signature 'xgCMatrix'
    colCumsums(x, rows = NULL, cols = NULL, useNames = NA)

    ## S4 method for signature 'xgCMatrix'
    rowCumsums(x, rows = NULL, cols = NULL, useNames = NA)

### Arguments

`x` | An NxK matrix-like object.
`rows` | A `vector` indicating the subset of rows (and/or columns) to operate over. If `NULL`, no subsetting is done.
`cols` | A `vector` indicating the subset of rows (and/or columns) to operate over. If `NULL`, no subsetting is done.
`useNames` | If `NA`, the default behavior of the function about naming support is remained. If `FALSE`, no naming support is done. Else if `TRUE`, names attributes of result are set.

### Details

The S4 methods for `x` of type `matrix`, `array`, or `numeric` call `matrixStats::rowCumsums` / `matrixStats::colCumsums`.

### Value

Returns a `numeric` `matrix`with the same dimensions as `x`.

### See Also

- `matrixStats::rowCumsums()` and `matrixStats::colCumsums()` which are used when the input is a `matrix` or `numeric` vector.

- `base::cumsum()`.

### Examples

    mat <- matrix(rnorm(15), nrow = 5, ncol = 3)
      mat[2, 1] <- NA
      mat[3, 3] <- Inf
      mat[4, 1] <- 0

      print(mat)

      rowCumsums(mat)
      colCumsums(mat)

[Package sparseMatrixStats version 1.4.2 Index]