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
|
\name{dsyMatrix-class}
\title{Symmetric Dense (Packed or Unpacked) Numeric Matrices}
%
\docType{class}
\keyword{array}
\keyword{classes}
%
\alias{dsyMatrix-class}
\alias{dspMatrix-class}
%
\alias{coerce,dsyMatrix,corMatrix-method}
\alias{coerce,dsyMatrix,dpoMatrix-method}
\alias{determinant,dsyMatrix,logical-method}
%
\alias{coerce,dspMatrix,copMatrix-method}
\alias{coerce,dspMatrix,dppMatrix-method}
\alias{determinant,dspMatrix,logical-method}
%
\description{
\itemize{
\item The \code{"dsyMatrix"} class is the class of symmetric, dense matrices
in \emph{non-packed} storage and
\item \code{"dspMatrix"} is the class of symmetric dense matrices in
\emph{packed} storage, see \code{\link{pack}()}. Only the upper
triangle or the lower triangle is stored.
}
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("dsyMatrix",
...)} or \code{new("dspMatrix", ...)}, respectively.
}
\section{Slots}{
\describe{
\item{\code{uplo}:}{Object of class \code{"character"}. Must be
either "U", for upper triangular, and "L", for lower triangular.}
\item{\code{x}:}{Object of class \code{"numeric"}. The numeric
values that constitute the matrix, stored in column-major order.}
\item{\code{Dim},\code{Dimnames}:}{The dimension (a length-2
\code{"integer"}) and corresponding names (or \code{NULL}), see the
\code{\linkS4class{Matrix}}.}
\item{\code{factors}:}{Object of class \code{"list"}. A named
list of factorizations that have been computed for the matrix.}
}
}
\section{Extends}{
\code{"dsyMatrix"} extends class \code{"dgeMatrix"}, directly, whereas\cr
\code{"dspMatrix"} extends class \code{"ddenseMatrix"}, directly.
Both extend class \code{"symmetricMatrix"}, directly,
and class \code{"Matrix"} and others, \emph{in}directly, use
\code{\link{showClass}("dsyMatrix")}, e.g., for details.
}
\section{Methods}{
\describe{
\item{norm}{\code{signature(x = "dspMatrix", type = "character")}, or
\code{x = "dsyMatrix"} or \code{type = "missing"}: Computes the
matrix norm of the desired type, see, \code{\link{norm}}.}
\item{rcond}{\code{signature(x = "dspMatrix", type = "character")}, or
\code{x = "dsyMatrix"} or \code{type = "missing"}: Computes the
reciprocal condition number, \code{\link{rcond}()}.}
\item{solve}{\code{signature(a = "dspMatrix", b = "....")}, and}
\item{solve}{\code{signature(a = "dsyMatrix", b = "....")}: \code{x
<- solve(a,b)} solves \eqn{A x = b} for \eqn{x}; see
\code{\link{solve-methods}}.}
\item{t}{\code{signature(x = "dsyMatrix")}: Transpose; swaps from
upper triangular to lower triangular storage, i.e., the uplo slot
from \code{"U"} to \code{"L"} or vice versa, the same as for all
symmetric matrices.}
}
}
%\references{}
\seealso{
The \emph{positive (Semi-)definite} dense (packed or non-packed
numeric matrix classes \code{\linkS4class{dpoMatrix}},
\code{\linkS4class{dppMatrix}} and \code{\linkS4class{corMatrix}},
Classes \code{\linkS4class{dgeMatrix}} and \code{\linkS4class{Matrix}};
\code{\link[base]{solve}}, \code{\link{norm}}, \code{\link{rcond}},
\code{\link[base]{t}}
}
\examples{
\dontshow{ % for R_DEFAULT_PACKAGES=NULL
library(utils, pos = "package:base", verbose = FALSE)
}
## Only upper triangular part matters (when uplo == "U" as per default)
(sy2 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, NA,32,77)))
str(t(sy2)) # uplo = "L", and the lower tri. (i.e. NA is replaced).
chol(sy2) #-> "Cholesky" matrix
(sp2 <- pack(sy2)) # a "dspMatrix"
## Coercing to dpoMatrix gives invalid object:
sy3 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, -1, 2, -7))
try(as(sy3, "dpoMatrix")) # -> error: not positive definite
\dontshow{
tr <- try(as(sy3, "dpoMatrix"), silent=TRUE)
stopifnot(1 == grep("not a positive definite matrix",
as.character(tr)),
is(sp2, "dspMatrix"))
}
## 4x4 example
m <- matrix(0,4,4); m[upper.tri(m)] <- 1:6
(sym <- m+t(m)+diag(11:14, 4))
(S1 <- pack(sym))
(S2 <- t(S1))
stopifnot(all(S1 == S2)) # equal "seen as matrix", but differ internally :
str(S1)
S2@x
}
|
