# 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 1665, Fri Nov 3 23:18:07 2006 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_Csparse(from))
7    setAs("Matrix", "denseMatrix",  function(from) as_dense(from))
8
9    ## Most of these work; this is a last resort:
10    setAs(from = "Matrix", to = "matrix", # do *not* call base::as.matrix() here:
11          function(from) .bail.out.2("coerce", class(from), class(to)))
12    setAs(from = "matrix", to = "Matrix", function(from) Matrix(from))
13
14  ## ## probably not needed eventually:  ## ## probably not needed eventually:
15  ## setAs(from = "ddenseMatrix", to = "matrix",  ## setAs(from = "ddenseMatrix", to = "matrix",
16  ##       function(from) {  ##       function(from) {
# Line 12  Line 23
23  ## for 'Matrix' objects, as.array() should be equivalent:  ## for 'Matrix' objects, as.array() should be equivalent:
24  setMethod("as.array",  signature(x = "Matrix"), function(x) as(x, "matrix"))  setMethod("as.array",  signature(x = "Matrix"), function(x) as(x, "matrix"))
25
26    ## head and tail apply to all Matrix objects for which subscripting is allowed:
28    setMethod("tail", signature(x = "Matrix"), utils::tail.matrix)
29
30  ## slow "fall back" method {subclasses should have faster ones}:  ## slow "fall back" method {subclasses should have faster ones}:
31  setMethod("as.vector", signature(x = "Matrix", mode = "missing"),  setMethod("as.vector", signature(x = "Matrix", mode = "missing"),
32            function(x) as.vector(as(x, "matrix")))            function(x) as.vector(as(x, "matrix")))
33
34    ## mainly need these for "dMatrix" or "lMatrix" respectively, but why not general:
35    setMethod("as.numeric", signature(x = "Matrix"),
36              function(x, ...) as.numeric(as.vector(x)))
37    setMethod("as.logical", signature(x = "Matrix"),
38              function(x, ...) as.logical(as.vector(x)))
39
40  ## Note that isSymmetric is *not* exported
41  ## but that "base" has an isSymmetric() S3-generic since R 2.3.0  ## "base" has an isSymmetric() S3-generic since R 2.3.0
42  setMethod("isSymmetric", signature(object = "symmetricMatrix"),  setMethod("isSymmetric", signature(object = "symmetricMatrix"),
43            function(object,tol) TRUE)            function(object,tol) TRUE)
44  setMethod("isSymmetric", signature(object = "triangularMatrix"),  setMethod("isSymmetric", signature(object = "triangularMatrix"),
45            ## TRUE iff diagonal:            ## TRUE iff diagonal:
46            function(object,tol) isDiagonal(object))            function(object,tol) isDiagonal(object))
47
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)
})

48  setMethod("isTriangular", signature(object = "triangularMatrix"),  setMethod("isTriangular", signature(object = "triangularMatrix"),
49            function(object, ...) TRUE)            function(object, ...) TRUE)
50
# Line 77  Line 77
77
78  Matrix <-  Matrix <-
79      function (data = NA, nrow = 1, ncol = 1, byrow = FALSE, dimnames = NULL,      function (data = NA, nrow = 1, ncol = 1, byrow = FALSE, dimnames = NULL,
80                sparse = NULL)                sparse = NULL, forceCheck = FALSE)
81  {  {
82      sparseDefault <- function(m)      sparseDefault <- function(m) prod(dim(m)) > 2*sum(isN0(as(m, "matrix")))
prod(dim(m)) > 2*sum(as(m, "matrix") != 0)
83
84      i.M <- is(data, "Matrix")      i.M <- is(data, "Matrix")
85      if(is.null(sparse) && (i.M || is(data, "matrix")))
86        if(is.null(sparse1 <- sparse) && (i.M || is(data, "matrix")))
87          sparse <- sparseDefault(data)          sparse <- sparseDefault(data)
88
89        doDN <- TRUE
90      if (i.M) {      if (i.M) {
91          sM <- is(data,"sparseMatrix")          sM <- is(data,"sparseMatrix")
92          if((sparse && sM) || (!sparse && !sM))          if(!forceCheck && ((sparse && sM) || (!sparse && !sM)))
93              return(data)              return(data)
94          ## else : convert  dense <-> sparse -> at end          ## else : convert  dense <-> sparse -> at end
95      }      }
# Line 97  Line 98
98              nrow <- ceiling(length(data)/ncol)              nrow <- ceiling(length(data)/ncol)
99          else if (missing(ncol))          else if (missing(ncol))
100              ncol <- ceiling(length(data)/nrow)              ncol <- ceiling(length(data)/nrow)
101            if(length(data) == 1 && is0(data) && !identical(sparse, FALSE)) {
102                ## Matrix(0, ...) : always sparse unless "sparse = FALSE":
103                if(is.null(sparse)) sparse1 <- sparse <- TRUE
104                ## will be sparse: do NOT construct full matrix!
105                data <- new(if(is.numeric(data)) "dgTMatrix" else
106                            if(is.logical(data)) "lgTMatrix" else
107                            stop("invalid 'data'"),
108                            Dim = as.integer(c(nrow,ncol)),
109                            Dimnames = if(is.null(dimnames)) list(NULL,NULL)
110                            else dimnames)
111            } else { ## normal case
112          data <- .Internal(matrix(data, nrow, ncol, byrow))          data <- .Internal(matrix(data, nrow, ncol, byrow))
113          if(is.null(sparse))          if(is.null(sparse))
114              sparse <- sparseDefault(data)              sparse <- sparseDefault(data)
115          dimnames(data) <- dimnames          dimnames(data) <- dimnames
116      } else if (!is.null(dimnames))          }
117          dimnames(data) <- dimnames          doDN <- FALSE
118        }
119      ## 'data' is now a "matrix" or "Matrix"      ## 'data' is now a "matrix" or "Matrix"
120        if (doDN && !is.null(dimnames))
121            dimnames(data) <- dimnames
122
123      ## check for symmetric / triangular / diagonal :      ## check for symmetric / triangular / diagonal :
124      isSym <- isSymmetric(data)      isSym <- isSymmetric(data)
# Line 114  Line 128
128      if(isDiag)      if(isDiag)
129          isDiag <- isDiagonal(data)          isDiag <- isDiagonal(data)
130
### TODO: Compare with as.Matrix() and its tests in ./dgeMatrix.R

131      ## Find proper matrix class 'cl'      ## Find proper matrix class 'cl'
132      cl <-      cl <-
133          if(isDiag)          if(isDiag && !isTRUE(sparse1))
134              "diagonalMatrix" # -> will automatically check for type              "diagonalMatrix" # -> will automatically check for type
135          else {          else {
136              ## consider it's type              ## consider it's type
# Line 159  Line 171
171            function(x, y) callGeneric(x, as.matrix(y)))            function(x, y) callGeneric(x, as.matrix(y)))
172
173  setMethod("%*%", signature(x = "numeric", y = "Matrix"),  setMethod("%*%", signature(x = "numeric", y = "Matrix"),
174            function(x, y) callGeneric(rbind(x), y))            function(x, y) callGeneric(matrix(x, nrow = 1, byrow=TRUE), y))
175
176  setMethod("crossprod", signature(x = "Matrix", y = "numeric"),  setMethod("crossprod", signature(x = "Matrix", y = "numeric"),
177            function(x, y = NULL) callGeneric(x, as.matrix(y)))            function(x, y = NULL) callGeneric(x, as.matrix(y)))

178  setMethod("crossprod", signature(x = "numeric", y = "Matrix"),  setMethod("crossprod", signature(x = "numeric", y = "Matrix"),
179            function(x, y = NULL)  callGeneric(rbind(x), y))            function(x, y = NULL)  callGeneric(as.matrix(x), y))
180
181    ## The as.matrix() promotion seems illogical to MM,
182    ## but is according to help(tcrossprod, package = "base") :
183    setMethod("tcrossprod", signature(x = "Matrix", y = "numeric"),
184              function(x, y = NULL) callGeneric(x, as.matrix(y)))
185    setMethod("tcrossprod", signature(x = "numeric", y = "Matrix"),
186              function(x, y = NULL)  callGeneric(as.matrix(x), y))
187
188    ## maybe not optimal
189    setMethod("solve", signature(a = "Matrix", b = "missing"),
190              function(a, b, ...) solve(a, Diagonal(nrow(a))))
191
192  setMethod("solve", signature(a = "Matrix", b = "numeric"),  setMethod("solve", signature(a = "Matrix", b = "numeric"),
193            function(a, b, ...) callGeneric(a, as.matrix(b)))            function(a, b, ...) callGeneric(a, as.matrix(b)))
194    ## when no sub-class method is found, bail out
195    setMethod("solve", signature(a = "Matrix", b = "matrix"),
196              function(a, b, ...) .bail.out.2("solve", class(a), "matrix"))
197
198  ## bail-out methods in order to get better error messages  ## bail-out methods in order to get better error messages
199  setMethod("%*%", signature(x = "Matrix", y = "Matrix"),  setMethod("%*%", signature(x = "Matrix", y = "Matrix"),
# Line 180  Line 205
205            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
206  setMethod("crossprod", signature(x = "ANY", y = "Matrix"),  setMethod("crossprod", signature(x = "ANY", y = "Matrix"),
207            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
208    setMethod("tcrossprod", signature(x = "Matrix", y = "ANY"),
209              function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
210    setMethod("tcrossprod", signature(x = "ANY", y = "Matrix"),
211              function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
212
213    ## cheap fallbacks
214    setMethod("crossprod", signature(x = "Matrix", y = "Matrix"),
215              function(x, y = NULL) t(x) %*% y)
216    setMethod("tcrossprod", signature(x = "Matrix", y = "Matrix"),
217              function(x, y = NULL) x %*% t(y))
218
219  ## There are special sparse methods; this is a "fall back":  ## There are special sparse methods; this is a "fall back":
220  setMethod("kronecker", signature(X = "Matrix", Y = "ANY",  setMethod("kronecker", signature(X = "Matrix", Y = "ANY",
# Line 192  Line 227
227                Y <- as(Y, "matrix") ; Matrix(callGeneric()) })                Y <- as(Y, "matrix") ; Matrix(callGeneric()) })
228
229
230    ## FIXME: All of these should never be called
231    setMethod("chol", signature(x = "Matrix"),
232              function(x, pivot = FALSE) .bail.out.1(.Generic, class(x)))
233    setMethod("determinant", signature(x = "Matrix"),
234              function(x, logarithm = TRUE) .bail.out.1(.Generic, class(x)))
235
236    setMethod("diag", signature(x = "Matrix"),
237              function(x, nrow, ncol) .bail.out.1(.Generic, class(x)))
238  setMethod("t", signature(x = "Matrix"),  setMethod("t", signature(x = "Matrix"),
239            function(x) .bail.out.1(.Generic, class(x)))            function(x) .bail.out.1(.Generic, class(x)))
240
# Line 204  Line 247
247                0-e1                0-e1
248            })            })
249
250  ## bail-outs:  ## old-style matrices are made into new ones
251  setMethod("Compare", signature(e1 = "Matrix", e2 = "Matrix"),  setMethod("Ops", signature(e1 = "Matrix", e2 = "matrix"),
252              function(e1, e2) callGeneric(e1, Matrix(e2)))
253    ##          callGeneric(e1, Matrix(e2, sparse=is(e1,"sparseMatrix"))))
254    setMethod("Ops", signature(e1 = "matrix", e2 = "Matrix"),
255              function(e1, e2) callGeneric(Matrix(e1), e2))
256
257    ## bail-outs -- on highest possible level, hence "Ops", not "Compare"/"Arith" :
258    setMethod("Ops", signature(e1 = "Matrix", e2 = "Matrix"),
259            function(e1, e2) {            function(e1, e2) {
260                d <- dimCheck(e1,e2)                d <- dimCheck(e1,e2)
261                .bail.out.2(.Generic, class(e1), class(e2))                .bail.out.2(.Generic, class(e1), class(e2))
262            })            })
263  setMethod("Compare", signature(e1 = "Matrix", e2 = "ANY"),  setMethod("Ops", signature(e1 = "Matrix", e2 = "ANY"),
264            function(e1, e2) .bail.out.2(.Generic, class(e1), class(e2)))            function(e1, e2) .bail.out.2(.Generic, class(e1), class(e2)))
265  setMethod("Compare", signature(e1 = "ANY", e2 = "Matrix"),  setMethod("Ops", signature(e1 = "ANY", e2 = "Matrix"),
266            function(e1, e2) .bail.out.2(.Generic, class(e1), class(e2)))            function(e1, e2) .bail.out.2(.Generic, class(e1), class(e2)))
267
268
# Line 249  Line 299
299            function(x,i,j, drop)            function(x,i,j, drop)
300            stop("invalid or not-yet-implemented 'Matrix' subsetting"))            stop("invalid or not-yet-implemented 'Matrix' subsetting"))
301
302  ##  "logical *vector* indexing, such as  M [ M >= 10 ] :  ## logical indexing, such as M[ M >= 7 ] *BUT* also M[ M[,1] >= 3,],
303  setMethod("[", signature(x = "Matrix", i = "lMatrix", j = "missing",  ## The following is *both* for    M [ <logical>   ]
304                           drop = "ANY"),  ##                 and also for   M [ <logical> , ]
305            function (x, i, j, drop) {  .M.sub.i.logical <- function (x, i, j, drop)
306    {
307        nA <- nargs()
308        if(nA == 2) { ##  M [ M >= 7 ]
309                as(x, geClass(x))@x[as.vector(i)]                as(x, geClass(x))@x[as.vector(i)]
310                                          # -> error when lengths don't match          ## -> error when lengths don't match
311            })      } else if(nA == 3) { ##  M [ M[,1, drop=FALSE] >= 7, ]
312            stop("not-yet-implemented 'Matrix' subsetting") ## FIXME
313
314        } else stop("nargs() = ", nA,
315                    " should never happen; please report.")
316    }
317    setMethod("[", signature(x = "Matrix", i = "lMatrix", j = "missing",
318                             drop = "ANY"),
319              .M.sub.i.logical)
320  setMethod("[", signature(x = "Matrix", i = "logical", j = "missing",  setMethod("[", signature(x = "Matrix", i = "logical", j = "missing",
321                           drop = "ANY"),                           drop = "ANY"),
322            function (x, i, j, drop) as(x, geClass(x))@x[i])            .M.sub.i.logical)
323
324
325  ## "FIXME:"  ## "FIXME:"
326  ## How can we get at   A[ ij ]  where ij is (i,j) 2-column matrix?  ## ------ get at  A[ ij ]  where ij is (i,j) 2-column matrix?
327  ##  and                A[ LL ]  where LL is a logical *vector*
## -> [.data.frame uses nargs() - can we do this in the *generic* ?
328
329
330  ### "[<-" : -----------------  ### "[<-" : -----------------
# Line 274  Line 333
333  setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "missing",  setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "missing",
334                                  value = "ANY"),## double/logical/...                                  value = "ANY"),## double/logical/...
335            function (x, value) {            function (x, value) {
336                  ## Fails for 'nMatrix' ... FIXME : make sure have method there
337                x@x <- value                x@x <- value
338                validObject(x)# check if type and lengths above match                validObject(x)# check if type and lengths above match
339                x                x
340            })            })
341
342  ## Method for all 'Matrix' kinds (rather than incomprehensible error messages);  setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",
343                                    value = "Matrix"),
344                     function (x, i, j, value)
345                     callGeneric(x=x, i=i, j=j, value = as.vector(value)))
346    setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",
347                                    value = "matrix"),
348                     function (x, i, j, value)
349                     callGeneric(x=x, i=i, j=j, value = c(value)))
350
351  ## (ANY,ANY,ANY) is used when no `real method' is implemented :  ## (ANY,ANY,ANY) is used when no `real method' is implemented :
352  setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",  setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",
353                                  value = "ANY"),                                  value = "ANY"),
354            function (x, i, j, value) {            function (x, i, j, value) {
355                if(!is.atomic(value))                if(!is.atomic(value))
356                    stop("RHS 'value' must match matrix class ", class(x))                    stop(sprintf("RHS 'value' (class %s) matches 'ANY', but must match matrix class %s",
357                                   class(value),class(x)))
358                else stop("not-yet-implemented 'Matrix[<-' method")                else stop("not-yet-implemented 'Matrix[<-' method")
359            })            })
360

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