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 2472 - (view) (download)
Original Path: pkg/R/diagMatrix.R

1 : maechler 1617 #### All methods for "diagonalMatrix" and its subclasses,
2 :     #### currently "ddiMatrix", "ldiMatrix"
3 :    
4 : maechler 1109 ## Purpose: Constructor of diagonal matrices -- ~= diag() ,
5 :     ## but *not* diag() extractor!
6 :     Diagonal <- function(n, x = NULL)
7 :     {
8 : maechler 1575 ## Allow Diagonal(4) and Diagonal(x=1:5)
9 : maechler 1109 if(missing(n))
10 : maechler 1575 n <- length(x)
11 : maechler 1109 else {
12 : maechler 1575 stopifnot(length(n) == 1, n == as.integer(n), n >= 0)
13 :     n <- as.integer(n)
14 : maechler 1109 }
15 :    
16 : maechler 1654 if(missing(x)) ## unit diagonal matrix
17 : maechler 1575 new("ddiMatrix", Dim = c(n,n), diag = "U")
18 : maechler 1109 else {
19 : maechler 2128 lx <- length(x)
20 :     stopifnot(lx == 1 || lx == n) # but keep 'x' short for now
21 : maechler 1575 if(is.logical(x))
22 :     cl <- "ldiMatrix"
23 :     else if(is.numeric(x)) {
24 :     cl <- "ddiMatrix"
25 :     x <- as.numeric(x)
26 :     }
27 :     else if(is.complex(x)) {
28 :     cl <- "zdiMatrix" # will not yet work
29 :     } else stop("'x' has invalid data type")
30 : maechler 2128 new(cl, Dim = c(n,n), diag = "N",
31 :     x = if(lx == 1) rep.int(x,n) else x)
32 : maechler 1109 }
33 :     }
34 :    
35 : mmaechler 2226 .sparseDiagonal <- function(n, x = rep.int(1,n), uplo = "U", shape = "t") {
36 : maechler 2144 stopifnot(n == (n. <- as.integer(n)), (n <- n.) >= 0)
37 :     if((lx <- length(x)) == 1) x <- rep.int(x, n)
38 :     else if(lx != n) stop("length(x) must be 1 or n")
39 : mmaechler 2226 stopifnot(is.character(shape), nchar(shape) == 1,
40 :     any(shape == c("t","s","g"))) # triangular / symmetric / general
41 :     kind <-
42 :     if(is.double(x)) "d"
43 :     else if(is.logical(x)) "l"
44 :     else { ## for now
45 :     storage.mode(x) <- "double"
46 :     "d"
47 :     }
48 : mmaechler 2472 ii <- if(n) 0:(n - 1L) else integer(0)
49 :     if(shape == "g")
50 :     new(paste0(kind, "gCMatrix"), Dim = c(n,n),
51 :     x = x, i = ii, p = 0:n)
52 :     else new(paste0(kind, shape, "CMatrix"), Dim = c(n,n), uplo = uplo,
53 :     x = x, i = ii, p = 0:n)
54 : maechler 2144 }
55 :    
56 : mmaechler 2226 ## Pkg 'spdep' had (relatively slow) versions of this as_dsCMatrix_I()
57 :     .symDiagonal <- function(n, x = rep.int(1,n), uplo = "U")
58 :     .sparseDiagonal(n, x, uplo, shape = "s")
59 :    
60 :     ## instead of diagU2N(as(Diagonal(n), "CsparseMatrix")), diag = "N" in any case:
61 :     .trDiagonal <- function(n, x = rep.int(1,n), uplo = "U")
62 :     .sparseDiagonal(n, x, uplo, shape = "t")
63 :    
64 :    
65 : maechler 1617 ### This is modified from a post of Bert Gunter to R-help on 1 Sep 2005.
66 :     ### Bert's code built on a post by Andy Liaw who most probably was influenced
67 :     ### by earlier posts, notably one by Scott Chasalow on S-news, 16 Jan 2002
68 :     ### who posted his bdiag() function written in December 1995.
69 : mmaechler 2209 if(FALSE)##--- no longer used:
70 : mmaechler 2206 .bdiag <- function(lst) {
71 :     ### block-diagonal matrix [a dgTMatrix] from list of matrices
72 :     stopifnot(is.list(lst), length(lst) >= 1)
73 :     dims <- sapply(lst, dim, USE.NAMES=FALSE)
74 : maechler 1617 ## make sure we had all matrices:
75 :     if(!(is.matrix(dims) && nrow(dims) == 2))
76 :     stop("some arguments are not matrices")
77 : maechler 1845 csdim <- rbind(rep.int(0L, 2),
78 : mmaechler 2206 apply(dims, 1, cumsum))
79 :     r <- new("dgTMatrix")
80 :     r@Dim <- as.integer(csdim[nrow(csdim),])
81 : maechler 1617 add1 <- matrix(1:0, 2,2)
82 : mmaechler 2206 for(i in seq_along(lst)) {
83 : maechler 1617 indx <- apply(csdim[i:(i+1),] + add1, 2, function(n) n[1]:n[2])
84 :     if(is.null(dim(indx))) ## non-square matrix
85 : mmaechler 2206 r[indx[[1]],indx[[2]]] <- lst[[i]]
86 : maechler 1617 else ## square matrix
87 : mmaechler 2206 r[indx[,1], indx[,2]] <- lst[[i]]
88 : maechler 1617 }
89 : mmaechler 2206 r
90 : maechler 1617 }
91 : mmaechler 2209 ## expand(<mer>) needed something like bdiag() for lower-triangular
92 :     ## (Tsparse) Matrices; hence Doug Bates provided a much more efficient
93 :     ## implementation for those; now extended and generalized:
94 : mmaechler 2206 .bdiag <- function(lst) {
95 : mmaechler 2209 ## block-diagonal matrix [a dgTMatrix] from list of matrices
96 : mmaechler 2206 stopifnot(is.list(lst), (nl <- length(lst)) >= 1)
97 : maechler 1617
98 : mmaechler 2206 Tlst <- lapply(lapply(lst, Matrix:::as_Csp2), # includes "diagU2N"
99 : mmaechler 2209 as, "TsparseMatrix")
100 : mmaechler 2206 if(nl == 1) return(Tlst[[1]])
101 :     ## else
102 :     i_off <- c(0L, cumsum(sapply(Tlst, nrow)))
103 :     j_off <- c(0L, cumsum(sapply(Tlst, ncol)))
104 : mmaechler 2209
105 :     clss <- sapply(Tlst, class)
106 :     knds <- substr(clss, 2, 2)
107 :     sym <- knds == "s" # symmetric ones
108 :     tri <- knds == "t" # triangular ones
109 :     use.n <- any(is.n <- substr(clss,1,1) == "n")
110 :     if(use.n && !(use.n <- all(is.n)))
111 :     Tlst[is.n] <- lapply(Tlst[is.n], as, "lMatrix")
112 :     if(all(sym)) { ## result should be *symmetric*
113 :     uplos <- sapply(Tlst, slot, "uplo") ## either "U" or "L"
114 :     tLU <- table(uplos)# of length 1 or 2 ..
115 :     if(length(tLU) == 1) { ## all "U" or all "L"
116 :     useU <- uplos[1] == "U"
117 :     } else { ## length(tLU) == 2, counting "L" and "U"
118 :     useU <- diff(tLU) >= 0
119 :     if(useU && (hasL <- tLU[1] > 0))
120 :     Tlst[hasL] <- lapply(Tlst[hasL], t)
121 :     else if(!useU && (hasU <- tLU[2] > 0))
122 :     Tlst[hasU] <- lapply(Tlst[hasU], t)
123 :     }
124 :     if(use.n) { ## return nsparseMatrix :
125 :     r <- new("nsTMatrix")
126 :     } else {
127 :     r <- new("dsTMatrix")
128 :     r@x <- unlist(lapply(Tlst, slot, "x"))
129 :     }
130 :     r@uplo <- if(useU) "U" else "L"
131 :     }
132 :     else if(all(tri) && { ULs <- sapply(Tlst, slot, "uplo")## "U" or "L"
133 :     all(ULs[1L] == ULs[-1L]) } ## all upper or all lower
134 :     ){ ## *triangular* result
135 :    
136 :     if(use.n) { ## return nsparseMatrix :
137 :     r <- new("ntTMatrix")
138 :     } else {
139 :     r <- new("dtTMatrix")
140 :     r@x <- unlist(lapply(Tlst, slot, "x"))
141 :     }
142 :     r@uplo <- ULs[1L]
143 :     }
144 :     else {
145 :     if(any(sym))
146 :     Tlst[sym] <- lapply(Tlst[sym], as, "generalMatrix")
147 :     if(use.n) { ## return nsparseMatrix :
148 :     r <- new("ngTMatrix")
149 :     } else {
150 :     r <- new("dgTMatrix")
151 :     r@x <- unlist(lapply(Tlst, slot, "x"))
152 :     }
153 :     }
154 :     r@Dim <- c(i_off[nl+1], j_off[nl + 1])
155 :     r@i <- unlist(lapply(1:nl, function(k) Tlst[[k]]@i + i_off[k]))
156 :     r@j <- unlist(lapply(1:nl, function(k) Tlst[[k]]@j + j_off[k]))
157 :     r
158 : mmaechler 2206 }
159 :    
160 :     bdiag <- function(...) {
161 :     if((nA <- nargs()) == 0) return(new("dgCMatrix"))
162 :     if(nA == 1 && !is.list(...))
163 :     return(as(..., "CsparseMatrix"))
164 :     alis <- if(nA == 1 && is.list(..1)) ..1 else list(...)
165 :     if(length(alis) == 1)
166 :     return(as(alis[[1]], "CsparseMatrix"))
167 :    
168 :     ## else : two or more arguments
169 :     as(.bdiag(alis), "CsparseMatrix")
170 :     }
171 :    
172 :    
173 : maechler 2136 .diag2tT <- function(from, uplo = "U", kind = .M.kind(from)) {
174 :     ## to triangular Tsparse
175 : maechler 1845 i <- if(from@diag == "U") integer(0) else seq_len(from@Dim[1]) - 1L
176 : maechler 2136 new(paste(kind, "tTMatrix", sep=''),
177 : maechler 1654 diag = from@diag, Dim = from@Dim, Dimnames = from@Dimnames,
178 : maechler 2128 uplo = uplo,
179 : maechler 1654 x = from@x, # <- ok for diag = "U" and "N" (!)
180 :     i = i, j = i)
181 :     }
182 : maechler 1109
183 : maechler 2136 .diag2sT <- function(from, uplo = "U", kind = .M.kind(from)) {
184 :     ## to symmetric Tsparse
185 : maechler 2128 n <- from@Dim[1]
186 :     i <- seq_len(n) - 1L
187 :     new(paste(kind, "sTMatrix", sep=''),
188 : maechler 1845 Dim = from@Dim, Dimnames = from@Dimnames,
189 : maechler 2128 i = i, j = i, uplo = uplo,
190 :     x = if(from@diag == "N") from@x else ## "U"-diag
191 :     rep.int(switch(kind,
192 :     "d" = 1.,
193 :     "l" =,
194 :     "n" = TRUE,
195 :     ## otherwise
196 :     stop("'", kind,"' kind not yet implemented")), n))
197 : maechler 1845 }
198 :    
199 : maechler 2128 ## diagonal -> triangular, upper / lower depending on "partner":
200 : maechler 2144 diag2tT.u <- function(d, x, kind = .M.kind(d))
201 :     .diag2tT(d, uplo = if(is(x,"triangularMatrix")) x@uplo else "U", kind)
202 : maechler 2128
203 : mmaechler 2175 ## diagonal -> sparse {triangular OR symmetric} (upper / lower) depending on "partner":
204 :     diag2Tsmart <- function(d, x, kind = .M.kind(d)) {
205 :     clx <- getClassDef(class(x))
206 :     if(extends(clx, "symmetricMatrix"))
207 :     .diag2sT(d, uplo = x@uplo, kind)
208 :     else
209 :     .diag2tT(d, uplo = if(extends(clx,"triangularMatrix")) x@uplo else "U", kind)
210 :     }
211 : maechler 2136
212 : mmaechler 2175
213 : maechler 2136 ## In order to evade method dispatch ambiguity warnings,
214 :     ## and because we can save a .M.kind() call, we use this explicit
215 :     ## "hack" instead of signature x = "diagonalMatrix" :
216 :     ##
217 :     ## ddi*:
218 :     diag2tT <- function(from) .diag2tT(from, "U", "d")
219 :     setAs("ddiMatrix", "triangularMatrix", diag2tT)
220 : mmaechler 2239 ##_no_longer_ setAs("ddiMatrix", "sparseMatrix", diag2tT)
221 : maechler 1805 ## needed too (otherwise <dense> -> Tsparse is taken):
222 : maechler 2136 setAs("ddiMatrix", "TsparseMatrix", diag2tT)
223 :     setAs("ddiMatrix", "CsparseMatrix",
224 :     function(from) as(.diag2tT(from, "U", "d"), "CsparseMatrix"))
225 :     setAs("ddiMatrix", "symmetricMatrix",
226 :     function(from) .diag2sT(from, "U", "d"))
227 :     ##
228 :     ## ldi*:
229 :     diag2tT <- function(from) .diag2tT(from, "U", "l")
230 :     setAs("ldiMatrix", "triangularMatrix", diag2tT)
231 : mmaechler 2239 ##_no_longer_ setAs("ldiMatrix", "sparseMatrix", diag2tT)
232 : maechler 2136 ## needed too (otherwise <dense> -> Tsparse is taken):
233 :     setAs("ldiMatrix", "TsparseMatrix", diag2tT)
234 :     setAs("ldiMatrix", "CsparseMatrix",
235 :     function(from) as(.diag2tT(from, "U", "l"), "CsparseMatrix"))
236 :     setAs("ldiMatrix", "symmetricMatrix",
237 :     function(from) .diag2sT(from, "U", "l"))
238 : maechler 1654
239 : maechler 1845
240 : maechler 2128 setAs("diagonalMatrix", "nMatrix",
241 :     function(from) {
242 :     n <- from@Dim[1]
243 :     i <- if(from@diag == "U") integer(0) else which(isN0(from@x)) - 1L
244 :     new("ntTMatrix", i = i, j = i, diag = from@diag,
245 :     Dim = from@Dim, Dimnames = from@Dimnames)
246 :     })
247 :    
248 : mmaechler 2237 setAs("diagonalMatrix", "nsparseMatrix", function(from) as(from, "nMatrix"))
249 : maechler 2128
250 : mmaechler 2175 ## Cheap fast substitute for diag() which *does* preserve the mode of x :
251 :     mkDiag <- function(x, n) {
252 :     y <- matrix(as0(mod=mode(x)), n,n)
253 :     if (n > 0) y[1L + 0:(n - 1L) * (n + 1L)] <- x
254 :     y
255 :     }
256 :    
257 : maechler 1109 setAs("diagonalMatrix", "matrix",
258 :     function(from) {
259 : mmaechler 2175 ## want "ldiMatrix" -> <logical> "matrix" :
260 :     mkDiag(if(from@diag == "U") as1(from@x) else from@x,
261 :     n = from@Dim[1])
262 : maechler 1109 })
263 :    
264 : maechler 2098 setMethod("as.vector", signature(x = "diagonalMatrix", mode="missing"),
265 :     function(x, mode) {
266 :     n <- x@Dim[1]
267 : mmaechler 2175 mod.x <- mode(x@x)
268 :     r <- vector(mod.x, length = n^2)
269 : maechler 2098 if(n)
270 :     r[1 + 0:(n - 1) * (n + 1)] <-
271 : mmaechler 2175 if(x@diag == "U") as1(mod=mod.x) else x@x
272 : maechler 2098 r
273 :     })
274 :    
275 : maechler 1654 setAs("diagonalMatrix", "generalMatrix", # prefer sparse:
276 : maechler 2128 function(from) as(as(from, "CsparseMatrix"), "generalMatrix"))
277 : maechler 1174
278 : mmaechler 2268 setAs("diagonalMatrix", "denseMatrix",
279 :     function(from) as(as(from, "CsparseMatrix"), "denseMatrix"))
280 :    
281 : mmaechler 2185 .diag.x <- function(m) if(m@diag == "U") rep.int(as1(m@x), m@Dim[1]) else m@x
282 : maechler 1655
283 :     .diag.2N <- function(m) {
284 :     if(m@diag == "U") m@diag <- "N"
285 :     m
286 :     }
287 :    
288 : maechler 1174 setAs("ddiMatrix", "dgeMatrix",
289 : mmaechler 2183 function(from) .Call(dup_mMatrix_as_dgeMatrix, from))
290 :     setAs("ddiMatrix", "ddenseMatrix",
291 :     function(from) as(as(from, "triangularMatrix"),"denseMatrix"))
292 :     setAs("ldiMatrix", "ldenseMatrix",
293 :     function(from) as(as(from, "triangularMatrix"),"denseMatrix"))
294 : maechler 1174
295 : mmaechler 2183
296 : maechler 1109 setAs("matrix", "diagonalMatrix",
297 :     function(from) {
298 : maechler 1295 d <- dim(from)
299 : maechler 1109 if(d[1] != (n <- d[2])) stop("non-square matrix")
300 :     if(any(from[row(from) != col(from)] != 0))
301 : mmaechler 2341 stop("matrix with non-zero off-diagonals cannot be coerced to diagonalMatrix")
302 : maechler 1295 x <- diag(from)
303 :     if(is.logical(x)) {
304 :     cl <- "ldiMatrix"
305 : mmaechler 2341 uni <- allTrue(x) ## uni := {is it unit-diagonal ?}
306 : maechler 1295 } else {
307 :     cl <- "ddiMatrix"
308 : mmaechler 2341 uni <- allTrue(x == 1)
309 : maechler 1295 storage.mode(x) <- "double"
310 : maechler 1575 } ## TODO: complex
311 : maechler 1295 new(cl, Dim = c(n,n), diag = if(uni) "U" else "N",
312 :     x = if(uni) x[FALSE] else x)
313 : maechler 1109 })
314 :    
315 :     ## ``generic'' coercion to diagonalMatrix : build on isDiagonal() and diag()
316 :     setAs("Matrix", "diagonalMatrix",
317 :     function(from) {
318 : mmaechler 2341 d <- dim(from)
319 : maechler 1109 if(d[1] != (n <- d[2])) stop("non-square matrix")
320 : mmaechler 2341 if(!isDiagonal(from)) stop("matrix is not diagonal")
321 :     ## else:
322 :     x <- diag(from)
323 :     if(is.logical(x)) {
324 :     cl <- "ldiMatrix"
325 :     uni <- allTrue(x)
326 :     } else {
327 :     cl <- "ddiMatrix"
328 :     uni <- allTrue(x == 1)
329 :     storage.mode(x) <- "double"
330 :     } ## TODO: complex
331 :     new(cl, Dim = c(n,n), diag = if(uni) "U" else "N",
332 :     x = if(uni) x[FALSE] else x)
333 : maechler 1109 })
334 :    
335 : maechler 1708
336 : mmaechler 2185 setMethod("diag", signature(x = "diagonalMatrix"),
337 :     function(x = 1, nrow, ncol) .diag.x(x))
338 : maechler 1708
339 : maechler 2098 subDiag <- function(x, i, j, ..., drop) {
340 : mmaechler 2239 x <- as(x, "TsparseMatrix")
341 : maechler 1799 x <- if(missing(i))
342 :     x[, j, drop=drop]
343 :     else if(missing(j))
344 : mmaechler 2363 if(nargs() == 4) x[i, , drop=drop] else x[i, drop=drop]
345 : maechler 1799 else
346 :     x[i,j, drop=drop]
347 : maechler 2120 if(isS4(x) && isDiagonal(x)) as(x, "diagonalMatrix") else x
348 : maechler 1799 }
349 :    
350 :     setMethod("[", signature(x = "diagonalMatrix", i = "index",
351 :     j = "index", drop = "logical"), subDiag)
352 :     setMethod("[", signature(x = "diagonalMatrix", i = "index",
353 : mmaechler 2363 j = "missing", drop = "logical"),
354 :     function(x, i, j, ..., drop) {
355 :     na <- nargs()
356 :     Matrix.msg("diag[i,m,l] : nargs()=", na, .M.level = 2)
357 :     if(na == 4)
358 :     subDiag(x, i=i, , drop=drop)
359 :     else subDiag(x, i=i, drop=drop)
360 :     })
361 : maechler 1799 setMethod("[", signature(x = "diagonalMatrix", i = "missing",
362 :     j = "index", drop = "logical"),
363 : maechler 2098 function(x, i, j, ..., drop) subDiag(x, j=j, drop=drop))
364 : maechler 1799
365 : maechler 1617 ## When you assign to a diagonalMatrix, the result should be
366 : maechler 1708 ## diagonal or sparse ---
367 :     ## FIXME: this now fails because the "denseMatrix" methods come first in dispatch
368 : maechler 2098 ## Only(?) current bug: x[i] <- value is wrong when i is *vector*
369 :     replDiag <- function(x, i, j, ..., value) {
370 : mmaechler 2239 x <- as(x, "TsparseMatrix")
371 : maechler 1710 if(missing(i))
372 :     x[, j] <- value
373 : maechler 2098 else if(missing(j)) { ## x[i , ] <- v *OR* x[i] <- v
374 :     na <- nargs()
375 :     ## message("diagnosing replDiag() -- nargs()= ", na)
376 :     if(na == 4)
377 :     x[i, ] <- value
378 :     else if(na == 3)
379 :     x[i] <- value
380 :     else stop("Internal bug: nargs()=",na,"; please report")
381 :     } else
382 : maechler 1710 x[i,j] <- value
383 :     if(isDiagonal(x)) as(x, "diagonalMatrix") else x
384 :     }
385 : maechler 1617
386 : maechler 1710 setReplaceMethod("[", signature(x = "diagonalMatrix", i = "index",
387 :     j = "index", value = "replValue"), replDiag)
388 : maechler 2098
389 : maechler 1710 setReplaceMethod("[", signature(x = "diagonalMatrix", i = "index",
390 :     j = "missing", value = "replValue"),
391 : maechler 2098 function(x,i,j, ..., value) {
392 :     ## message("before replDiag() -- nargs()= ", nargs())
393 :     if(nargs() == 3)
394 :     replDiag(x, i=i, value=value)
395 :     else ## nargs() == 4 :
396 :     replDiag(x, i=i, , value=value)
397 :     })
398 :    
399 : mmaechler 2192 setReplaceMethod("[", signature(x = "diagonalMatrix",
400 :     i = "matrix", # 2-col.matrix
401 : maechler 2096 j = "missing", value = "replValue"),
402 : maechler 2098 function(x,i,j, ..., value) {
403 : maechler 2096 if(ncol(i) == 2) {
404 :     if(all((ii <- i[,1]) == i[,2])) { # replace in diagonal only
405 : mmaechler 2192 if(x@diag == "U") {
406 :     one <- as1(x@x)
407 :     if(any(value != one | is.na(value))) {
408 :     x@diag <- "N"
409 :     x@x <- rep.int(one, x@Dim[1])
410 :     }
411 :     }
412 : maechler 2096 x@x[ii] <- value
413 :     x
414 :     } else { ## no longer diagonal, but remain sparse:
415 : mmaechler 2239 x <- as(x, "TsparseMatrix")
416 : maechler 2096 x[i] <- value
417 :     x
418 :     }
419 :     }
420 :     else { # behave as "base R": use as if vector
421 :     x <- as(x, "matrix")
422 :     x[i] <- value
423 :     Matrix(x)
424 :     }
425 :     })
426 :    
427 : maechler 1710 setReplaceMethod("[", signature(x = "diagonalMatrix", i = "missing",
428 :     j = "index", value = "replValue"),
429 : maechler 2098 function(x,i,j, ..., value) replDiag(x, j=j, value=value))
430 : maechler 1710
431 : mmaechler 2207 setReplaceMethod("[", signature(x = "diagonalMatrix", i = "missing", j = "index",
432 : mmaechler 2239 value = "sparseMatrix"),
433 : mmaechler 2207 function (x, i, j, ..., value)
434 :     callGeneric(x=x, , j=j, value = as(value, "sparseVector")))
435 :     setReplaceMethod("[", signature(x = "diagonalMatrix", i = "index", j = "missing",
436 : mmaechler 2239 value = "sparseMatrix"),
437 : mmaechler 2207 function (x, i, j, ..., value)
438 :     callGeneric(x=x, i=i, , value = as(value, "sparseVector")))
439 :     setReplaceMethod("[", signature(x = "diagonalMatrix", i = "index", j = "index",
440 : mmaechler 2239 value = "sparseMatrix"),
441 : mmaechler 2207 function (x, i, j, ..., value)
442 :     callGeneric(x=x, i=i, j=j, value = as(value, "sparseVector")))
443 : maechler 1710
444 : mmaechler 2207 setReplaceMethod("[", signature(x = "diagonalMatrix", i = "missing", j = "index",
445 :     value = "sparseVector"),
446 :     replDiag)
447 :     setReplaceMethod("[", signature(x = "diagonalMatrix", i = "index", j = "missing",
448 :     value = "sparseVector"),
449 :     replDiag)
450 :     setReplaceMethod("[", signature(x = "diagonalMatrix", i = "index", j = "index",
451 :     value = "sparseVector"),
452 :     replDiag)
453 :    
454 :    
455 : maechler 1109 setMethod("t", signature(x = "diagonalMatrix"),
456 :     function(x) { x@Dimnames <- x@Dimnames[2:1] ; x })
457 :    
458 : maechler 1331 setMethod("isDiagonal", signature(object = "diagonalMatrix"),
459 :     function(object) TRUE)
460 :     setMethod("isTriangular", signature(object = "diagonalMatrix"),
461 :     function(object) TRUE)
462 : maechler 1109 setMethod("isSymmetric", signature(object = "diagonalMatrix"),
463 : maechler 2112 function(object, ...) TRUE)
464 : maechler 1109
465 : maechler 2112 setMethod("symmpart", signature(x = "diagonalMatrix"), function(x) x)
466 :     setMethod("skewpart", signature(x = "diagonalMatrix"), setZero)
467 :    
468 : maechler 2133 setMethod("chol", signature(x = "ddiMatrix"),
469 :     function(x, pivot, ...) {
470 : mmaechler 2183 if(x@diag == "U") return(x)
471 :     ## else
472 : maechler 2133 if(any(x@x < 0))
473 :     stop("chol() is undefined for diagonal matrix with negative entries")
474 : maechler 1654 x@x <- sqrt(x@x)
475 :     x
476 :     })
477 :     ## chol(L) is L for logical diagonal:
478 : maechler 2133 setMethod("chol", signature(x = "ldiMatrix"), function(x, pivot, ...) x)
479 : maechler 1654
480 : mmaechler 2175 setMethod("determinant", signature(x = "diagonalMatrix", logarithm = "logical"),
481 : mmaechler 2185 function(x, logarithm, ...) mkDet(.diag.x(x), logarithm))
482 : mmaechler 2175
483 : mmaechler 2183 setMethod("norm", signature(x = "diagonalMatrix", type = "character"),
484 :     function(x, type, ...) {
485 :     if((n <- x@Dim[1]) == 0) return(0) # as for "sparseMatrix"
486 :     type <- toupper(substr(type[1], 1, 1))
487 :     isU <- (x@diag == "U") # unit-diagonal
488 :     if(type == "F") sqrt(if(isU) n else sum(x@x^2))
489 :     else { ## norm == "I","1","O","M" :
490 :     if(isU) 1 else max(abs(x@x))
491 :     }
492 :     })
493 :    
494 :    
495 :    
496 : maechler 1109 ## Basic Matrix Multiplication {many more to add}
497 : maechler 1654 ## ---------------------
498 :     ## Note that "ldi" logical are treated as numeric
499 : maechler 1109 diagdiagprod <- function(x, y) {
500 : mmaechler 2183 n <- dimCheck(x,y)[1]
501 : maechler 1109 if(x@diag != "U") {
502 : maechler 1654 if(y@diag != "U") {
503 :     nx <- x@x * y@x
504 :     if(is.numeric(nx) && !is.numeric(x@x))
505 :     x <- as(x, "dMatrix")
506 :     x@x <- as.numeric(nx)
507 :     }
508 :     return(x)
509 : maechler 1109 } else ## x is unit diagonal
510 :     return(y)
511 :     }
512 :    
513 : maechler 1654 setMethod("%*%", signature(x = "diagonalMatrix", y = "diagonalMatrix"),
514 : maechler 1109 diagdiagprod, valueClass = "ddiMatrix")
515 :    
516 : maechler 1654 formals(diagdiagprod) <- alist(x=, y=x)
517 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "diagonalMatrix"),
518 : maechler 1109 diagdiagprod, valueClass = "ddiMatrix")
519 : maechler 1654 setMethod("tcrossprod", signature(x = "diagonalMatrix", y = "diagonalMatrix"),
520 : maechler 1109 diagdiagprod, valueClass = "ddiMatrix")
521 : maechler 1654 setMethod("crossprod", signature(x = "diagonalMatrix", y = "missing"),
522 :     diagdiagprod, valueClass = "ddiMatrix")
523 :     setMethod("tcrossprod", signature(x = "diagonalMatrix", y = "missing"),
524 :     diagdiagprod, valueClass = "ddiMatrix")
525 : maechler 1109
526 :    
527 :     diagmatprod <- function(x, y) {
528 : mmaechler 2183 ## x is diagonalMatrix
529 : maechler 1109 dx <- dim(x)
530 :     dy <- dim(y)
531 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
532 :     n <- dx[1]
533 :     as(if(x@diag == "U") y else x@x * y, "Matrix")
534 :     }
535 :     setMethod("%*%", signature(x = "diagonalMatrix", y = "matrix"),
536 : maechler 1654 diagmatprod)
537 : mmaechler 2183 ## sneaky .. :
538 : maechler 1109 formals(diagmatprod) <- alist(x=, y=NULL)
539 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "matrix"),
540 : maechler 1654 diagmatprod)
541 : maechler 1109
542 : mmaechler 2183 diagGeprod <- function(x, y) {
543 : maechler 1109 dx <- dim(x)
544 :     dy <- dim(y)
545 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
546 :     if(x@diag != "U")
547 :     y@x <- x@x * y@x
548 :     y
549 :     }
550 : mmaechler 2183 setMethod("%*%", signature(x= "diagonalMatrix", y= "dgeMatrix"), diagGeprod)
551 :     setMethod("%*%", signature(x= "diagonalMatrix", y= "lgeMatrix"), diagGeprod)
552 :     formals(diagGeprod) <- alist(x=, y=NULL)
553 : maechler 1109 setMethod("crossprod", signature(x = "diagonalMatrix", y = "dgeMatrix"),
554 : mmaechler 2183 diagGeprod, valueClass = "dgeMatrix")
555 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "lgeMatrix"),
556 :     diagGeprod)
557 : maechler 1109
558 : mmaechler 2183 matdiagprod <- function(x, y) {
559 :     dx <- dim(x)
560 :     dy <- dim(y)
561 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
562 :     Matrix(if(y@diag == "U") x else x * rep(y@x, each = dx[1]))
563 :     }
564 : maechler 1109 setMethod("%*%", signature(x = "matrix", y = "diagonalMatrix"),
565 : mmaechler 2183 matdiagprod)
566 :     formals(matdiagprod) <- alist(x=, y=NULL)
567 :     setMethod("tcrossprod", signature(x = "matrix", y = "diagonalMatrix"),
568 :     matdiagprod)
569 : maechler 1109
570 : mmaechler 2183 gediagprod <- function(x, y) {
571 :     dx <- dim(x)
572 :     dy <- dim(y)
573 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
574 :     if(y@diag == "N")
575 :     x@x <- x@x * rep(y@x, each = dx[1])
576 :     x
577 :     }
578 :     setMethod("%*%", signature(x= "dgeMatrix", y= "diagonalMatrix"), gediagprod)
579 :     setMethod("%*%", signature(x= "lgeMatrix", y= "diagonalMatrix"), gediagprod)
580 :     formals(gediagprod) <- alist(x=, y=NULL)
581 :     setMethod("tcrossprod", signature(x = "dgeMatrix", y = "diagonalMatrix"),
582 :     gediagprod)
583 :     setMethod("tcrossprod", signature(x = "lgeMatrix", y = "diagonalMatrix"),
584 :     gediagprod)
585 : maechler 1109
586 : maechler 1295 ## crossprod {more of these}
587 : maechler 1109
588 : maechler 1295 ## tcrossprod --- all are not yet there: do the dense ones here:
589 : maechler 1109
590 : mmaechler 2183 setMethod("%*%", signature(x = "diagonalMatrix", y = "denseMatrix"),
591 :     function(x, y) if(x@diag == "U") y else x %*% as(y, "generalMatrix"))
592 :     setMethod("%*%", signature(x = "denseMatrix", y = "diagonalMatrix"),
593 :     function(x, y) if(y@diag == "U") x else as(x, "generalMatrix") %*% y)
594 :    
595 :    
596 : maechler 1295 ## FIXME:
597 :     ## setMethod("tcrossprod", signature(x = "diagonalMatrix", y = "denseMatrix"),
598 :     ## function(x, y = NULL) {
599 :     ## })
600 : maechler 1109
601 : dmbates 2417 Cspdiagprod <- function(x, y) {
602 : dmbates 2458 dx <- dim(x <- .Call(Csparse_diagU2N, x))
603 : dmbates 2417 dy <- dim(y)
604 :     if(dx[2] != dy[1]) stop("non-matching dimensions")
605 :     ind <- rep.int(seq_len(dx[2]), x@p[-1] - x@p[-dx[2]-1L])
606 :     if(y@diag == "N")
607 :     x@x <- x@x * y@x[ind]
608 :     x
609 :     }
610 : maechler 1109
611 : dmbates 2417 diagCspprod <- function(x, y) {
612 :     dx <- dim(x)
613 : dmbates 2458 dy <- dim(y <- .Call(Csparse_diagU2N, y))
614 : dmbates 2417 if(dx[2] != dy[1]) stop("non-matching dimensions")
615 :     if(x@diag == "N")
616 :     y@x <- y@x * x@x[y@i + 1L]
617 :     y
618 :     }
619 :    
620 :     setMethod("crossprod", signature(x = "diagonalMatrix", y = "CsparseMatrix"),
621 :     function(x, y = NULL) diagCspprod(x, y))
622 :    
623 : maechler 1799 setMethod("crossprod", signature(x = "diagonalMatrix", y = "sparseMatrix"),
624 : dmbates 2417 function(x, y = NULL) diagCspprod(x, as(y, "CsparseMatrix")))
625 : maechler 1295
626 : dmbates 2417 ## Prefer calling diagCspprod to Cspdiagprod if going to transpose anyway
627 :     ## x'y == (y'x)'
628 :     setMethod("crossprod", signature(x = "CsparseMatrix", y = "diagonalMatrix"),
629 :     function(x, y = NULL) t(diagCspprod(y, x)))
630 :    
631 : maechler 1799 setMethod("crossprod", signature(x = "sparseMatrix", y = "diagonalMatrix"),
632 : dmbates 2417 function(x, y = NULL) t(diagCspprod(y, as(x, "Csparsematrix"))))
633 : maechler 1799
634 : dmbates 2417 setMethod("tcrossprod", signature(x = "diagonalMatrix", y = "CsparseMatrix"),
635 :     function(x, y = NULL) diagCspprod(x, t(y)))
636 :    
637 : maechler 1799 setMethod("tcrossprod", signature(x = "diagonalMatrix", y = "sparseMatrix"),
638 : dmbates 2417 function(x, y = NULL) diagCspprod(x, t(as(y, "CsparseMatrix"))))
639 : maechler 1799
640 : dmbates 2417 setMethod("tcrossprod", signature(x = "CsparseMatrix", y = "diagonalMatrix"),
641 :     function(x, y = NULL) Cspdiagprod(x, y))
642 :    
643 : maechler 1799 setMethod("tcrossprod", signature(x = "sparseMatrix", y = "diagonalMatrix"),
644 : dmbates 2417 function(x, y = NULL) Cspdiagprod(as(x, "CsparseMatrix"), y))
645 : mmaechler 2472
646 : dmbates 2417 setMethod("%*%", signature(x = "diagonalMatrix", y = "CsparseMatrix"),
647 :     function(x, y) diagCspprod(x, y))
648 : maechler 1799
649 :     setMethod("%*%", signature(x = "diagonalMatrix", y = "sparseMatrix"),
650 : dmbates 2417 function(x, y) diagCspprod(as(x, "CsparseMatrix"), y))
651 : mmaechler 2472
652 : mmaechler 2183 setMethod("%*%", signature(x = "sparseMatrix", y = "diagonalMatrix"),
653 : dmbates 2417 function(x, y) Cspdiagprod(as(x, "CsparseMatrix"), y))
654 :    
655 : maechler 1799 setMethod("%*%", signature(x = "CsparseMatrix", y = "diagonalMatrix"),
656 : dmbates 2417 function(x, y) Cspdiagprod(x, y))
657 :    
658 : maechler 1799 ## TODO: Write tests in ./tests/ which ensure that many "ops" with diagonal*
659 :     ## do indeed work by going through sparse (and *not* ddense)!
660 :    
661 :     setMethod("solve", signature(a = "diagonalMatrix", b = "missing"),
662 :     function(a, b, ...) {
663 :     a@x <- 1/ a@x
664 :     a@Dimnames <- a@Dimnames[2:1]
665 :     a
666 :     })
667 :    
668 :     solveDiag <- function(a, b, ...) {
669 :     if((n <- a@Dim[1]) != nrow(b))
670 :     stop("incompatible matrix dimensions")
671 :     ## trivially invert a 'in place' and multiply:
672 :     a@x <- 1/ a@x
673 :     a@Dimnames <- a@Dimnames[2:1]
674 :     a %*% b
675 :     }
676 :     setMethod("solve", signature(a = "diagonalMatrix", b = "matrix"),
677 :     solveDiag)
678 :     setMethod("solve", signature(a = "diagonalMatrix", b = "Matrix"),
679 :     solveDiag)
680 :    
681 : maechler 2106 ## Schur() ---> ./eigen.R
682 : maechler 1799
683 :    
684 :    
685 : mmaechler 2175 ###---------------- <Ops> (<Arith>, <Logic>, <Compare> ) ----------------------
686 : maechler 1295
687 : maechler 1655 ## Use function for several signatures, in order to evade
688 :     ## ambiguous dispatch for "ddi", since there's also Arith(ddense., ddense.)
689 : mmaechler 2175 diagOdiag <- function(e1,e2) {
690 :     ## result should also be diagonal _ if possible _
691 : maechler 1655 r <- callGeneric(.diag.x(e1), .diag.x(e2)) # error if not "compatible"
692 : mmaechler 2175 ## Check what happens with non-diagonals, i.e. (0 o 0), (FALSE o 0), ...:
693 :     r00 <- callGeneric(if(is.numeric(e1@x)) 0 else FALSE,
694 :     if(is.numeric(e2@x)) 0 else FALSE)
695 :     if(is0(r00)) { ## r00 == 0 or FALSE --- result *is* diagonal
696 :     if(is.numeric(r)) {
697 :     if(is.numeric(e2@x)) {
698 :     e2@x <- r; return(.diag.2N(e2)) }
699 :     if(!is.numeric(e1@x))
700 :     ## e.g. e1, e2 are logical;
701 :     e1 <- as(e1, "dMatrix")
702 :     }
703 :     else if(is.logical(r))
704 :     e1 <- as(e1, "lMatrix")
705 :     else stop("intermediate 'r' is of type", typeof(r))
706 :     e1@x <- r
707 :     .diag.2N(e1)
708 : maechler 1655 }
709 : mmaechler 2175 else { ## result not diagonal, but at least symmetric:
710 :     isNum <- (is.numeric(r) || is.numeric(r00))
711 :     isLog <- (is.logical(r) || is.logical(r00))
712 :    
713 : mmaechler 2363 Matrix.msg("exploding <diag> o <diag> into dense matrix")
714 : mmaechler 2175 d <- e1@Dim
715 :     n <- d[1]
716 :     stopifnot(length(r) == n)
717 :     xx <- as.vector(matrix(rbind(r, matrix(r00,n,n)), n,n))
718 :     newcl <-
719 :     paste(if(isNum) "d" else if(isLog) {
720 :     if(!any(is.na(r)) && !any(is.na(r00))) "n" else "l"
721 :     } else stop("not yet implemented .. please report")
722 :     ,
723 :     "syMatrix", sep='')
724 :    
725 :     new(newcl, Dim = e1@Dim, Dimnames = e1@Dimnames, x = xx)
726 :     }
727 : maechler 1655 }
728 :    
729 : mmaechler 2175 ### This would be *the* way, but we get tons of "ambiguous method dispatch"
730 : mmaechler 2185 ## we use this hack instead of signature x = "diagonalMatrix" :
731 :     diCls <- names(getClass("diagonalMatrix")@subclasses)
732 : mmaechler 2175 if(FALSE) {
733 : maechler 1655 setMethod("Ops", signature(e1 = "diagonalMatrix", e2 = "diagonalMatrix"),
734 :     diagOdiag)
735 : mmaechler 2175 } else { ## These are just for method disambiguation:
736 :     for(c1 in diCls)
737 :     for(c2 in diCls)
738 :     setMethod("Ops", signature(e1 = c1, e2 = c2), diagOdiag)
739 :     }
740 : maechler 1655
741 : maechler 1845 ## FIXME: diagonal o triangular |--> triangular
742 :     ## ----- diagonal o symmetric |--> symmetric
743 :     ## {also when other is sparse: do these "here" --
744 :     ## before conversion to sparse, since that loses "diagonality"}
745 :    
746 : maechler 1655 ## For almost everything else, diag* shall be treated "as sparse" :
747 : maechler 1295 ## These are cheap implementations via coercion
748 :    
749 : maechler 2144 ## For disambiguation --- define this for "sparseMatrix" , then for "ANY";
750 :     ## and because we can save an .M.kind() call, we use this explicit
751 :     ## "hack" for all diagonalMatrix *subclasses* instead of just "diagonalMatrix" :
752 :     ##
753 :     ## ddi*:
754 :     setMethod("Ops", signature(e1 = "ddiMatrix", e2 = "sparseMatrix"),
755 : mmaechler 2175 function(e1,e2) callGeneric(diag2Tsmart(e1,e2, "d"), e2))
756 : maechler 2144 setMethod("Ops", signature(e1 = "sparseMatrix", e2 = "ddiMatrix"),
757 : mmaechler 2175 function(e1,e2) callGeneric(e1, diag2Tsmart(e2,e1, "d")))
758 : maechler 2144 ## ldi*
759 :     setMethod("Ops", signature(e1 = "ldiMatrix", e2 = "sparseMatrix"),
760 : mmaechler 2175 function(e1,e2) callGeneric(diag2Tsmart(e1,e2, "l"), e2))
761 : maechler 2144 setMethod("Ops", signature(e1 = "sparseMatrix", e2 = "ldiMatrix"),
762 : mmaechler 2175 function(e1,e2) callGeneric(e1, diag2Tsmart(e2,e1, "l")))
763 : maechler 1654
764 : mmaechler 2175 ## Ops: Arith --> numeric : "dMatrix"
765 :     ## Compare --> logical
766 :     ## Logic --> logical: "lMatrix"
767 :    
768 : maechler 2144 ## other = "numeric" : stay diagonal if possible
769 : mmaechler 2175 ## ddi*: Arith: result numeric, potentially ddiMatrix
770 :     setMethod("Arith", signature(e1 = "ddiMatrix", e2 = "numeric"),
771 : maechler 2144 function(e1,e2) {
772 : mmaechler 2203 n <- e1@Dim[1]; nsq <- n^2
773 : maechler 2144 f0 <- callGeneric(0, e2)
774 :     if(all(is0(f0))) { # remain diagonal
775 : maechler 2157 L1 <- (le <- length(e2)) == 1L
776 :     if(!L1 && le != nsq) e2 <- rep(e2, length.out = nsq)
777 :     if(e1@diag == "U" && any((r <- callGeneric(1, e2)) != 1)) {
778 : maechler 2144 e1@diag <- "N"
779 : maechler 2157 if(L1) r <- rep.int(r, n)
780 :     } else
781 : maechler 2144 r <- callGeneric(e1@x, e2)
782 : mmaechler 2197 e1@x <- if(L1) r else r[1L + (n+1L)*(0:(n-1L))]
783 : maechler 2144 return(e1)
784 :     }
785 :     callGeneric(diag2tT.u(e1,e2, "d"), e2)
786 :     })
787 : maechler 1655
788 : mmaechler 2175 setMethod("Arith", signature(e1 = "numeric", e2 = "ddiMatrix"),
789 : maechler 2144 function(e1,e2) {
790 : mmaechler 2203 n <- e2@Dim[1]; nsq <- n^2
791 : maechler 2144 f0 <- callGeneric(e1, 0)
792 :     if(all(is0(f0))) { # remain diagonal
793 : maechler 2157 L1 <- (le <- length(e1)) == 1L
794 :     if(!L1 && le != nsq) e1 <- rep(e1, length.out = nsq)
795 :     if(e2@diag == "U" && any((r <- callGeneric(e1, 1)) != 1)) {
796 : maechler 2144 e2@diag <- "N"
797 : maechler 2157 if(L1) r <- rep.int(r, n)
798 :     } else
799 : maechler 2144 r <- callGeneric(e1, e2@x)
800 : mmaechler 2197 e2@x <- if(L1) r else r[1L + (n+1L)*(0:(n-1L))]
801 : maechler 2144 return(e2)
802 :     }
803 :     callGeneric(e1, diag2tT.u(e2,e1, "d"))
804 :     })
805 : mmaechler 2175
806 :     ## ldi* Arith --> result numeric, potentially ddiMatrix
807 :     setMethod("Arith", signature(e1 = "ldiMatrix", e2 = "numeric"),
808 :     function(e1,e2) {
809 : mmaechler 2203 n <- e1@Dim[1]; nsq <- n^2
810 : mmaechler 2175 f0 <- callGeneric(0, e2)
811 :     if(all(is0(f0))) { # remain diagonal
812 :     L1 <- (le <- length(e2)) == 1L
813 :     if(!L1 && le != nsq) e2 <- rep(e2, length.out = nsq)
814 :     if(e1@diag == "U" && any((r <- callGeneric(1, e2)) != 1)) {
815 :     e1@diag <- "N"
816 :     if(L1) r <- rep.int(r, n)
817 :     } else
818 :     r <- callGeneric(e1@x, e2)
819 :     e1 <- copyClass(e1, "ddiMatrix", c("diag", "Dim", "Dimnames"))
820 : mmaechler 2197 e1@x <- if(L1) r else r[1L + (n+1L)*(0:(n-1L))]
821 : mmaechler 2175 return(e1)
822 :     }
823 :     callGeneric(diag2tT.u(e1,e2, "d"), e2)
824 :     })
825 :    
826 :     setMethod("Arith", signature(e1 = "numeric", e2 = "ldiMatrix"),
827 :     function(e1,e2) {
828 : mmaechler 2203 n <- e2@Dim[1]; nsq <- n^2
829 : mmaechler 2175 f0 <- callGeneric(e1, 0)
830 :     if(all(is0(f0))) { # remain diagonal
831 :     L1 <- (le <- length(e1)) == 1L
832 :     if(!L1 && le != nsq) e1 <- rep(e1, length.out = nsq)
833 :     if(e2@diag == "U" && any((r <- callGeneric(e1, 1)) != 1)) {
834 :     e2@diag <- "N"
835 :     if(L1) r <- rep.int(r, n)
836 :     } else
837 :     r <- callGeneric(e1, e2@x)
838 :     e2 <- copyClass(e2, "ddiMatrix", c("diag", "Dim", "Dimnames"))
839 : mmaechler 2197 e2@x <- if(L1) r else r[1L + (n+1L)*(0:(n-1L))]
840 : mmaechler 2175 return(e2)
841 :     }
842 :     callGeneric(e1, diag2tT.u(e2,e1, "d"))
843 :     })
844 :    
845 :     ## ddi*: for "Ops" without Arith --> result logical, potentially ldi
846 :     setMethod("Ops", signature(e1 = "ddiMatrix", e2 = "numeric"),
847 :     function(e1,e2) {
848 : mmaechler 2203 n <- e1@Dim[1]; nsq <- n^2
849 : mmaechler 2175 f0 <- callGeneric(0, e2)
850 :     if(all(is0(f0))) { # remain diagonal
851 :     L1 <- (le <- length(e2)) == 1L
852 :     if(!L1 && le != nsq) e2 <- rep(e2, length.out = nsq)
853 :     if(e1@diag == "U" && any((r <- callGeneric(1, e2)) != 1)) {
854 :     e1@diag <- "N"
855 :     if(L1) r <- rep.int(r, n)
856 :     } else
857 :     r <- callGeneric(e1@x, e2)
858 :     e1 <- copyClass(e1, "ldiMatrix", c("diag", "Dim", "Dimnames"))
859 : mmaechler 2197 e1@x <- if(L1) r else r[1L + (n+1L)*(0:(n-1L))]
860 : mmaechler 2175 return(e1)
861 :     }
862 :     callGeneric(diag2tT.u(e1,e2, "l"), e2)
863 :     })
864 :    
865 :     setMethod("Ops", signature(e1 = "numeric", e2 = "ddiMatrix"),
866 :     function(e1,e2) {
867 : mmaechler 2203 n <- e2@Dim[1]; nsq <- n^2
868 : mmaechler 2175 f0 <- callGeneric(e1, 0)
869 :     if(all(is0(f0))) { # remain diagonal
870 :     L1 <- (le <- length(e1)) == 1L
871 :     if(!L1 && le != nsq) e1 <- rep(e1, length.out = nsq)
872 :     if(e2@diag == "U" && any((r <- callGeneric(e1, 1)) != 1)) {
873 :     e2@diag <- "N"
874 :     if(L1) r <- rep.int(r, n)
875 :     } else
876 :     r <- callGeneric(e1, e2@x)
877 :     e2 <- copyClass(e2, "ldiMatrix", c("diag", "Dim", "Dimnames"))
878 : mmaechler 2197 e2@x <- if(L1) r else r[1L + (n+1L)*(0:(n-1L))]
879 : mmaechler 2175 return(e2)
880 :     }
881 :     callGeneric(e1, diag2tT.u(e2,e1, "l"))
882 :     })
883 :    
884 :     ## ldi*: for "Ops" without Arith --> result logical, potentially ldi
885 : maechler 2144 setMethod("Ops", signature(e1 = "ldiMatrix", e2 = "numeric"),
886 :     function(e1,e2) {
887 : mmaechler 2203 n <- e1@Dim[1]; nsq <- n^2
888 : maechler 2144 f0 <- callGeneric(FALSE, e2)
889 :     if(all(is0(f0))) { # remain diagonal
890 : maechler 2157 L1 <- (le <- length(e2)) == 1L
891 :     if(!L1 && le != nsq) e2 <- rep(e2, length.out = nsq)
892 :     if(e1@diag == "U" && any((r <- callGeneric(TRUE, e2)) != 1)) {
893 : maechler 2144 e1@diag <- "N"
894 : maechler 2157 if(L1) r <- rep.int(r, n)
895 :     } else
896 : maechler 2144 r <- callGeneric(e1@x, e2)
897 : mmaechler 2197 e1@x <- if(L1) r else r[1L + (n+1L)*(0:(n-1L))]
898 : maechler 2144 return(e1)
899 :     }
900 :     callGeneric(diag2tT.u(e1,e2, "l"), e2)
901 :     })
902 : maechler 1655
903 : maechler 2144 setMethod("Ops", signature(e1 = "numeric", e2 = "ldiMatrix"),
904 :     function(e1,e2) {
905 : mmaechler 2203 n <- e2@Dim[1]; nsq <- n^2
906 : maechler 2144 f0 <- callGeneric(e1, FALSE)
907 :     if(all(is0(f0))) { # remain diagonal
908 : maechler 2157 L1 <- (le <- length(e1)) == 1L
909 :     if(!L1 && le != nsq) e1 <- rep(e1, length.out = nsq)
910 :     if(e2@diag == "U" && any((r <- callGeneric(e1, TRUE)) != 1)) {
911 : maechler 2144 e2@diag <- "N"
912 : maechler 2157 if(L1) r <- rep.int(r, n)
913 :     } else
914 : maechler 2144 r <- callGeneric(e1, e2@x)
915 : mmaechler 2197 e2@x <- if(L1) r else r[1L + (n+1L)*(0:(n-1L))]
916 : maechler 2144 return(e2)
917 :     }
918 :     callGeneric(e1, diag2tT.u(e2,e1, "l"))
919 :     })
920 :    
921 :    
922 :    
923 :     ## Not {"sparseMatrix", "numeric} : {"denseMatrix", "matrix", ... }
924 : mmaechler 2196 for(other in c("ANY", "Matrix", "dMatrix")) {
925 :     ## ddi*:
926 :     setMethod("Ops", signature(e1 = "ddiMatrix", e2 = other),
927 :     function(e1,e2) callGeneric(diag2tT.u(e1,e2, "d"), e2))
928 :     setMethod("Ops", signature(e1 = other, e2 = "ddiMatrix"),
929 :     function(e1,e2) callGeneric(e1, diag2tT.u(e2,e1, "d")))
930 :     ## ldi*:
931 :     setMethod("Ops", signature(e1 = "ldiMatrix", e2 = other),
932 :     function(e1,e2) callGeneric(diag2tT.u(e1,e2, "l"), e2))
933 :     setMethod("Ops", signature(e1 = other, e2 = "ldiMatrix"),
934 :     function(e1,e2) callGeneric(e1, diag2tT.u(e2,e1, "l")))
935 :     }
936 : mmaechler 2331
937 :     ## Direct subclasses of "denseMatrix": currently ddenseMatrix, ldense... :
938 :     dense.subCl <- local({ dM.scl <- getClass("denseMatrix")@subclasses
939 :     names(dM.scl)[sapply(dM.scl, slot, "distance") == 1] })
940 : mmaechler 2268 for(DI in diCls) {
941 : mmaechler 2331 for(c2 in c(dense.subCl, "Matrix")) {
942 : mmaechler 2268 for(Fun in c("*", "^", "&")) {
943 :     setMethod(Fun, signature(e1 = DI, e2 = c2),
944 :     function(e1,e2) callGeneric(e1, Diagonal(x = diag(e2))))
945 :     setMethod(Fun, signature(e1 = c2, e2 = DI),
946 :     function(e1,e2) callGeneric(Diagonal(x = diag(e1)), e2))
947 :     }
948 :     ## NB: This arguably implicitly uses 0/0 :== 0 to keep diagonality
949 :     for(Fun in c("%%", "%/%", "/")) {
950 :     setMethod(Fun, signature(e1 = DI, e2 = c2),
951 :     function(e1,e2) callGeneric(e1, Diagonal(x = diag(e2))))
952 :     }
953 : mmaechler 2175 }
954 :     }
955 : maechler 2144
956 :    
957 : mmaechler 2175 ### "Summary" : "max" "min" "range" "prod" "sum" "any" "all"
958 : mmaechler 2345 ### ---------- the last 4: separately here
959 : mmaechler 2175 for(cl in diCls) {
960 :     setMethod("any", cl,
961 :     function (x, ..., na.rm) {
962 :     if(any(x@Dim == 0)) FALSE
963 :     else if(x@diag == "U") TRUE else any(x@x, ..., na.rm = na.rm)
964 :     })
965 : mmaechler 2341 setMethod("all", cl, function (x, ..., na.rm) {
966 :     n <- x@Dim[1]
967 :     if(n >= 2) FALSE
968 :     else if(n == 0 || x@diag == "U") TRUE
969 :     else all(x@x, ..., na.rm = na.rm)
970 :     })
971 :     setMethod("prod", cl, function (x, ..., na.rm) {
972 :     n <- x@Dim[1]
973 :     if(n >= 2) 0
974 :     else if(n == 0 || x@diag == "U") 1
975 :     else ## n == 1, diag = "N" :
976 :     prod(x@x, ..., na.rm = na.rm)
977 :     })
978 : mmaechler 2175
979 :     setMethod("sum", cl,
980 :     function(x, ..., na.rm) {
981 :     r <- sum(x@x, ..., na.rm = na.rm)# double or integer, correctly
982 :     if(x@diag == "U" && !is.na(r)) r + x@Dim[1] else r
983 :     })
984 :     }
985 :    
986 :     ## The remaining ones are max, min, range :
987 :    
988 :     setMethod("Summary", "ddiMatrix",
989 :     function(x, ..., na.rm) {
990 :     if(any(x@Dim == 0)) callGeneric(numeric(0), ..., na.rm=na.rm)
991 :     else if(x@diag == "U")
992 :     callGeneric(x@x, 0, 1, ..., na.rm=na.rm)
993 :     else callGeneric(x@x, 0, ..., na.rm=na.rm)
994 :     })
995 :     setMethod("Summary", "ldiMatrix",
996 :     function(x, ..., na.rm) {
997 :     if(any(x@Dim == 0)) callGeneric(logical(0), ..., na.rm=na.rm)
998 :     else if(x@diag == "U")
999 :     callGeneric(x@x, FALSE, TRUE, ..., na.rm=na.rm)
1000 :     else callGeneric(x@x, FALSE, ..., na.rm=na.rm)
1001 :     })
1002 :    
1003 :    
1004 :    
1005 : maechler 1109 ## similar to prTriang() in ./Auxiliaries.R :
1006 :     prDiag <-
1007 :     function(x, digits = getOption("digits"), justify = "none", right = TRUE)
1008 :     {
1009 :     cf <- array(".", dim = x@Dim, dimnames = x@Dimnames)
1010 :     cf[row(cf) == col(cf)] <-
1011 :     sapply(diag(x), format, digits = digits, justify = justify)
1012 :     print(cf, quote = FALSE, right = right)
1013 :     invisible(x)
1014 :     }
1015 :    
1016 : mmaechler 2237 ## somewhat consistent with "print" for sparseMatrix :
1017 :     setMethod("print", signature(x = "diagonalMatrix"), prDiag)
1018 :    
1019 : maechler 1109 setMethod("show", signature(object = "diagonalMatrix"),
1020 : maechler 1592 function(object) {
1021 :     d <- dim(object)
1022 :     cl <- class(object)
1023 : mmaechler 2203 cat(sprintf('%d x %d diagonal matrix of class "%s"',
1024 : maechler 1592 d[1], d[2], cl))
1025 : mmaechler 2203 if(d[1] < 50) {
1026 :     cat("\n")
1027 :     prDiag(object)
1028 :     } else {
1029 :     cat(", with diagonal entries\n")
1030 :     show(diag(object))
1031 :     invisible(object)
1032 :     }
1033 : maechler 1592 })

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