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
|
\name{dMatrix-class}
\docType{class}
\alias{dMatrix-class}
\alias{lMatrix-class}
%
\alias{show,dMatrix-method}
%\alias{coerce,dMatrix,matrix-method}
\alias{coerce,dMatrix,lMatrix-method}
\alias{coerce,lMatrix,dMatrix-method}
\alias{coerce,lMatrix,dgCMatrix-method}
\alias{coerce,matrix,lMatrix-method}
%\alias{coerce,dMatrix,dgeMatrix-method}
\alias{[,dMatrix,lMatrix,missing,ANY-method}
\alias{[,dMatrix,logical,missing,ANY-method}
% Group methods
\alias{Ops,dMatrix,dMatrix-method}
\alias{Ops,dMatrix,lMatrix-method}
\alias{Ops,dMatrix,nMatrix-method}
\alias{Ops,lMatrix,dMatrix-method}
\alias{Ops,lMatrix,lMatrix-method}
\alias{Ops,lMatrix,numeric-method}
\alias{Ops,nMatrix,dMatrix-method}
\alias{Ops,numeric,lMatrix-method}
\alias{Arith,dMatrix,dMatrix-method}
\alias{Arith,lMatrix,logical-method}
\alias{Arith,lMatrix,numeric-method}
\alias{Arith,logical,lMatrix-method}
\alias{Arith,numeric,lMatrix-method}
\alias{Compare,dMatrix,logical-method}
\alias{Compare,dMatrix,numeric-method}
\alias{Compare,lMatrix,logical-method}
\alias{Compare,lMatrix,numeric-method}
\alias{Compare,logical,dMatrix-method}
\alias{Compare,logical,lMatrix-method}
\alias{Compare,numeric,dMatrix-method}
\alias{Compare,numeric,lMatrix-method}
\alias{Logic,dMatrix,logical-method}
\alias{Logic,dMatrix,numeric-method}
\alias{Logic,lMatrix,logical-method}
\alias{Logic,lMatrix,numeric-method}
\alias{Logic,logical,dMatrix-method}
\alias{Logic,logical,lMatrix-method}
\alias{Logic,numeric,dMatrix-method}
\alias{Logic,numeric,lMatrix-method}
\alias{Summary,lMatrix-method}
%% R <= 2.5.x :
% \alias{Math2,dMatrix,ANY-method}% Math2 = round + signif,.., but
% \alias{Math2,dMatrix,missing-method}
% % for silly reasons, need these 2+3 as well:
% \alias{round,dMatrix,numeric-method}
% \alias{signif,dMatrix,numeric-method}
%% R-2.6.0 - maybe
\alias{Math2,dMatrix-method}
\alias{log,dMatrix-method}
\alias{gamma,dMatrix-method}
\alias{lgamma,dMatrix-method}
%
\alias{zapsmall,dMatrix-method}
\alias{\%*\%,nMatrix,lMatrix-method}
\alias{\%*\%,lMatrix,nMatrix-method}
\alias{\%*\%,lMatrix,lMatrix-method}
\alias{\%*\%,nMatrix,nMatrix-method}
\alias{\%*\%,dMatrix,lMatrix-method}
\alias{\%*\%,dMatrix,nMatrix-method}
\alias{\%*\%,lMatrix,dMatrix-method}
\alias{\%*\%,nMatrix,dMatrix-method}
%\alias{which,lMatrix-method}
%
% operations with one argument from the "integer" class
\alias{crossprod,dMatrix,integer-method}
\alias{crossprod,integer,dMatrix-method}
\alias{solve,dMatrix,integer-method}
\alias{\%*\%,dMatrix,integer-method}
\alias{\%*\%,integer,dMatrix-method}
\title{(Virtual) Class "dMatrix" of "double" Matrices}
\description{
The \code{dMatrix} class is a virtual class contained by all actual
classes of numeric matrices in the \pkg{Matrix} package. Similarly,
all the actual classes of logical matrices inherit from the
\code{lMatrix} class.
}
%\section{Objects from the Class}{A virtual Class: No objects may be
% created from it.
%}
\section{Slots}{
Common to \emph{all} matrix object in the package:
\describe{
\item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
of the matrix - must be an integer vector with exactly two
non-negative values.}
\item{\code{Dimnames}:}{list of length two; each component
containing NULL or a \code{\link{character}} vector length
equal the corresponding \code{Dim} element.}
}
}
\section{Methods}{
There are (relatively simple) group methods (see, e.g., \code{\link{Arith}})
\describe{
\item{Arith}{\code{signature(e1 = "dMatrix", e2 = "dMatrix")}: ... }
\item{Arith}{\code{signature(e1 = "dMatrix", e2 = "numeric")}: ... }
\item{Arith}{\code{signature(e1 = "numeric", e2 = "dMatrix")}: ... }
\item{Math}{\code{signature(x = "dMatrix")}: ... }
\item{Math2}{\code{signature(x = "dMatrix", digits = "numeric")}:
this group contains \code{\link{round}()} and \code{\link{signif}()}.}
\item{Compare}{\code{signature(e1 = "numeric", e2 = "dMatrix")}: ... }
\item{Compare}{\code{signature(e1 = "dMatrix", e2 = "numeric")}: ... }
\item{Compare}{\code{signature(e1 = "dMatrix", e2 = "dMatrix")}: ... }
\item{Summary}{\code{signature(x = "dMatrix")}: The \code{"Summary"}
group contains the seven functions
\code{\link{max}()}, \code{\link{min}()}, \code{\link{range}()},
\code{\link{prod}()}, \code{\link{sum}()},
\code{\link{any}()}, and \code{\link{all}()}.}
}
The following methods are also defined for all double matrices:
\describe{
\item{coerce}{\code{signature(from = "dMatrix", to = "matrix")}: ... }
%
\item{expm}{\code{signature(x = "dMatrix")}: computes the
\emph{\dQuote{Matrix Exponential}}, see \code{\link{expm}}.}
\item{zapsmall}{\code{signature(x = "dMatrix")}: ... }
}
The following methods are defined for all logical matrices:
\describe{
\item{which}{\code{signature(x = "lsparseMatrix")} and many other
subclasses of \code{"lMatrix"}: as the \pkg{base} function
\code{\link{which}(x, arr.ind)} returns the indices of the
\code{\link{TRUE}} entries in \code{x}; if \code{arr.ind} is true,
as a 2-column matrix of row and column indices.}
}
}
%\references{}
% Martin + Doug\author{Douglas Bates \email{bates@stat.wisc.edu}}
\seealso{
The nonzero-pattern matrix class \code{\linkS4class{nMatrix}}, which
can be used to store non-\code{\link{NA}} \code{\link{logical}}
matrices even more compactly.
The numeric matrix classes \code{\linkS4class{dgeMatrix}},
\code{\linkS4class{dgCMatrix}}, and \code{\linkS4class{Matrix}}.
}
\examples{
showClass("dMatrix")
set.seed(101)
round(Matrix(rnorm(28), 4,7), 2)
(M <- zapsmall(Matrix(rlnorm(56, sd=10), 4,14)))
table(as.logical(M == 0))
}
\keyword{classes}
\keyword{algebra}
|
