1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/colCummaxs.R, R/colCummins.R, R/colCumprods.R,
% R/colCumsums.R, R/rowCummaxs.R, R/rowCummins.R, R/rowCumprods.R,
% R/rowCumsums.R
\name{colCummaxs,DelayedMatrix-method}
\alias{colCummaxs,DelayedMatrix-method}
\alias{colCummins,DelayedMatrix-method}
\alias{colCumprods,DelayedMatrix-method}
\alias{colCumsums,DelayedMatrix-method}
\alias{rowCummaxs,DelayedMatrix-method}
\alias{rowCummins,DelayedMatrix-method}
\alias{rowCumprods,DelayedMatrix-method}
\alias{rowCumsums,DelayedMatrix-method}
\title{Calculates the cumulative maxima for each row (column) of a matrix-like
object}
\usage{
\S4method{colCummaxs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{colCummins}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{colCumprods}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{colCumsums}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{rowCummaxs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{rowCummins}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{rowCumprods}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{rowCumsums}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
force_block_processing = FALSE,
...,
useNames = TRUE
)
}
\arguments{
\item{x}{A NxK \linkS4class{DelayedMatrix}.}
\item{rows, cols}{A \code{\link{vector}} indicating the subset of rows
(and/or columns) to operate over. If \code{\link{NULL}}, no subsetting is
done.}
\item{force_block_processing}{\code{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 \code{TRUE}
(typically not advised). The block-processing strategy loads one or more
(depending on \verb{\link[DelayedArray]\{getAutoBlockSize\}()}) columns (\code{colFoo()})
or rows (\code{rowFoo()}) into memory as an ordinary \link[base:array]{base::array}.}
\item{...}{Additional arguments passed to specific methods.}
\item{useNames}{If \code{\link{TRUE}} (default), names attributes of result are set. Else if \code{\link{FALSE}}, no naming support is done.}
}
\value{
Returns a \code{\link{numeric}} \code{\link{matrix}}with the same
dimensions as \code{x}.
}
\description{
Calculates the cumulative maxima for each row (column) of a matrix-like
object.
}
\details{
The S4 methods for \code{x} of type \code{\link{matrix}},
\code{\link{array}}, \code{\link{table}}, or \code{\link{numeric}} call
\code{matrixStats::\link[matrixStats]{rowCummaxs}} /
\code{matrixStats::\link[matrixStats]{colCummaxs}}.
}
\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)
}
\seealso{
\itemize{
\item \code{matrixStats::\link[matrixStats:rowCumsums]{rowCummaxs}()} and
\code{matrixStats::\link[matrixStats:rowCumsums]{colCummaxs}()} which are
used when the input is a \code{matrix} or \code{numeric} vector.
\item For single maximum estimates, see \code{\link[MatrixGenerics]{rowMaxs}()}.
\item \code{base::\link{cummax}()}.
}
}
\author{
Peter Hickey
}
|
