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
|
\name{DelayedSubset-class}
\alias{class:DelayedSubset}
\alias{DelayedSubset-class}
\alias{DelayedSubset}
\alias{is_noop,DelayedSubset-method}
\alias{summary.DelayedSubset}
\alias{summary,DelayedSubset-method}
\alias{dim,DelayedSubset-method}
\alias{dimnames,DelayedSubset-method}
\alias{extract_array,DelayedSubset-method}
\alias{is_sparse,DelayedSubset-method}
\alias{extract_sparse_array,DelayedSubset-method}
\title{DelayedSubset objects}
\description{
NOTE: This man page is about \link{DelayedArray} internals and is provided
for developers and advanced users only.
The DelayedSubset class provides a formal representation of a \emph{delayed
multi-dimensional single bracket subsetting operation}. It is a concrete
subclass of the \link{DelayedUnaryOp} virtual class, which itself is a
subclass of the \link{DelayedOp} virtual class:
\preformatted{
DelayedOp
^
|
DelayedUnaryOp
^
|
DelayedSubset
}
DelayedSubset objects are used inside a \link{DelayedArray} object to
represent the \emph{delayed multi-dimensional single bracket subsetting
operations} carried by the object. They're never exposed to the end user
and are not intended to be manipulated directly.
}
\usage{
\S4method{is_noop}{DelayedSubset}(x)
\S4method{summary}{DelayedSubset}(object, ...)
## ~ ~ ~ Seed contract ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
\S4method{dim}{DelayedSubset}(x)
\S4method{dimnames}{DelayedSubset}(x)
\S4method{extract_array}{DelayedSubset}(x, index)
## ~ ~ ~ Propagation of sparsity ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
\S4method{is_sparse}{DelayedSubset}(x)
\S4method{extract_sparse_array}{DelayedSubset}(x, index)
}
\arguments{
\item{x, object}{
A DelayedSubset object.
}
\item{index}{
See \code{?\link{extract_array}} for a description of the \code{index}
argument.
}
\item{...}{
Not used.
}
}
\seealso{
\itemize{
\item \link{DelayedOp} objects.
\item \code{\link{showtree}} to visualize the nodes and access the
leaves in the tree of delayed operations carried by a
\link{DelayedArray} object.
\item \code{\link{extract_array}} and \code{\link{extract_sparse_array}}.
}
}
\examples{
## DelayedSubset extends DelayedUnaryOp which extends DelayedOp:
extends("DelayedSubset")
## ---------------------------------------------------------------------
## BASIC EXAMPLE
## ---------------------------------------------------------------------
a0 <- array(1:60, dim=5:3)
A0 <- DelayedArray(a0)
showtree(A0)
A <- A0[2:1, -4, 3, drop=FALSE]
showtree(A)
class(A@seed) # a DelayedSubset object
## ---------------------------------------------------------------------
## PROPAGATION OF SPARSITY
## ---------------------------------------------------------------------
sm0 <- sparseMatrix(i=c(1, 4), j=c(1, 3), x=c(11, 43), dims=4:3)
SM0 <- DelayedArray(sm0)
showtree(SM0)
is_sparse(SM0) # TRUE
SM1 <- SM0[-1, 3:2, drop=FALSE]
showtree(SM1)
class(SM1@seed) # a DelayedSubset object
is_sparse(SM1@seed) # TRUE
## Duplicated indices break structural sparsity.
M2 <- SM0[-1, c(3:2, 2), drop=FALSE]
showtree(M2)
class(M2@seed) # a DelayedSubset object
is_sparse(M2@seed) # FALSE
## ---------------------------------------------------------------------
## SANITY CHECKS
## ---------------------------------------------------------------------
stopifnot(class(A@seed) == "DelayedSubset")
stopifnot(class(SM1@seed) == "DelayedSubset")
stopifnot(is_sparse(SM1@seed))
stopifnot(class(M2@seed) == "DelayedSubset")
stopifnot(!is_sparse(M2@seed))
}
\keyword{methods}
|
