rowCumprods {MatrixGenerics}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

rowCumprods(x, rows = NULL, cols = NULL, ..., useNames = NA)

## S4 method for signature 'matrix_OR_array_OR_table_OR_numeric'
rowCumprods(x, rows = NULL, cols = NULL, dim. = dim(x), ..., useNames = NA)

## S4 method for signature 'ANY'
rowCumprods(x, rows = NULL, cols = NULL, ..., useNames = NA)

colCumprods(x, rows = NULL, cols = NULL, ..., useNames = NA)

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

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

Arguments

x

An NxK matrix-like object.

rows, cols

A vector indicating the subset of rows (and/or columns) to operate over. If NULL, no subsetting is done.

...

Additional arguments passed to specific methods.

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.

dim.

An integer vector of length two specifying the dimension of x, essential when x is a numeric vector. Note, that this is not a generic argument and not all methods need provide it.

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 MatrixGenerics version 1.8.1 Index]