SCM

SCM Repository

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

Annotation of /pkg/Matrix/R/diagMatrix.R

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1331 - (view) (download)
Original Path: pkg/R/diagMatrix.R

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 1174 setAs("ddiMatrix", "dgeMatrix",
82 :     function(from) as(as(from, "matrix"), "dgeMatrix"))
83 :    
84 : maechler 1109 setAs("matrix", "diagonalMatrix",
85 :     function(from) {
86 : maechler 1295 d <- dim(from)
87 : maechler 1109 if(d[1] != (n <- d[2])) stop("non-square matrix")
88 :     if(any(from[row(from) != col(from)] != 0))
89 :     stop("has non-zero off-diagonal entries")
90 : maechler 1295 x <- diag(from)
91 :     if(is.logical(x)) {
92 :     cl <- "ldiMatrix"
93 :     uni <- all(x)
94 :     } else {
95 :     cl <- "ddiMatrix"
96 :     uni <- all(x == 1)
97 :     storage.mode(x) <- "double"
98 :     }
99 :     new(cl, Dim = c(n,n), diag = if(uni) "U" else "N",
100 :     x = if(uni) x[FALSE] else x)
101 : maechler 1109 })
102 :    
103 :     ## ``generic'' coercion to diagonalMatrix : build on isDiagonal() and diag()
104 :     setAs("Matrix", "diagonalMatrix",
105 :     function(from) {
106 :     d <- dim(from)
107 :     if(d[1] != (n <- d[2])) stop("non-square matrix")
108 :     if(!isDiagonal(from)) stop("matrix is not diagonal")
109 :     ## else:
110 :     x <- diag(from)
111 :     if(is.logical(x)) {
112 :     cl <- "ldiMatrix"
113 :     uni <- all(x)
114 :     } else {
115 :     cl <- "ddiMatrix"
116 :     uni <- all(x == 1)
117 :     storage.mode(x) <- "double"
118 :     }
119 :     new(cl, Dim = c(n,n), diag = if(uni) "U" else "N",
120 :     x = if(uni) x[FALSE] else x)
121 :     })
122 :    
123 :     setMethod("t", signature(x = "diagonalMatrix"),
124 :     function(x) { x@Dimnames <- x@Dimnames[2:1] ; x })
125 :    
126 : maechler 1331 setMethod("isDiagonal", signature(object = "diagonalMatrix"),
127 :     function(object) TRUE)
128 :     setMethod("isTriangular", signature(object = "diagonalMatrix"),
129 :     function(object) TRUE)
130 : maechler 1109 setMethod("isSymmetric", signature(object = "diagonalMatrix"),
131 :     function(object) TRUE)
132 :    
133 :     setMethod("diag", signature(x = "diagonalMatrix"),
134 :     function(x = 1, nrow, ncol = n) {
135 :     if(x@diag == "U")
136 :     rep.int(if(is.logical(x@x)) TRUE else 1, x@Dim[1])
137 :     else x@x
138 :     })
139 :    
140 :     setMethod("!", "ldiMatrix", function(e1) {
141 :     if(e1@diag == "N")
142 :     e1@x <- !e1@x
143 :     else { ## "U"
144 :     e1@diag <- "N"
145 :     e1@x <- rep.int(FALSE, e1@Dim[1])
146 :     }
147 :     x
148 :     })
149 :    
150 :     ## Basic Matrix Multiplication {many more to add}
151 :    
152 :     ## FIXME: extend this for 'ldi', i.e. do "diagonalMatrix"
153 :     diagdiagprod <- function(x, y) {
154 :     if(any(dim(x) != dim(y))) stop("non-matching dimensions")
155 :     if(x@diag != "U") {
156 :     if(y@diag != "U") x@x <- x@x * y@x
157 :     return(x)
158 :     } else ## x is unit diagonal
159 :     return(y)
160 :     }
161 :    
162 :     setMethod("%*%", signature(x = "ddiMatrix", y = "ddiMatrix"),
163 :     diagdiagprod, valueClass = "ddiMatrix")
164 :    
165 :     formals(diagdiagprod) <- alist(x=, y=NULL)
166 :     setMethod("crossprod", signature(x = "ddiMatrix", y = "ddiMatrix"),
167 :     diagdiagprod, valueClass = "ddiMatrix")
168 :     setMethod("tcrossprod", signature(x = "ddiMatrix", y = "ddiMatrix"),
169 :     diagdiagprod, valueClass = "ddiMatrix")
170 :    
171 :    
172 :     diagmatprod <- function(x, y) {
173 :     dx <- dim(x)
174 :     dy <- dim(y)
175 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
176 :     n <- dx[1]
177 :     as(if(x@diag == "U") y else x@x * y, "Matrix")
178 :     }
179 :    
180 :     setMethod("%*%", signature(x = "diagonalMatrix", y = "matrix"),
181 :     diagmatprod)
182 :     formals(diagmatprod) <- alist(x=, y=NULL)
183 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "matrix"),
184 :     diagmatprod)
185 :    
186 :     diagdgeprod <- function(x, y) {
187 :     dx <- dim(x)
188 :     dy <- dim(y)
189 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
190 :     if(x@diag != "U")
191 :     y@x <- x@x * y@x
192 :     y
193 :     }
194 :     setMethod("%*%", signature(x = "diagonalMatrix", y = "dgeMatrix"),
195 :     diagdgeprod, valueClass = "dgeMatrix")
196 :     formals(diagdgeprod) <- alist(x=, y=NULL)
197 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "dgeMatrix"),
198 :     diagdgeprod, valueClass = "dgeMatrix")
199 :    
200 :     setMethod("%*%", signature(x = "matrix", y = "diagonalMatrix"),
201 :     function(x, y) {
202 :     dx <- dim(x)
203 :     dy <- dim(y)
204 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
205 :     as(if(y@diag == "U") x else x * rep.int(y@x, dx[1]), "Matrix")
206 :     })
207 :    
208 :     setMethod("%*%", signature(x = "dgeMatrix", y = "diagonalMatrix"),
209 :     function(x, y) {
210 :     dx <- dim(x)
211 :     dy <- dim(y)
212 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
213 :     if(y@diag == "N")
214 :     x@x <- x@x * rep.int(y@x, dx[1])
215 :     x
216 :     })
217 :    
218 : maechler 1295 ## crossprod {more of these}
219 : maechler 1109
220 : maechler 1295 ## tcrossprod --- all are not yet there: do the dense ones here:
221 : maechler 1109
222 : maechler 1295 ## FIXME:
223 :     ## setMethod("tcrossprod", signature(x = "diagonalMatrix", y = "denseMatrix"),
224 :     ## function(x, y = NULL) {
225 :     ## })
226 : maechler 1109
227 : maechler 1295 ## setMethod("tcrossprod", signature(x = "denseMatrix", y = "diagonalMatrix"),
228 :     ## function(x, y = NULL) {
229 :     ## })
230 : maechler 1109
231 : maechler 1295
232 :     ### ---------------- diagonal o sparse -----------------------------
233 :    
234 :     ## These are cheap implementations via coercion
235 :    
236 :     ## FIXME?: In theory, this can be done *FASTER*, in some cases, via tapply1()
237 :    
238 :     setMethod("%*%", signature(x = "diagonalMatrix", y = "sparseMatrix"),
239 :     function(x, y) as(x, "sparseMatrix") %*% y)
240 :    
241 :     setMethod("%*%", signature(x = "sparseMatrix", y = "diagonalMatrix"),
242 :     function(x, y) x %*% as(y, "sparseMatrix"))
243 :    
244 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "sparseMatrix"),
245 :     function(x, y = NULL) { x <- as(x, "sparseMatrix"); callGeneric() })
246 :    
247 :     setMethod("crossprod", signature(x = "sparseMatrix", y = "diagonalMatrix"),
248 :     function(x, y = NULL) { y <- as(y, "sparseMatrix"); callGeneric() })
249 :    
250 :     setMethod("tcrossprod", signature(x = "diagonalMatrix", y = "sparseMatrix"),
251 :     function(x, y = NULL) { x <- as(x, "sparseMatrix"); callGeneric() })
252 :    
253 :     setMethod("tcrossprod", signature(x = "sparseMatrix", y = "diagonalMatrix"),
254 :     function(x, y = NULL) { y <- as(y, "sparseMatrix"); callGeneric() })
255 :    
256 :    
257 :    
258 :    
259 : maechler 1109 ## similar to prTriang() in ./Auxiliaries.R :
260 :     prDiag <-
261 :     function(x, digits = getOption("digits"), justify = "none", right = TRUE)
262 :     {
263 :     cf <- array(".", dim = x@Dim, dimnames = x@Dimnames)
264 :     cf[row(cf) == col(cf)] <-
265 :     sapply(diag(x), format, digits = digits, justify = justify)
266 :     print(cf, quote = FALSE, right = right)
267 :     invisible(x)
268 :     }
269 :    
270 :     setMethod("show", signature(object = "diagonalMatrix"),
271 :     function(object) prDiag(object))
272 :    

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