SCM

SCM Repository

[matrix] Annotation of /pkg/R/diagMatrix.R
ViewVC logotype

Annotation of /pkg/R/diagMatrix.R

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1447 - (view) (download)

1 : maechler 1109 ## Purpose: Constructor of diagonal matrices -- ~= diag() ,
2 :     ## but *not* diag() extractor!
3 :     Diagonal <- function(n, x = NULL)
4 :     {
5 :     ## Allow Diagonal(4) and Diagonal(x=1:5)
6 :     if(missing(n))
7 :     n <- length(x)
8 :     else {
9 :     stopifnot(length(n) == 1, n == as.integer(n), n >= 0)
10 :     n <- as.integer(n)
11 :     }
12 :    
13 :     if(missing(x)) # unit diagonal matrix
14 :     new("ddiMatrix", Dim = c(n,n), diag = "U")
15 :     else {
16 :     stopifnot(length(x) == n)
17 :     if(is.logical(x))
18 :     cl <- "ldiMatrix"
19 :     else {
20 :     cl <- "ddiMatrix"
21 :     x <- as.numeric(x)
22 :     }
23 :     new(cl, Dim = c(n,n), diag = "N", x = x)
24 :     }
25 :     }
26 :    
27 :     setAs("diagonalMatrix", "triangularMatrix",
28 :     function(from) {
29 :     n <- from@Dim[1]
30 :     i <- seq(length = n)
31 :     x <- from@x
32 :     new(if(is.numeric(x)) "dtTMatrix" else "ltTMatrix",
33 :     diag = from@diag, Dim = from@Dim, Dimnames = from@Dimnames,
34 :     x = x, i = i, j = i)
35 :     })
36 :    
37 :     setAs("diagonalMatrix", "matrix",
38 :     function(from) {
39 :     n <- from@Dim[1]
40 :     diag(x = if(from@diag == "U") { if(is.numeric(from@x)) 1. else TRUE
41 :     } else from@x,
42 :     nrow = n, ncol = n)
43 :     })
44 :    
45 : maechler 1174 setAs("diagonalMatrix", "generalMatrix",
46 :     function(from) {
47 :     x <- as(from, "matrix")
48 :     as(x,
49 :     if(is.logical(x)) "lgeMatrix"
50 :     ## Not yet:
51 :     ## else if(is.complex(x)) "zgeMatrix"
52 :     ## else if(is.integer(x)) "igeMatrix"
53 :     else "dgeMatrix")
54 :     })
55 :    
56 : maechler 1295 setAs("ddiMatrix", "dgTMatrix",
57 :     function(from) {
58 :     n <- from@Dim[1]
59 :     i <- seq(length = n) - 1:1
60 :     new("dgTMatrix", i = i, j = i,
61 :     x = if(from@diag == "U") rep(1,n) else from@x,
62 :     Dim = c(n,n), Dimnames = from@Dimnames) })
63 :    
64 :     setAs("ddiMatrix", "dgCMatrix",
65 :     function(from) as(as(from, "dgTMatrix"), "dgCMatrix"))
66 :    
67 :     setAs("ldiMatrix", "lgTMatrix",
68 :     function(from) {
69 :     n <- from@Dim[1]
70 :     i <- (if(from@diag == "U") seq(length = n) else which(from@x)) - 1:1
71 :     new("lgTMatrix", i = i, j = i,
72 :     Dim = c(n,n), Dimnames = from@Dimnames) })
73 :    
74 :     setAs("ldiMatrix", "lgCMatrix",
75 :     function(from) as(as(from, "lgTMatrix"), "lgCMatrix"))
76 :    
77 :     setAs("diagonalMatrix", "sparseMatrix",
78 :     function(from)
79 :     as(from, if(is(from, "dMatrix")) "dgCMatrix" else "lgCMatrix"))
80 :    
81 : maechler 1447 if(FALSE) # now have faster "ddense" -> "dge"
82 : maechler 1174 setAs("ddiMatrix", "dgeMatrix",
83 :     function(from) as(as(from, "matrix"), "dgeMatrix"))
84 :    
85 : maechler 1109 setAs("matrix", "diagonalMatrix",
86 :     function(from) {
87 : maechler 1295 d <- dim(from)
88 : maechler 1109 if(d[1] != (n <- d[2])) stop("non-square matrix")
89 :     if(any(from[row(from) != col(from)] != 0))
90 :     stop("has non-zero off-diagonal entries")
91 : maechler 1295 x <- diag(from)
92 :     if(is.logical(x)) {
93 :     cl <- "ldiMatrix"
94 :     uni <- all(x)
95 :     } else {
96 :     cl <- "ddiMatrix"
97 :     uni <- all(x == 1)
98 :     storage.mode(x) <- "double"
99 :     }
100 :     new(cl, Dim = c(n,n), diag = if(uni) "U" else "N",
101 :     x = if(uni) x[FALSE] else x)
102 : maechler 1109 })
103 :    
104 :     ## ``generic'' coercion to diagonalMatrix : build on isDiagonal() and diag()
105 :     setAs("Matrix", "diagonalMatrix",
106 :     function(from) {
107 :     d <- dim(from)
108 :     if(d[1] != (n <- d[2])) stop("non-square matrix")
109 :     if(!isDiagonal(from)) stop("matrix is not diagonal")
110 :     ## else:
111 :     x <- diag(from)
112 :     if(is.logical(x)) {
113 :     cl <- "ldiMatrix"
114 :     uni <- all(x)
115 :     } else {
116 :     cl <- "ddiMatrix"
117 :     uni <- all(x == 1)
118 :     storage.mode(x) <- "double"
119 :     }
120 :     new(cl, Dim = c(n,n), diag = if(uni) "U" else "N",
121 :     x = if(uni) x[FALSE] else x)
122 :     })
123 :    
124 :     setMethod("t", signature(x = "diagonalMatrix"),
125 :     function(x) { x@Dimnames <- x@Dimnames[2:1] ; x })
126 :    
127 : maechler 1331 setMethod("isDiagonal", signature(object = "diagonalMatrix"),
128 :     function(object) TRUE)
129 :     setMethod("isTriangular", signature(object = "diagonalMatrix"),
130 :     function(object) TRUE)
131 : maechler 1109 setMethod("isSymmetric", signature(object = "diagonalMatrix"),
132 :     function(object) TRUE)
133 :    
134 :     setMethod("diag", signature(x = "diagonalMatrix"),
135 :     function(x = 1, nrow, ncol = n) {
136 :     if(x@diag == "U")
137 :     rep.int(if(is.logical(x@x)) TRUE else 1, x@Dim[1])
138 :     else x@x
139 :     })
140 :    
141 :     setMethod("!", "ldiMatrix", function(e1) {
142 :     if(e1@diag == "N")
143 :     e1@x <- !e1@x
144 :     else { ## "U"
145 :     e1@diag <- "N"
146 :     e1@x <- rep.int(FALSE, e1@Dim[1])
147 :     }
148 :     x
149 :     })
150 :    
151 :     ## Basic Matrix Multiplication {many more to add}
152 :    
153 :     ## FIXME: extend this for 'ldi', i.e. do "diagonalMatrix"
154 :     diagdiagprod <- function(x, y) {
155 :     if(any(dim(x) != dim(y))) stop("non-matching dimensions")
156 :     if(x@diag != "U") {
157 :     if(y@diag != "U") x@x <- x@x * y@x
158 :     return(x)
159 :     } else ## x is unit diagonal
160 :     return(y)
161 :     }
162 :    
163 :     setMethod("%*%", signature(x = "ddiMatrix", y = "ddiMatrix"),
164 :     diagdiagprod, valueClass = "ddiMatrix")
165 :    
166 :     formals(diagdiagprod) <- alist(x=, y=NULL)
167 :     setMethod("crossprod", signature(x = "ddiMatrix", y = "ddiMatrix"),
168 :     diagdiagprod, valueClass = "ddiMatrix")
169 :     setMethod("tcrossprod", signature(x = "ddiMatrix", y = "ddiMatrix"),
170 :     diagdiagprod, valueClass = "ddiMatrix")
171 :    
172 :    
173 :     diagmatprod <- function(x, y) {
174 :     dx <- dim(x)
175 :     dy <- dim(y)
176 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
177 :     n <- dx[1]
178 :     as(if(x@diag == "U") y else x@x * y, "Matrix")
179 :     }
180 :    
181 :     setMethod("%*%", signature(x = "diagonalMatrix", y = "matrix"),
182 :     diagmatprod)
183 :     formals(diagmatprod) <- alist(x=, y=NULL)
184 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "matrix"),
185 :     diagmatprod)
186 :    
187 :     diagdgeprod <- function(x, y) {
188 :     dx <- dim(x)
189 :     dy <- dim(y)
190 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
191 :     if(x@diag != "U")
192 :     y@x <- x@x * y@x
193 :     y
194 :     }
195 :     setMethod("%*%", signature(x = "diagonalMatrix", y = "dgeMatrix"),
196 :     diagdgeprod, valueClass = "dgeMatrix")
197 :     formals(diagdgeprod) <- alist(x=, y=NULL)
198 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "dgeMatrix"),
199 :     diagdgeprod, valueClass = "dgeMatrix")
200 :    
201 :     setMethod("%*%", signature(x = "matrix", y = "diagonalMatrix"),
202 :     function(x, y) {
203 :     dx <- dim(x)
204 :     dy <- dim(y)
205 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
206 :     as(if(y@diag == "U") x else x * rep.int(y@x, dx[1]), "Matrix")
207 :     })
208 :    
209 :     setMethod("%*%", signature(x = "dgeMatrix", y = "diagonalMatrix"),
210 :     function(x, y) {
211 :     dx <- dim(x)
212 :     dy <- dim(y)
213 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
214 :     if(y@diag == "N")
215 :     x@x <- x@x * rep.int(y@x, dx[1])
216 :     x
217 :     })
218 :    
219 : maechler 1295 ## crossprod {more of these}
220 : maechler 1109
221 : maechler 1295 ## tcrossprod --- all are not yet there: do the dense ones here:
222 : maechler 1109
223 : maechler 1295 ## FIXME:
224 :     ## setMethod("tcrossprod", signature(x = "diagonalMatrix", y = "denseMatrix"),
225 :     ## function(x, y = NULL) {
226 :     ## })
227 : maechler 1109
228 : maechler 1295 ## setMethod("tcrossprod", signature(x = "denseMatrix", y = "diagonalMatrix"),
229 :     ## function(x, y = NULL) {
230 :     ## })
231 : maechler 1109
232 : maechler 1295
233 :     ### ---------------- diagonal o sparse -----------------------------
234 :    
235 :     ## These are cheap implementations via coercion
236 :    
237 :     ## FIXME?: In theory, this can be done *FASTER*, in some cases, via tapply1()
238 :    
239 :     setMethod("%*%", signature(x = "diagonalMatrix", y = "sparseMatrix"),
240 :     function(x, y) as(x, "sparseMatrix") %*% y)
241 :    
242 :     setMethod("%*%", signature(x = "sparseMatrix", y = "diagonalMatrix"),
243 :     function(x, y) x %*% as(y, "sparseMatrix"))
244 :    
245 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "sparseMatrix"),
246 :     function(x, y = NULL) { x <- as(x, "sparseMatrix"); callGeneric() })
247 :    
248 :     setMethod("crossprod", signature(x = "sparseMatrix", y = "diagonalMatrix"),
249 :     function(x, y = NULL) { y <- as(y, "sparseMatrix"); callGeneric() })
250 :    
251 :     setMethod("tcrossprod", signature(x = "diagonalMatrix", y = "sparseMatrix"),
252 :     function(x, y = NULL) { x <- as(x, "sparseMatrix"); callGeneric() })
253 :    
254 :     setMethod("tcrossprod", signature(x = "sparseMatrix", y = "diagonalMatrix"),
255 :     function(x, y = NULL) { y <- as(y, "sparseMatrix"); callGeneric() })
256 :    
257 :    
258 :    
259 :    
260 : maechler 1109 ## similar to prTriang() in ./Auxiliaries.R :
261 :     prDiag <-
262 :     function(x, digits = getOption("digits"), justify = "none", right = TRUE)
263 :     {
264 :     cf <- array(".", dim = x@Dim, dimnames = x@Dimnames)
265 :     cf[row(cf) == col(cf)] <-
266 :     sapply(diag(x), format, digits = digits, justify = justify)
267 :     print(cf, quote = FALSE, right = right)
268 :     invisible(x)
269 :     }
270 :    
271 :     setMethod("show", signature(object = "diagonalMatrix"),
272 :     function(object) prDiag(object))
273 :    

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