colCumprods,xgCMatrix-method {sparseMatrixStats}R Documentation

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

Description

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

Usage

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

## S4 method for signature 'xgCMatrix'
rowCumprods(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::rowCumprods / matrixStats::colCumprods.

Value

Returns a numeric matrixwith the same dimensions as x.

See Also

Examples

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

[Package sparseMatrixStats version 1.5.3 Index]