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
|
\name{unpackedMatrix-class}
\title{Virtual Class \code{"unpackedMatrix"} of Unpacked Dense Matrices}
%
\docType{class}
\keyword{array}
\keyword{classes}
%
\alias{unpackedMatrix-class}
%
\alias{coerce,matrix,unpackedMatrix-method}
\alias{coerce,vector,unpackedMatrix-method}
\alias{cov2cor,unpackedMatrix-method}
%
\description{
Class \code{"unpackedMatrix"} is the \emph{virtual} class of dense
matrices in "unpacked" format, storing all \code{m*n} elements of
an \code{m}-by-\code{n} matrix. It is used to define common methods
for efficient subsetting, transposing, etc. of its \emph{proper}
subclasses: currently \code{"[dln]geMatrix"} (unpacked general),
\code{"[dln]syMatrix"} (unpacked symmetric), \code{"[dln]trMatrix"}
(unpacked triangular), and subclasses of these, such as
\code{"\linkS4class{dpoMatrix}"}.
}
\section{Slots}{
\describe{
\item{\code{Dim}, \code{Dimnames}:}{as all \code{\linkS4class{Matrix}} objects.}
}
}
\section{Extends}{
Class \code{"\linkS4class{denseMatrix}"}, directly.
Class \code{"\linkS4class{Matrix}"}, by class \code{"denseMatrix"},
distance 2.
}
\section{Methods}{
\describe{
\item{pack}{\code{signature(x = "unpackedMatrix")}: ... }
\item{unpack}{\code{signature(x = "unpackedMatrix")}: ... }
\item{isSymmetric}{\code{signature(object = "unpackedMatrix")}: ... }
\item{isTriangular}{\code{signature(object = "unpackedMatrix")}: ... }
\item{isDiagonal}{\code{signature(object = "unpackedMatrix")}: ... }
\item{t}{\code{signature(x = "unpackedMatrix")}: ... }
\item{diag}{\code{signature(x = "unpackedMatrix")}: ... }
\item{diag<-}{\code{signature(x = "unpackedMatrix")}: ... }
}
}
%% \references{
%% }
\author{Mikael Jagan}
%% \note{
%% }
\seealso{
\code{\link{pack}} and \code{\link{unpack}}; its virtual "complement"
\code{"\linkS4class{packedMatrix}"}; its proper subclasses
\code{"\linkS4class{dsyMatrix}"}, \code{"\linkS4class{ltrMatrix}"}, etc.
}
\examples{
showClass("unpackedMatrix")
showMethods(classes = "unpackedMatrix")
}
|
