# SCM Repository

[matrix] Diff of /pkg/R/Matrix.R
 [matrix] / pkg / R / Matrix.R

# Diff of /pkg/R/Matrix.R

revision 1290, Thu Jun 8 09:30:21 2006 UTC revision 2255, Sat Aug 30 07:20:33 2008 UTC
# Line 1  Line 1
1  #### Toplevel ``virtual'' class "Matrix"  #### Toplevel ``virtual'' class "Matrix"
2
3
4    ### Virtual coercions -- via smart "helpers" (-> ./Auxiliaries.R)
5
6    setAs("Matrix", "sparseMatrix", function(from) as(from, "CsparseMatrix"))
7    setAs("Matrix", "CsparseMatrix", function(from) as_Csparse(from))
8    setAs("Matrix", "denseMatrix",  function(from) as_dense(from))
9
10    ## Maybe TODO:
11    ## setAs("Matrix", "nMatrix", function(from) ....)
12
13    ## Most of these work; this is a last resort:
14    setAs(from = "Matrix", to = "matrix", # do *not* call base::as.matrix() here:
15          function(from) .bail.out.2("coerce", class(from), class(to)))
16    setAs(from = "matrix", to = "Matrix", function(from) Matrix(from))
17
18  ## ## probably not needed eventually:  ## ## probably not needed eventually:
19  ## setAs(from = "ddenseMatrix", to = "matrix",  ## setAs(from = "ddenseMatrix", to = "matrix",
20  ##       function(from) {  ##       function(from) {
# Line 12  Line 27
27  ## for 'Matrix' objects, as.array() should be equivalent:  ## for 'Matrix' objects, as.array() should be equivalent:
28  setMethod("as.array",  signature(x = "Matrix"), function(x) as(x, "matrix"))  setMethod("as.array",  signature(x = "Matrix"), function(x) as(x, "matrix"))
29
30    ## head and tail apply to all Matrix objects for which subscripting is allowed:
32    setMethod("tail", signature(x = "Matrix"), utils::tail.matrix)
33
34    setMethod("drop", signature(x = "Matrix"),
35              function(x) if(all(dim(x) != 1)) x else drop(as(x, "matrix")))
36
37  ## slow "fall back" method {subclasses should have faster ones}:  ## slow "fall back" method {subclasses should have faster ones}:
38  setMethod("as.vector", signature(x = "Matrix", mode = "missing"),  setMethod("as.vector", signature(x = "Matrix", mode = "missing"),
39            function(x) as.vector(as(x, "matrix")))            function(x, mode) as.vector(as(x, "matrix"), mode))
40
41    ## mainly need these for "dMatrix" or "lMatrix" respectively, but why not general:
42    setMethod("as.numeric", signature(x = "Matrix"),
43              function(x, ...) as.numeric(as.vector(x)))
44    setMethod("as.logical", signature(x = "Matrix"),
45              function(x, ...) as.logical(as.vector(x)))
46
47    setMethod("mean", signature(x = "Matrix"),
48              function(x, trim = 0, ...) ## TODO: provide 'sparseMatrix method
49              if(is0(trim)) sum(x, ...) / length(x)
50              else mean(as.numeric(x), ...))
51
52    setMethod("cov2cor", signature(V = "Matrix"),
53              function(V) { ## was as(cov2cor(as(V, "matrix")), "dpoMatrix"))
54                  r <- V
55                  p <- (d <- dim(V))[1]
56                  if(p != d[2]) stop("'V' is not a square matrix")
57                  Is <- sqrt(1/diag(V)) # diag( 1/sigma_i )
58                  if(any(!is.finite(Is)))
59                      warning("diag(.) had 0 or NA entries; non-finite result is doubtful")
60                  Is <- Diagonal(x = Is)
61                  r <- Is %*% V %*% Is
62                  r[cbind(1L:p,1L:p)] <- 1 # exact in diagonal
63                  as(forceSymmetric(r), "dpoMatrix")
64              })
65
66  ## Note that isSymmetric is *not* exported  ## "base" has an isSymmetric() S3-generic since R 2.3.0
## but that "base" has an isSymmetric() S3-generic since R 2.3.0
67  setMethod("isSymmetric", signature(object = "symmetricMatrix"),  setMethod("isSymmetric", signature(object = "symmetricMatrix"),
68            function(object,tol) TRUE)            function(object, ...) TRUE)
69  setMethod("isSymmetric", signature(object = "triangularMatrix"),  setMethod("isSymmetric", signature(object = "triangularMatrix"),
70            ## TRUE iff diagonal:            ## TRUE iff diagonal:
71            function(object,tol) isDiagonal(object))            function(object, ...) isDiagonal(object))

if(paste(R.version\$major, R.version\$minor, sep=".") < "2.3")
## need a "matrix" method as in R 2.3 and later
setMethod("isSymmetric", signature(object = "matrix"),
function(object, tol = 100*.Machine\$double.eps, ...)
{
## pretest: is it square?
d <- dim(object)
if(d[1] != d[2]) return(FALSE)
## for `broken' all.equal in R <= 2.2.x:
dn <- dimnames(object)
if(!identical(dn[1], dn[2])) return(FALSE)
test <-
if(is.complex(object))
all.equal.numeric(object, Conj(t(object)), tol = tol, ...)
else              # numeric, character, ..
all.equal(object, t(object), tol = tol, ...)
isTRUE(test)
})

setMethod("isTriangular", signature(object = "triangularMatrix"),
function(object, ...) TRUE)
72
73  setMethod("isTriangular", signature(object = "matrix"), isTriMat)  setMethod("isTriangular", signature(object = "matrix"), isTriMat)
74
75  setMethod("isDiagonal", signature(object = "matrix"), .is.diagonal)  setMethod("isDiagonal", signature(object = "matrix"), .is.diagonal)
76
77    ## The "catch all" methods -- far from optimal:
78    setMethod("symmpart", signature(x = "Matrix"),
79              function(x) as((x + t(x))/2, "symmetricMatrix"))
80    setMethod("skewpart", signature(x = "Matrix"),
81              function(x) (x - t(x))/2)
82
83    ## FIXME: do this (similarly as for "ddense.." in C
84    setMethod("symmpart", signature(x = "matrix"), function(x) (x + t(x))/2)
85    setMethod("skewpart", signature(x = "matrix"), function(x) (x - t(x))/2)
86
87
88
89
90  setMethod("dim", signature(x = "Matrix"),  setMethod("dim", signature(x = "Matrix"),
91            function(x) x@Dim, valueClass = "integer")            function(x) x@Dim, valueClass = "integer")
92
93    setMethod("length", "Matrix", function(x) prod(dim(x)))
94
95  setMethod("dimnames", signature(x = "Matrix"), function(x) x@Dimnames)  setMethod("dimnames", signature(x = "Matrix"), function(x) x@Dimnames)
96
97
98  ## not exported but used more than once for "dimnames<-" method :  ## not exported but used more than once for "dimnames<-" method :
99  ## -- or do only once for all "Matrix" classes ??  ## -- or do only once for all "Matrix" classes ??
100  dimnamesGets <- function (x, value) {  dimnamesGets <- function (x, value) {
# Line 72  Line 110
110  setMethod("dimnames<-", signature(x = "Matrix", value = "list"),  setMethod("dimnames<-", signature(x = "Matrix", value = "list"),
111            dimnamesGets)            dimnamesGets)
112
113    setMethod("dimnames<-", signature(x = "Matrix", value = "NULL"),
114              function(x, value) {
115                  message("dimnames(.) <- NULL:  translated to \n",
116                          "dimnames(.) <- list(NULL,NULL)  <==>  unname(.)")
117                  x@Dimnames <- list(NULL,NULL)
118                  x
119              })
120
121  setMethod("unname", signature("Matrix", force="missing"),  setMethod("unname", signature("Matrix", force="missing"),
122            function(obj) { obj@Dimnames <- list(NULL,NULL); obj})            function(obj) { obj@Dimnames <- list(NULL,NULL); obj})
123
124  Matrix <-  setMethod("all", signature(x = "Matrix"),
125      function (data = NA, nrow = 1, ncol = 1, byrow = FALSE, dimnames = NULL,            function(x, ..., na.rm)
126                sparse = NULL)            callGeneric(as(x, "lMatrix"), ..., na.rm=na.rm))
127
128    setMethod("any", signature(x = "Matrix"),
129              function(x, ..., na.rm)
130              callGeneric(as(x, "lMatrix"), ..., na.rm=na.rm))
131
132    ## NOTE:  "&" and "|"  are now in group "Logic" c "Ops" --> ./Ops.R
133    ##        "!" is in ./not.R
134
135
136    Matrix <- function (data = NA, nrow = 1, ncol = 1, byrow = FALSE,
137                        dimnames = NULL, sparse = NULL, forceCheck = FALSE)
138  {  {
139      sparseDefault <- function(m)      sparseDefault <- function(m) prod(dim(m)) > 2*sum(isN0(as(m, "matrix")))
prod(dim(m)) > 2*sum(as(m, "matrix") != 0)
140
141      i.M <- is(data, "Matrix")      i.M <- is(data, "Matrix")
142      if(is.null(sparse) && (i.M || is(data, "matrix")))      if(!i.M && inherits(data, "table")) # special treatment
143            class(data) <- "matrix" # "matrix" first for S4 dispatch
144        if(is.null(sparse1 <- sparse) && (i.M || is(data, "matrix")))
145          sparse <- sparseDefault(data)          sparse <- sparseDefault(data)
146        sM <- FALSE
147        doDN <- TRUE
148      if (i.M) {      if (i.M) {
149            if(!missing(nrow) || !missing(ncol)|| !missing(byrow))
150                warning("'nrow', 'ncol', etc, are disregarded when 'data' is \"Matrix\" already")
151          sM <- is(data,"sparseMatrix")          sM <- is(data,"sparseMatrix")
152          if((sparse && sM) || (!sparse && !sM))          if(!forceCheck && ((sparse && sM) || (!sparse && !sM)))
153              return(data)              return(data)
154          ## else : convert  dense <-> sparse -> at end          ## else : convert  dense <-> sparse -> at end
155      }      }
# Line 97  Line 158
158              nrow <- ceiling(length(data)/ncol)              nrow <- ceiling(length(data)/ncol)
159          else if (missing(ncol))          else if (missing(ncol))
160              ncol <- ceiling(length(data)/nrow)              ncol <- ceiling(length(data)/nrow)
161            if(length(data) == 1 && is0(data) && !identical(sparse, FALSE)) {
162                ## Matrix(0, ...) : always sparse unless "sparse = FALSE":
163                if(is.null(sparse)) sparse1 <- sparse <- TRUE
164                i.M <- sM <- TRUE
165                isSym <- nrow == ncol
166                ## will be sparse: do NOT construct full matrix!
167                data <- new(paste(if(is.numeric(data)) "d" else
168                                  if(is.logical(data)) "l" else
169                                  stop("invalid 'data'"),
170                                  if(isSym) "s" else "g", "CMatrix", sep=''),
171                            p = rep.int(0L, ncol+1L),
172                            Dim = as.integer(c(nrow,ncol)),
173                            Dimnames = if(is.null(dimnames)) list(NULL,NULL)
174                            else dimnames)
175            } else { ## normal case - using .Internal() to avoid more copying
176                if(getRversion() >= "2.7.0")
177                    data <- .Internal(matrix(data, nrow, ncol, byrow, dimnames))
178                else {
179          data <- .Internal(matrix(data, nrow, ncol, byrow))          data <- .Internal(matrix(data, nrow, ncol, byrow))
180                    dimnames(data) <- dimnames
181                }
182          if(is.null(sparse))          if(is.null(sparse))
183              sparse <- sparseDefault(data)              sparse <- sparseDefault(data)
184          dimnames(data) <- dimnames          }
185      } else if (!is.null(dimnames))          doDN <- FALSE
186          dimnames(data) <- dimnames      } else if(!missing(nrow) || !missing(ncol)|| !missing(byrow))
187            warning("'nrow', 'ncol', etc, are disregarded for matrix 'data'")
188
189      ## 'data' is now a "matrix" or "Matrix"      ## 'data' is now a "matrix" or "Matrix"
190        if (doDN && !is.null(dimnames))
191            dimnames(data) <- dimnames
192
193      ## check for symmetric / triangular / diagonal :      ## check for symmetric / triangular / diagonal :
194      isSym <- isSymmetric(data)      isSym <- isSymmetric(data)
# Line 112  Line 196
196          isTri <- isTriangular(data)          isTri <- isTriangular(data)
197      isDiag <- isSym # cannot be diagonal if it isn't symmetric      isDiag <- isSym # cannot be diagonal if it isn't symmetric
198      if(isDiag)      if(isDiag)
199          isDiag <- isDiagonal(data)          isDiag <- !isTRUE(sparse1) && isDiagonal(data)
200
201  ### TODO: Compare with as.Matrix() and its tests in ./dgeMatrix.R      ## try to coerce ``via'' virtual classes
202        if(isDiag) { ## diagonal is preferred to sparse !
203      ## Find proper matrix class 'cl'          data <- as(data, "diagonalMatrix")
204      cl <-          isSym <- FALSE
205          if(isDiag)      } else if(sparse && !sM)
206              "diagonalMatrix" # -> will automatically check for type          data <- as(data, "sparseMatrix")
207          else {      else if(!sparse) {
208              ## consider it's type          if(i.M) { ## data is 'Matrix'
209              ctype <-              if(!is(data, "denseMatrix"))
210                  if(is(data,"Matrix")) class(data)                  data <- as(data, "denseMatrix")
211                  else {          } else { ## data is "matrix" (and result "dense" -> go via "general"
212                      if("complex" == (ctype <- typeof(data)))              ctype <- typeof(data)
213                          "z" else ctype              if (ctype == "complex")
}
ctype <- substr(ctype, 1,1) # "d", "l", "i" or "z"
if(ctype == "z")
214                  stop("complex matrices not yet implemented in Matrix package")                  stop("complex matrices not yet implemented in Matrix package")
215              if(ctype == "i") {              if (ctype == "integer") ## integer Matrices not yet implemented
216                  warning("integer matrices not yet implemented in 'Matrix'; ",                  storage.mode(data) <- "double"
217                          "using 'double' ones'")              data <- new(paste(.M.kind(data), "geMatrix", sep=''),
218                  ctype <- "d"                          Dim = dim(data),
219              }                          Dimnames = .M.DN(data),
220              paste(ctype,                          x = c(data))
221                    if(sparse) {          }
if(isSym) "sCMatrix" else
if(isTri) "tCMatrix" else "gCMatrix"
} else { ## dense
if(isSym) "syMatrix" else
if(isTri) "trMatrix" else "geMatrix"
}, sep="")
222          }          }
223
224      ## Now coerce and return      if(isTri && !is(data, "triangularMatrix")) {
225      as(data, cl)          data <- if(attr(isTri,"kind") == "L") tril(data) else triu(data)
226                                            #was as(data, "triangularMatrix")
227        } else if(isSym && !is(data, "symmetricMatrix"))
228            data <- forceSymmetric(data) #was as(data, "symmetricMatrix")
229
230        data
231  }  }
232
233  ## Methods for operations where one argument is numeric  ## Methods for operations where one argument is numeric
# Line 157  Line 237
237
238  setMethod("%*%", signature(x = "Matrix", y = "numeric"),  setMethod("%*%", signature(x = "Matrix", y = "numeric"),
239            function(x, y) callGeneric(x, as.matrix(y)))            function(x, y) callGeneric(x, as.matrix(y)))

240  setMethod("%*%", signature(x = "numeric", y = "Matrix"),  setMethod("%*%", signature(x = "numeric", y = "Matrix"),
241            function(x, y) callGeneric(rbind(x), y))            function(x, y) callGeneric(matrix(x, nrow = 1, byrow=TRUE), y))
242
243    setMethod("%*%", signature(x = "Matrix", y = "matrix"),
244              function(x, y) callGeneric(x, Matrix(y)))
245    setMethod("%*%", signature(x = "matrix", y = "Matrix"),
246              function(x, y) callGeneric(Matrix(x), y))
247
248
249  setMethod("crossprod", signature(x = "Matrix", y = "numeric"),  setMethod("crossprod", signature(x = "Matrix", y = "numeric"),
250            function(x, y = NULL) callGeneric(x, as.matrix(y)))            function(x, y = NULL) callGeneric(x, as.matrix(y)))

251  setMethod("crossprod", signature(x = "numeric", y = "Matrix"),  setMethod("crossprod", signature(x = "numeric", y = "Matrix"),
252            function(x, y = NULL)  callGeneric(rbind(x), y))            function(x, y = NULL)  callGeneric(as.matrix(x), y))
253
254    setMethod("crossprod", signature(x = "Matrix", y = "matrix"),
255              function(x, y = NULL) callGeneric(x, Matrix(y)))
256    setMethod("crossprod", signature(x = "matrix", y = "Matrix"),
257              function(x, y = NULL) callGeneric(Matrix(x), y))
258
259    ## The as.matrix() promotion seems illogical to MM,
260    ## but is according to help(tcrossprod, package = "base") :
261    setMethod("tcrossprod", signature(x = "Matrix", y = "numeric"),
262              function(x, y = NULL) callGeneric(x, as.matrix(y)))
263    setMethod("tcrossprod", signature(x = "numeric", y = "Matrix"),
264              function(x, y = NULL)  callGeneric(as.matrix(x), y))
265    setMethod("tcrossprod", signature(x = "Matrix", y = "matrix"),
266              function(x, y = NULL) callGeneric(x, Matrix(y)))
267    setMethod("tcrossprod", signature(x = "matrix", y = "Matrix"),
268              function(x, y = NULL) callGeneric(Matrix(x), y))
269
270    ## maybe not 100% optimal, but elegant:
271    setMethod("solve", signature(a = "Matrix", b = "missing"),
272              function(a, b, ...) solve(a, Diagonal(nrow(a))))
273
274  setMethod("solve", signature(a = "Matrix", b = "numeric"),  setMethod("solve", signature(a = "Matrix", b = "numeric"),
275            function(a, b, ...) callGeneric(a, as.matrix(b)))            function(a, b, ...) callGeneric(a, Matrix(b)))
276    setMethod("solve", signature(a = "Matrix", b = "matrix"),
277              function(a, b, ...) callGeneric(a, Matrix(b)))
278    setMethod("solve", signature(a = "matrix", b = "Matrix"),
279              function(a, b, ...) callGeneric(Matrix(a), b))
280
281    setMethod("solve", signature(a = "Matrix", b = "diagonalMatrix"),
282              function(a, b, ...) callGeneric(a, as(b,"CsparseMatrix")))
283
284    ## when no sub-class method is found, bail out
285    setMethod("solve", signature(a = "Matrix", b = "Matrix"),
286              function(a, b, ...) .bail.out.2("solve", class(a), class(b)))
287
288  ## bail-out methods in order to get better error messages  ## bail-out methods in order to get better error messages
289  setMethod("%*%", signature(x = "Matrix", y = "Matrix"),  setMethod("%*%", signature(x = "Matrix", y = "Matrix"),
# Line 180  Line 295
295            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
296  setMethod("crossprod", signature(x = "ANY", y = "Matrix"),  setMethod("crossprod", signature(x = "ANY", y = "Matrix"),
297            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
298    setMethod("tcrossprod", signature(x = "Matrix", y = "ANY"),
299              function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
300    setMethod("tcrossprod", signature(x = "ANY", y = "Matrix"),
301              function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
302
303    ## cheap fallbacks
304    setMethod("crossprod", signature(x = "Matrix", y = "Matrix"),
305              function(x, y = NULL) t(x) %*% y)
306    setMethod("tcrossprod", signature(x = "Matrix", y = "Matrix"),
307              function(x, y = NULL) x %*% t(y))
308
309  ## There are special sparse methods; this is a "fall back":  ## There are special sparse methods; this is a "fall back":
310  setMethod("kronecker", signature(X = "Matrix", Y = "ANY",  setMethod("kronecker", signature(X = "Matrix", Y = "ANY",
311                                   FUN = "ANY", make.dimnames = "ANY"),                                   FUN = "ANY", make.dimnames = "ANY"),
312            function(X, Y, FUN, make.dimnames, ...) {            function(X, Y, FUN, make.dimnames, ...) {
313                  if(is(X, "sparseMatrix"))
314                      warning("using slow kronecker() method")
315                X <- as(X, "matrix") ; Matrix(callGeneric()) })                X <- as(X, "matrix") ; Matrix(callGeneric()) })
316
317  setMethod("kronecker", signature(X = "ANY", Y = "Matrix",  setMethod("kronecker", signature(X = "ANY", Y = "Matrix",
318                                   FUN = "ANY", make.dimnames = "ANY"),                                   FUN = "ANY", make.dimnames = "ANY"),
319            function(X, Y, FUN, make.dimnames, ...) {            function(X, Y, FUN, make.dimnames, ...) {
320                  if(is(Y, "sparseMatrix"))
321                      warning("using slow kronecker() method")
322                Y <- as(Y, "matrix") ; Matrix(callGeneric()) })                Y <- as(Y, "matrix") ; Matrix(callGeneric()) })
323
324
325    setMethod("determinant", signature(x = "Matrix", logarithm = "missing"),
326              function(x, logarithm, ...)
327              determinant(x, logarithm = TRUE, ...))
328
329    if(FALSE) { ## This is desired "in theory" - but gives
330        ## "The following object(s) are masked from package:base :   det
331    ## base::det() calls [base::]determinant();
332    ## our det() should call our determinant() :
333    det <- base::det
334    environment(det) <- environment()## == as.environment("Matrix")
335    }
336
337    ## FIXME: All of these should never be called
338    setMethod("chol", signature(x = "Matrix"),
339              function(x, pivot, ...) .bail.out.1(.Generic, class(x)))
340    setMethod("determinant", signature(x = "Matrix", logarithm = "logical"),
341              function(x, logarithm, ...)
342              determinant(as(x,"dMatrix"), logarithm=logarithm, ...))
343
344    setMethod("diag", signature(x = "Matrix"),
345              function(x, nrow, ncol) .bail.out.1(.Generic, class(x)))
346  setMethod("t", signature(x = "Matrix"),  setMethod("t", signature(x = "Matrix"),
347            function(x) .bail.out.1(.Generic, class(x)))            function(x) .bail.out.1(.Generic, class(x)))
348
349  ## Group Methods  setMethod("norm", signature(x = "Matrix", type = "character"),
350  setMethod("+", signature(e1 = "Matrix", e2 = "missing"), function(e1) e1)            function(x, type, ...) .bail.out.1(.Generic, class(x)))
351  ## "fallback":  setMethod("rcond", signature(x = "Matrix", norm = "character"),
352  setMethod("-", signature(e1 = "Matrix", e2 = "missing"),            function(x, norm, ...) .bail.out.1(.Generic, class(x)))
353            function(e1) {
354                warning("inefficient method used for \"- e1\"")
355                0-e1  ## for all :
356    setMethod("norm", signature(x = "ANY", type = "missing"),
357              function(x, type, ...) norm(x, type = "O", ...))
358    setMethod("rcond", signature(x = "ANY", norm = "missing"),
359              function(x, norm, ...) rcond(x, norm = "O", ...))
360
361
362
363
364    ## We want to use all.equal.numeric() *and* make sure that uses
365    ## not just base::as.vector but the generic with our methods:
366    all.equal_num <- base::all.equal.numeric ## from <R>/src/library/base/R/all.equal.R
367    environment(all.equal_num) <- environment()## == as.environment("Matrix")
368
369    all.equal_Mat <- function(target, current, check.attributes = TRUE, ...)
370    {
371        msg <- attr.all_Mat(target, current, check.attributes=check.attributes, ...)
372        if(is.list(msg)) return(msg[[1]])
373        ## else
374        r <- all.equal_num(as.vector(target), as.vector(current),
375                           check.attributes=check.attributes, ...)
376        if(is.null(msg) && (r.ok <- isTRUE(r))) TRUE else c(msg, if(!r.ok) r)
377    }
378    ## The all.equal() methods for dense matrices (and fallback):
379    setMethod("all.equal", c(target = "Matrix", current = "Matrix"),
380              all.equal_Mat)
381    setMethod("all.equal", c(target = "Matrix", current = "ANY"),
382              all.equal_Mat)
383    setMethod("all.equal", c(target = "ANY", current = "Matrix"),
384              all.equal_Mat)
385    ## -> ./sparseMatrix.R, ./sparseVector.R  have specific methods
386
387
388
389    ## MM: More or less "Cut & paste" from
390    ## --- diff.default() from  R/src/library/base/R/diff.R :
391    setMethod("diff", signature(x = "Matrix"),
392              function(x, lag = 1, differences = 1, ...) {
393                  if (length(lag) > 1 || length(differences) > 1 ||
394                      lag < 1 || differences < 1)
395                      stop("'lag' and 'differences' must be integers >= 1")
396                  xlen <- nrow(x)
397                  if (lag * differences >= xlen)
398                      return(x[,FALSE][0])  # empty of proper mode
399
400                  i1 <- -1:-lag
401                  for (i in 1:differences)
402                      x <- x[i1, , drop = FALSE] -
403                          x[-nrow(x):-(nrow(x)-lag+1), , drop = FALSE]
404                  x
405            })            })
406
407  ## bail-outs:  setMethod("image", "Matrix",
408  setMethod("Compare", signature(e1 = "Matrix", e2 = "Matrix"),            function(x, ...) { # coercing to sparse is not inefficient,
409            function(e1, e2) {                ##               since we need 'i' and 'j' for levelplot()
410                d <- dimCheck(e1,e2)                x <- as(as(x, "sparseMatrix"), "dMatrix")
411                .bail.out.2(.Generic, class(e1), class(e2))                callGeneric()
412            })            })
setMethod("Compare", signature(e1 = "Matrix", e2 = "ANY"),
function(e1, e2) .bail.out.2(.Generic, class(e1), class(e2)))
setMethod("Compare", signature(e1 = "ANY", e2 = "Matrix"),
function(e1, e2) .bail.out.2(.Generic, class(e1), class(e2)))
413
414
415    ## Group Methods
416
417    ## For all  non-dMatrix objects, and note that  "all" and "any" have their own
418    setMethod("Summary", signature(x = "Matrix", na.rm = "ANY"),
419              function(x, ..., na.rm)
420              callGeneric(as(x,"dMatrix"), ..., na.rm = na.rm))
421
422    Summary.l <- function(x, ..., na.rm) { ## must be method directly
423        r <- callGeneric(as(x,"dMatrix"), ..., na.rm = na.rm)
424        if(!is.infinite(r) && .Generic %in% c("max", "min", "range", "sum"))
425            as.integer(r) else r
426    }
427    setMethod("Summary", signature(x = "lMatrix", na.rm = "ANY"), Summary.l)
428    setMethod("Summary", signature(x = "nMatrix", na.rm = "ANY"), Summary.l)
429    setMethod("Summary", signature(x = "pMatrix", na.rm = "ANY"), Summary.l)
430
431    ## Further, see ./Ops.R
432    ##                ~~~~~
433
434
435  ### --------------------------------------------------------------------------  ### --------------------------------------------------------------------------
436  ###  ###
# Line 228  Line 443
443  ## "x[]":  ## "x[]":
444  setMethod("[", signature(x = "Matrix",  setMethod("[", signature(x = "Matrix",
445                           i = "missing", j = "missing", drop = "ANY"),                           i = "missing", j = "missing", drop = "ANY"),
446            function (x, i, j, drop) x)            function (x, i, j, ..., drop) x)
447
448  ## missing 'drop' --> 'drop = TRUE'  ## missing 'drop' --> 'drop = TRUE'
449  ##                     -----------  ##                     -----------
450  ## select rows  ## select rows __ or __ vector indexing:
451  setMethod("[", signature(x = "Matrix", i = "index", j = "missing",  setMethod("[", signature(x = "Matrix", i = "index", j = "missing",
452                           drop = "missing"),                           drop = "missing"),
453            function(x,i,j, drop) callGeneric(x, i=i, drop= TRUE))            function(x,i,j, ..., drop) {
454                  if(nargs() == 2) { ## e.g. M[0] , M[TRUE],  M[1:2]
455                      if(any(as.logical(i)) || prod(dim(x)) == 0)
456                          ## FIXME: for *large sparse*, use sparseVector !
457                          as.vector(x)[i]
458                      else ## save memory (for large sparse M):
459                          as.vector(x[1,1])[FALSE]
460                  } else {
461                      callGeneric(x, i=i, , drop=TRUE)
462                      ##                  ^^
463                  }
464              })
465
466  ## select columns  ## select columns
467  setMethod("[", signature(x = "Matrix", i = "missing", j = "index",  setMethod("[", signature(x = "Matrix", i = "missing", j = "index",
468                           drop = "missing"),                           drop = "missing"),
469            function(x,i,j, drop) callGeneric(x, j=j, drop= TRUE))            function(x,i,j, ..., drop) callGeneric(x, j=j, drop= TRUE))
470  setMethod("[", signature(x = "Matrix", i = "index", j = "index",  setMethod("[", signature(x = "Matrix", i = "index", j = "index",
471                           drop = "missing"),                           drop = "missing"),
472            function(x,i,j, drop) callGeneric(x, i=i, j=j, drop= TRUE))            function(x,i,j, ..., drop) callGeneric(x, i=i, j=j, drop= TRUE))
473
474  ## bail out if any of (i,j,drop) is "non-sense"  ## bail out if any of (i,j,drop) is "non-sense"
475  setMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY", drop = "ANY"),  setMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY", drop = "ANY"),
476            function(x,i,j, drop)            function(x,i,j, ..., drop)
477            stop("invalid or not-yet-implemented 'Matrix' subsetting"))            stop("invalid or not-yet-implemented 'Matrix' subsetting"))
478
479  ##  "logical *vector* indexing, such as  M [ M >= 10 ] :  ## logical indexing, such as M[ M >= 7 ] *BUT* also M[ M[,1] >= 3,],
480    ## The following is *both* for    M [ <logical>   ]
481    ##                 and also for   M [ <logical> , ]
482    .M.sub.i.logical <- function (x, i, j, ..., drop)
483    {
484        nA <- nargs()
485        if(nA == 2) { ##  M [ M >= 7 ]
486            ## FIXME: when both 'x' and 'i' are sparse, this can be very inefficient
487            if(is(x, "sparseMatrix"))
488                message("<sparse>[ <logic> ] : .M.sub.i.logical() maybe inefficient")
489            toC <- geClass(x)
490            if(canCoerce(x, toC)) as(x, toC)@x[as.vector(i)]
491            else as(as(as(x, "generalMatrix"), "denseMatrix"), toC)@x[as.vector(i)]
492            ## -> error when lengths don't match
493        } else if(nA == 3) { ##  M [ M[,1, drop=FALSE] >= 7, ]
494            stop("not-yet-implemented 'Matrix' subsetting") ## FIXME
495
496        } else stop("nargs() = ", nA,
497                    ".  Extraneous illegal arguments inside '[ .. ]' (i.logical)?")
498    }
499  setMethod("[", signature(x = "Matrix", i = "lMatrix", j = "missing",  setMethod("[", signature(x = "Matrix", i = "lMatrix", j = "missing",
500                           drop = "ANY"),                           drop = "ANY"),
501            function (x, i, j, drop) {            .M.sub.i.logical)
as(x, geClass(x))@x[as.vector(i)]
# -> error when lengths don't match
})

502  setMethod("[", signature(x = "Matrix", i = "logical", j = "missing",  setMethod("[", signature(x = "Matrix", i = "logical", j = "missing",
503                           drop = "ANY"),                           drop = "ANY"),
504            function (x, i, j, drop) as(x, geClass(x))@x[i])            .M.sub.i.logical)
505
506
507  ## "FIXME:"  subset.ij <- function(x, ij) {
508  ## How can we get at   A[ ij ]  where ij is (i,j) 2-column matrix?      m <- nrow(ij)
509  ##  and                A[ LL ]  where LL is a logical *vector*      if(m > 3) {
510  ## -> [.data.frame uses nargs() - can we do this in the *generic* ?          cld <- getClassDef(class(x))
511            sym.x <- extends(cld, "symmetricMatrix")
512            if(sym.x) {
513                W <- if(x@uplo == "U") # stored only [i,j] with i <= j
514                    ij[,1] > ij[,2] else ij[,1] < ij[,2]
515                if(any(W))
516                    ij[W,] <- ij[W, 2:1]
517            }
518            if(extends(cld, "sparseMatrix")) {
519                ## do something smarter:
520                di <- dim(x)
521                if(!extends(cld, "CsparseMatrix")) {
522                    x <- as(x, "CsparseMatrix") # simpler; our standard
523                    cld <- getClassDef(class(x))
524                }
525                tri.x <- extends(cld, "triangularMatrix")
526                if(tri.x) {
527                    ## need these for the 'x' slot in any case
528                    if (x@diag == "U") x <- .Call(Csparse_diagU2N, x)
529                    ## slightly more efficient than non0.i() or non0ind():
530                    ij.x <- .Call(compressed_non_0_ij, x, isC=TRUE)
531                } else { ## symmetric / general : for symmetric, only "existing"b
532                    ij.x <- non0.i(x, cld)
533                }
534
535                mi <- match(.Call(m_encodeInd, ij.x,          di),
536                            .Call(m_encodeInd, ij -1L, di), nomatch=0)
537                mmi <- mi != 0
538                ## Result:
539                ans <- vector(mode = .type.kind[.M.kindC(cld)], length = m)
540                ## those that are *not* zero:
541                ans[mi[mmi]] <-
542                    if(extends(cld, "nsparseMatrix")) TRUE else x@x[mmi]
543                ans
544
545            } else { ## non-sparse : dense
546                ##---- NEVER happens:  'denseMatrix' has its own setMethod(.) !
547                message("m[ <ij-matrix> ]: inefficiently indexing single elements")
548                i1 <- ij[,1]
549                i2 <- ij[,2]
550                ## very inefficient for large m
551                unlist(lapply(seq_len(m), function(j) x[i1[j], i2[j]]))
552            }
553        } else { # 1 <= m <= 3
554            i1 <- ij[,1]
555            i2 <- ij[,2]
556            unlist(lapply(seq_len(m), function(j) x[i1[j], i2[j]]))
557        }
558    }
559
560    ## A[ ij ]  where ij is (i,j) 2-column matrix -- but also when that is logical mat!
561    .M.sub.i.2col <- function (x, i, j, ..., drop)
562    {
563        nA <- nargs()
564        if(nA == 2) { ##  M [ cbind(ii,jj) ] or M [ <logical matrix> ]
565            if(!is.integer(nc <- ncol(i)))
566                stop(".M.sub.i.2col(): 'i' has no integer column number;\n",
567                     "should never happen; please report")
568            if(is.logical(i))
569                return(.M.sub.i.logical(x, i=i)) # call with 2 args!
570            else if(!is.numeric(i) || nc != 2)
571                stop("such indexing must be by logical or 2-column numeric matrix")
572            m <- nrow(i)
573            if(m == 0) return(vector(mode = .type.kind[.M.kind(x)]))
574            ## else
575            subset.ij(x, i)
576
577        } else stop("nargs() = ", nA,
578                    ".  Extraneous illegal arguments inside '[ .. ]' (i.2col)?")
579    }
580    setMethod("[", signature(x = "Matrix", i = "matrix", j = "missing"),# drop="ANY"
581              .M.sub.i.2col)
582
583
584  ### "[<-" : -----------------  ### "[<-" : -----------------
# Line 274  Line 587
587  setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "missing",  setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "missing",
588                                  value = "ANY"),## double/logical/...                                  value = "ANY"),## double/logical/...
589            function (x, value) {            function (x, value) {
590                x@x <- value                ## Fails for 'nMatrix' ... FIXME : make sure have method there
591                  x@x <- rep(value, length = length(x@x))
592                validObject(x)# check if type and lengths above match                validObject(x)# check if type and lengths above match
593                x                x
594            })            })
595
596  ## Method for all 'Matrix' kinds (rather than incomprehensible error messages);  ## A[ ij ] <- value,  where ij is (i,j) 2-column matrix :
597    ## ----------------
598    ## The cheap general method --- FIXME: provide special ones; done for Tsparse..
599    ## NOTE:  need '...' below such that setMethod() does
600    ##        not use .local() such that nargs() will work correctly:
601    .M.repl.i.2col <- function (x, i, j, ..., value)
602    {
603        nA <- nargs()
604        if(nA == 3) { ##  M [ cbind(ii,jj) ] <- value  or M [ Lmat ] <- value
605            if(!is.integer(nc <- ncol(i)))
606                stop(".M.repl.i.2col(): 'i' has no integer column number;\n",
607                     "should never happen; please report")
608            else if(!is.numeric(i) || nc != 2)
609                stop("such indexing must be by logical or 2-column numeric matrix")
610            if(is.logical(i)) {
611                message(".M.repl.i.2col(): drop 'matrix' case ...")
612                ## c(i) : drop "matrix" to logical vector
613                return( callGeneric(x, i=c(i), value=value) )
614            }
615            if(!is.integer(i)) storage.mode(i) <- "integer"
616            if(any(i < 0))
617                stop("negative values are not allowed in a matrix subscript")
618            if(any(is.na(i)))
619                stop("NAs are not allowed in subscripted assignments")
620            if(any(i0 <- (i == 0))) # remove them
621                i <- i[ - which(i0, arr.ind = TRUE)[,"row"], ]
622            ## now have integer i >= 1
623            m <- nrow(i)
624            ## mod.x <- .type.kind[.M.kind(x)]
625            if(length(value) > 0 && m %% length(value) != 0)
626                warning("number of items to replace is not a multiple of replacement length")
627            ## recycle:
628            value <- rep(value, length = m)
629            i1 <- i[,1]
630            i2 <- i[,2]
631            if(m > 2)
632                message("m[ <ij-matrix> ] <- v: inefficiently treating single elements")
633            ## inefficient -- FIXME -- (also loses "symmetry" unnecessarily)
634            for(k in seq_len(m))
635                x[i1[k], i2[k]] <- value[k]
636
637            x
638        } else stop("nargs() = ", nA,
639                    ".  Extraneous illegal arguments inside '[ .. ]' ?")
640    }
641
642    setReplaceMethod("[", signature(x = "Matrix", i = "matrix", j = "missing",
643                                    value = "replValue"),
644              .M.repl.i.2col)
645
646    ## Three catch-all methods ... would be very inefficient for sparse*
647    ## --> extra methods in ./sparseMatrix.R
648    setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "ANY",
649                                    value = "Matrix"),
650                     function (x, i, j, ..., value)
651                     callGeneric(x=x, , j=j, value = as.vector(value)))
652
653    setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "missing",
654                                    value = "Matrix"),
655                     function (x, i, j, ..., value)
656                     callGeneric(x=x, i=i, , value = as.vector(value)))
657
658    setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",
659                                    value = "Matrix"),
660                     function (x, i, j, ..., value)
661                     callGeneric(x=x, i=i, j=j, value = as.vector(value)))
662
663
664    setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "ANY",
665                                    value = "matrix"),
666                     function (x, i, j, ..., value)
667                     callGeneric(x=x, , j=j, value = c(value)))
668
669    setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "missing",
670                                    value = "matrix"),
671                     function (x, i, j, ..., value)
672                     callGeneric(x=x, i=i, , value = c(value)))
673
674    setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",
675                                    value = "matrix"),
676                     function (x, i, j, value)
677                     callGeneric(x=x, i=i, j=j, value = c(value)))
678
679  ## (ANY,ANY,ANY) is used when no `real method' is implemented :  ## (ANY,ANY,ANY) is used when no `real method' is implemented :
680  setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",  setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",
681                                  value = "ANY"),                                  value = "ANY"),
682            function (x, i, j, value) {            function (x, i, j, value) {
683                if(!is.atomic(value))                if(!is.atomic(value))
684                    stop("RHS 'value' must match matrix class ", class(x))                    stop(sprintf("RHS 'value' (class %s) matches 'ANY', but must match matrix class %s",
685                                   class(value),class(x)))
686                else stop("not-yet-implemented 'Matrix[<-' method")                else stop("not-yet-implemented 'Matrix[<-' method")
687            })            })

## The trivial methods :
setMethod("cbind2", signature(x = "Matrix", y = "NULL"),
function(x, y) x)
setMethod("cbind2", signature(x = "Matrix", y = "missing"),
function(x, y) x)
setMethod("cbind2", signature(x = "NULL", y="Matrix"),
function(x, y) x)

setMethod("rbind2", signature(x = "Matrix", y = "NULL"),
function(x, y) x)
setMethod("rbind2", signature(x = "Matrix", y = "missing"),
function(x, y) x)
setMethod("rbind2", signature(x = "NULL", y="Matrix"),
function(x, y) x)

## Makes sure one gets x decent error message for the unimplemented cases:
setMethod("cbind2", signature(x = "Matrix", y = "Matrix"),
function(x, y) {
rowCheck(x,y)
stop(gettextf("cbind2() method for (%s,%s) not-yet defined",
class(x), class(y)))
})

## Use a working fall back {particularly useful for sparse}:
## FIXME: implement rbind2 via "cholmod" for C* and Tsparse ones
setMethod("rbind2", signature(x = "Matrix", y = "Matrix"),
function(x, y) {
colCheck(x,y)
t(cbind2(t(x), t(y)))
})

Legend:
 Removed from v.1290 changed lines Added in v.2255