SCM

SCM Repository

[matrix] Annotation of /pkg/man/dsyMatrix-class.Rd
ViewVC logotype

Annotation of /pkg/man/dsyMatrix-class.Rd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 925 - (view) (download) (as text)

1 : bates 480 \name{dsyMatrix-class}
2 : bates 10 \docType{class}
3 : bates 480 \alias{\%*\%,dgeMatrix,dsyMatrix-method}
4 : bates 636 \alias{\%*\%,dspMatrix,dgeMatrix-method}
5 : bates 652 \alias{\%*\%,dspMatrix,integer-method}
6 : bates 636 \alias{\%*\%,dspMatrix,matrix-method}
7 : bates 652 \alias{\%*\%,dspMatrix,numeric-method}
8 : bates 651 \alias{\%*\%,dsyMatrix,dgeMatrix-method}
9 : bates 636 \alias{coerce,dspMatrix,dgeMatrix-method}
10 :     \alias{coerce,dspMatrix,dsyMatrix-method}
11 : bates 651 \alias{coerce,dspMatrix,matrix-method}
12 :     \alias{coerce,dsyMatrix,dgeMatrix-method}
13 :     \alias{coerce,dsyMatrix,dspMatrix-method}
14 : bates 480 \alias{coerce,dsyMatrix,matrix-method}
15 : maechler 925 \alias{show,dsyMatrix-method}
16 : bates 651 \alias{dspMatrix-class}
17 :     \alias{dsyMatrix-class}
18 : bates 636 \alias{norm,dspMatrix,character-method}
19 : bates 651 \alias{norm,dspMatrix,missing-method}
20 : bates 480 \alias{norm,dsyMatrix,character-method}
21 :     \alias{norm,dsyMatrix,missing-method}
22 : bates 651 \alias{rcond,dspMatrix,character-method}
23 : bates 636 \alias{rcond,dspMatrix,missing-method}
24 : bates 651 \alias{rcond,dsyMatrix,character-method}
25 : bates 636 \alias{rcond,dsyMatrix,missing-method}
26 : bates 651 \alias{solve,dspMatrix,dgeMatrix-method}
27 : bates 652 \alias{solve,dspMatrix,integer-method}
28 : bates 651 \alias{solve,dspMatrix,matrix-method}
29 : bates 636 \alias{solve,dspMatrix,missing-method}
30 : bates 652 \alias{solve,dspMatrix,numeric-method}
31 : bates 636 \alias{solve,dsyMatrix,dgeMatrix-method}
32 :     \alias{solve,dsyMatrix,matrix-method}
33 : bates 651 \alias{solve,dsyMatrix,missing-method}
34 :     \alias{t,dspMatrix-method}
35 :     \alias{t,dsyMatrix-method}
36 : bates 636 \alias{unpack,dspMatrix-method}
37 : bates 487 \title{Symmetric, dense matrices}
38 : maechler 891 \description{
39 :     The \code{"dsyMatrix"} class is the class of symmetric, dense matrices
40 :     in non-packed storage and \code{"dspMatrix"} is the class of symmetric
41 :     dense matrices in packed storage. Only the upper triangle or the
42 :     lower triangle is stored.
43 :     }
44 : bates 10 \section{Objects from the Class}{
45 : maechler 891 Objects can be created by calls of the form \code{new("dsyMatrix", ...)}.
46 : bates 10 }
47 :     \section{Slots}{
48 :     \describe{
49 :     \item{\code{uplo}:}{Object of class \code{"character"}. Must be
50 :     either "U", for upper triangular, and "L", for lower triangular.}
51 :     \item{\code{x}:}{Object of class \code{"numeric"}. The numeric
52 :     values that constitute the matrix, stored in column-major order.}
53 : maechler 891 \item{\code{Dim},\code{Dimnames}:}{The dimension (a length-2
54 :     \code{"integer"}) and corresponding names (or \code{NULL}), see the
55 :     \code{\link{Matrix-class}}.}
56 : bates 10 \item{\code{rcond}:}{Object of class \code{"numeric"}. A named
57 :     numeric vector of reciprocal condition numbers in either the
58 :     1-norm \code{"O"} or the infinity norm \code{"I"}.}
59 : bates 476 \item{\code{factors}:}{Object of class \code{"list"}. A named
60 : bates 10 list of factorizations that have been computed for the matrix.}
61 :     }
62 :     }
63 :     \section{Extends}{
64 : bates 480 Class \code{"dgeMatrix"}, directly.
65 : maechler 891 Class \code{"symmetricMatrix"}, directly.
66 :     Class \code{"Matrix"} and others, by class \code{"dgeMatrix"}.
67 : bates 10 }
68 :     \section{Methods}{
69 :     \describe{
70 : bates 651 \item{coerce}{\code{signature(from = "dspMatrix", to = "dgeMatrix")}}
71 : bates 480 \item{coerce}{\code{signature(from = "dsyMatrix", to = "dgeMatrix")}}
72 : bates 651 \item{coerce}{\code{signature(from = "dspMatrix", to = "matrix")}}
73 : bates 480 \item{coerce}{\code{signature(from = "dsyMatrix", to = "matrix")}}
74 : bates 651 \item{coerce}{\code{signature(from = "dsyMatrix", to = "dspMatrix")}}
75 : maechler 657 \item{coerce}{\code{signature(from = "dspMatrix", to = "dsyMatrix")}}
76 : bates 651 \item{norm}{\code{signature(x = "dspMatrix", type = "character")}}
77 : bates 480 \item{norm}{\code{signature(x = "dsyMatrix", type = "character")}}
78 : bates 651 \item{norm}{\code{signature(x = "dspMatrix", type = "missing")}}
79 :     \item{norm}{\code{signature(x = "dsyMatrix", type = "missing")}}
80 :     \item{solve}{\code{signature(a = "dspMatrix", b = "missing")}}
81 :     \item{solve}{\code{signature(a = "dsyMatrix", b = "missing")}}
82 :     \item{solve}{\code{signature(a = "dspMatrix", b = "dgeMatrix")}}
83 :     \item{solve}{\code{signature(a = "dsyMatrix", b = "dgeMatrix")}}
84 :     \item{solve}{\code{signature(a = "dspMatrix", b = "matrix")}}
85 :     \item{solve}{\code{signature(a = "dsyMatrix", b = "matrix")}}
86 : bates 10 }
87 :     }
88 :     %\references{}
89 :     %\author{}
90 :     \seealso{
91 : bates 651 \code{\link{dgeMatrix-class}}, \code{\link{Matrix-class}},
92 :     \code{\link[base]{solve}}, \code{\link{norm}}, \code{\link{rcond}},
93 :     \code{\link[base]{t}}
94 : bates 10 }
95 : maechler 634 \examples{
96 :     ## Only upper triangular part matters (when uplo == "U" as per default)
97 :     (sy2 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, NA,32,77)))
98 : maechler 768 (c2 <- chol(sy2))
99 :     all.equal(c2, c2. <- chol(as(sy2, "dpoMatrix")))# equal, but not same class
100 : maechler 634 str(c2)
101 :    
102 :     ## An example where chol() can't work
103 :     (sy3 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, -1, 2, -7)))
104 : maechler 657
105 : bates 757 validObject(as(sy3, "dpoMatrix"), test=TRUE) # >> is not pos.def.
106 : maechler 768 % .... Lapack routine dpotrf returned error code 2 -- FIXME: better message
107 : maechler 634 try(chol(sy3)) ## Error: not pos.def
108 :     }
109 : bates 10 \keyword{classes}

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge