colCumprods-xgCMatrix-method: Calculates the cumulative product for each row (column) of a...

colCumprods,xgCMatrix-methodR 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 = TRUE)

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

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.

useNames

If TRUE (default), names attributes of result are set. Else if FALSE, no naming support is done.

Details

The S4 methods for x of type matrix, array, table, or numeric call matrixStats::rowCumprods / matrixStats::colCumprods.

Value

Returns a numeric matrixwith the same dimensions as x.

See Also

  • matrixStats::rowCumprods() and matrixStats::colCumprods() which are used when the input is a matrix or numeric vector.

  • base::cumprod().

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)

const-ae/sparseMatrixStats documentation built on June 15, 2024, 9:36 a.m.