colCummaxs {DelayedMatrixStats} | R Documentation

## Cumulative sums, products, minima and maxima for each row (column) in a matrix

### Description

Cumulative sums, products, minima and maxima for each row (column) in a matrix.

### Usage

    colCummaxs(x, rows = NULL, cols = NULL, dim. = dim(x), ...)

    colCummins(x, rows = NULL, cols = NULL, dim. = dim(x), ...)

    colCumprods(x, rows = NULL, cols = NULL, dim. = dim(x), ...)

    colCumsums(x, rows = NULL, cols = NULL, dim. = dim(x), ...)

    rowCummaxs(x, rows = NULL, cols = NULL, dim. = dim(x), ...)

    rowCummins(x, rows = NULL, cols = NULL, dim. = dim(x), ...)

    rowCumprods(x, rows = NULL, cols = NULL, dim. = dim(x), ...)

    rowCumsums(x, rows = NULL, cols = NULL, dim. = dim(x), ...)

    ## S4 method for signature 'DelayedMatrix'
    colCummaxs(x, rows = NULL, cols = NULL,
      dim. = dim(x), force_block_processing = FALSE, ...)

    ## S4 method for signature 'DelayedMatrix'
    colCummins(x, rows = NULL, cols = NULL,
      dim. = dim(x), force_block_processing = FALSE, ...)

    ## S4 method for signature 'DelayedMatrix'
    colCumprods(x, rows = NULL, cols = NULL,
      dim. = dim(x), force_block_processing = FALSE, ...)

    ## S4 method for signature 'DelayedMatrix'
    colCumsums(x, rows = NULL, cols = NULL,
      dim. = dim(x), force_block_processing = FALSE, ...)

    ## S4 method for signature 'DelayedMatrix'
    rowCummaxs(x, rows = NULL, cols = NULL,
      dim. = dim(x), force_block_processing = FALSE, ...)

    ## S4 method for signature 'DelayedMatrix'
    rowCummins(x, rows = NULL, cols = NULL,
      dim. = dim(x), force_block_processing = FALSE, ...)

    ## S4 method for signature 'DelayedMatrix'
    rowCumprods(x, rows = NULL, cols = NULL,
      dim. = dim(x), force_block_processing = FALSE, ...)

    ## S4 method for signature 'DelayedMatrix'
    rowCumsums(x, rows = NULL, cols = NULL,
      dim. = dim(x), force_block_processing = FALSE, ...)

### Arguments

`x` | A NxK DelayedMatrix.
`rows` | A `vector` indicating subset of elements (or rows and/or columns) to operate over. If `NULL`, no subsetting is done.
`cols` | A `vector` indicating subset of elements (or rows and/or columns) to operate over. If `NULL`, no subsetting is done.
`dim.` | An `integer` `vector` of length two specifying the dimension of `x`, also when not a `matrix`.
`...` | Additional arguments passed to specific methods.
`force_block_processing` | `FALSE` (the default) means that a seed-aware, optimised method is used (if available). This can be overridden to use the general block-processing strategy by setting this to `TRUE` (typically not advised). The block-processing strategy loads one or more (depending on `getOption("DelayedArray.block.size")`) columns (`colFoo()`) or rows (`rowFoo()`) into memory as an ordinary base::array.

### Value

Returns a `numeric` NxK `matrix` of the same mode as `x`.

### See Also

See `cumsum`(), `cumprod`(), `cummin`(), and `cummax`().

### Examples

    # A DelayedMatrix with a 'matrix' seed
    dm_matrix <- DelayedArray(matrix(c(rep(1L, 5),
                                       as.integer((0:4) ^ 2),
                                       seq(-5L, -1L, 1L)),
                                     ncol = 3))
    # A DelayedMatrix with a 'Matrix' seed
    dm_Matrix <- DelayedArray(Matrix::Matrix(c(rep(1L, 5),
                                               as.integer((0:4) ^ 2),
                                               seq(-5L, -1L, 1L)),
                                             ncol = 3))

    colCummaxs(dm_matrix)

    colCummins(dm_matrix)

    colCumprods(dm_matrix)

    colCumsums(dm_matrix)

    # Only use rows 2-4
    rowCummaxs(dm_Matrix, rows = 2:4)

    # Only use rows 2-4
    rowCummins(dm_Matrix, rows = 2:4)

    # Only use rows 2-4
    rowCumprods(dm_Matrix, rows = 2:4)

    # Only use rows 2-4
    rowCumsums(dm_Matrix, rows = 2:4)

[Package DelayedMatrixStats version 1.0.3 Index]