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{Matrix-class}
\docType{class}
\alias{Matrix-class}
\alias{-,Matrix,missing-method}
\alias{+,Matrix,missing-method}
\alias{\%*\%,Matrix,numeric-method}
\alias{\%*\%,numeric,Matrix-method}
\alias{\%*\%,Matrix,Matrix-method}
% "[" are in ./Xtrct-methods.Rd <<<<<<<<
\alias{cbind2,Matrix,Matrix-method}
\alias{cbind2,Matrix,NULL-method}
\alias{cbind2,Matrix,missing-method}
\alias{cbind2,NULL,Matrix-method}
\alias{rbind2,Matrix,Matrix-method}
\alias{rbind2,Matrix,NULL-method}
\alias{rbind2,Matrix,missing-method}
\alias{rbind2,NULL,Matrix-method}
\alias{crossprod,Matrix,numeric-method}
\alias{crossprod,Matrix,ANY-method}
\alias{crossprod,Matrix,Matrix-method}
\alias{crossprod,numeric,Matrix-method}
\alias{tcrossprod,ANY,Matrix-method}
\alias{tcrossprod,Matrix,numeric-method}
\alias{tcrossprod,Matrix,ANY-method}
\alias{tcrossprod,Matrix,Matrix-method}
\alias{tcrossprod,numeric,Matrix-method}
%
\alias{chol,Matrix,ANY-method}
\alias{determinant,Matrix,ANY-method}
\alias{diag,Matrix-method}
\alias{head,Matrix-method}
\alias{tail,Matrix-method}
\alias{solve,Matrix,matrix-method}
\alias{solve,Matrix,missing-method}
\alias{solve,Matrix,numeric-method}
\alias{dim,Matrix-method}
\alias{dimnames,Matrix-method}
\alias{dimnames<-,Matrix,list-method}
\alias{show,Matrix-method}
\alias{as.array,Matrix-method}
\alias{as.matrix,Matrix-method}
\alias{as.vector,Matrix,missing-method}
\alias{as.numeric,Matrix-method}
\alias{as.logical,Matrix-method}
\alias{t,Matrix-method}
\alias{unname,Matrix-method}
\alias{coerce,Matrix,matrix-method}%
\alias{coerce,matrix,Matrix-method}
\alias{coerce,Matrix,denseMatrix-method}
\alias{coerce,Matrix,sparseMatrix-method}
\alias{Ops,Matrix,Matrix-method}
\alias{Ops,Matrix,ANY-method}
\alias{Ops,ANY,Matrix-method}
\alias{Ops,Matrix,matrix-method}
\alias{Ops,matrix,Matrix-method}
\alias{crossprod,ANY,Matrix-method}
\alias{kronecker,ANY,Matrix-method}
\alias{kronecker,Matrix,ANY-method}
%
\title{Virtual Class "Matrix" Class of Matrices}
\description{
The \code{Matrix} class is a class contained by all actual
classes in the \pkg{Matrix} package. It is a \dQuote{virtual} class.
}
\section{Slots}{
Common to \emph{all} matrix objects 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}{
\describe{
\item{dim}{\code{signature(x = "Matrix")}: extract matrix dimensions
\code{\link{dim}}.}
\item{dimnames}{\code{signature(x = "Matrix")}: extract
\code{\link{dimnames}}.}
\item{dimnames<-}{\code{signature(x = "Matrix", value = "list")}: set
the \code{dimnames} to a \code{\link{list}} of length 2, see
\code{\link{dimnames<-}}.}
\item{show}{\code{signature(object = "Matrix")}: \code{\link{show}}
method for \code{\link{print}}ing.}
\item{head}{\code{signature(object = "Matrix")}: return only the
\emph{\dQuote{head}}, i.e., the first few rows.}
\item{tail}{\code{signature(object = "Matrix")}: return only the
\emph{\dQuote{tail}}, i.e., the last few rows of the respective matrix.}
\cr %------------------------------------
\item{as.matrix, as.array}{\code{signature(x = "Matrix")}: the same as
\code{as(x, "matrix")}; see also the note below.}
\item{as.vector}{\code{signature(x = "Matrix", mode = "missing")}:
\code{as.vector(m)} should be identical to \code{as.vector(as(m,
"matrix"))}, implemented more efficiently for some subclasses.}
}
There are many more methods that (conceptually should) work for all
\code{"Matrix"} objects, e.g., \code{\link{colSums}},
\code{\link{rowMeans}}. Even \pkg{base} functions may work
automagically (if they first call \code{\link{as.matrix}()} on their
principal argument), e.g., \code{\link{apply}}, \code{\link{eigen}},
\code{\link{svd}} or \code{\link{kappa}} all do work via coercion to a
\dQuote{traditional} (dense) \code{\link{matrix}}.
%% --> ../tests/base-matrix-fun.R
}
\note{
Loading the \code{Matrix} namespace \dQuote{overloads}
\code{\link{as.matrix}} and \code{\link{as.array}} in the \pkg{base}
namespace by the equivalent of \code{function(x) as(x, "matrix")}.
Consequently, \code{as.matrix(m)} or \code{as.array(m)} will properly
work when \code{m} inherits from the \code{"Matrix"} class ---
\emph{also} for functions in package \pkg{base} and other packages.
E.g., \code{\link{apply}} or \code{\link{outer}} can therefore be applied
to \code{"Matrix"} matrices.
}
%\references{}
\author{Douglas Bates \email{bates@stat.wisc.edu} and Martin Maechler}
\seealso{
the classes \code{\linkS4class{dgeMatrix}},
\code{\linkS4class{dgCMatrix}}, and function
\code{\link{Matrix}} for construction (and examples).
}
\examples{
slotNames("Matrix")
cl <- getClass("Matrix")
names(cl@subclasses) # more than 40 ..
showClass("Matrix")#> output with slots and all subclasses
}
\keyword{classes}
\keyword{algebra}
|
