SCM

SCM Repository

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

Diff of /pkg/R/Matrix.R

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1290, Thu Jun 8 09:30:21 2006 UTC revision 2081, Sat Oct 6 22:01:45 2007 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:
31    setMethod("head", signature(x = "Matrix"), utils::head.matrix)
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) as.vector(as(x, "matrix")))
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  ## Note that isSymmetric is *not* exported  
48  ## but that "base" has an isSymmetric() S3-generic since R 2.3.0  ## "base" has an isSymmetric() S3-generic since R 2.3.0
49  setMethod("isSymmetric", signature(object = "symmetricMatrix"),  setMethod("isSymmetric", signature(object = "symmetricMatrix"),
50            function(object,tol) TRUE)            function(object,tol) TRUE)
51  setMethod("isSymmetric", signature(object = "triangularMatrix"),  setMethod("isSymmetric", signature(object = "triangularMatrix"),
52            ## TRUE iff diagonal:            ## TRUE iff diagonal:
53            function(object,tol) isDiagonal(object))            function(object,tol) isDiagonal(object))
54    
 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)  
           })  
   
   
55  setMethod("isTriangular", signature(object = "triangularMatrix"),  setMethod("isTriangular", signature(object = "triangularMatrix"),
56            function(object, ...) TRUE)            function(object, ...) TRUE)
57    
# Line 56  Line 63 
63    
64  setMethod("dim", signature(x = "Matrix"),  setMethod("dim", signature(x = "Matrix"),
65            function(x) x@Dim, valueClass = "integer")            function(x) x@Dim, valueClass = "integer")
66    
67    setMethod("length", "Matrix", function(x) prod(dim(x)))
68    
69  setMethod("dimnames", signature(x = "Matrix"), function(x) x@Dimnames)  setMethod("dimnames", signature(x = "Matrix"), function(x) x@Dimnames)
70    
71    
72  ## not exported but used more than once for "dimnames<-" method :  ## not exported but used more than once for "dimnames<-" method :
73  ## -- or do only once for all "Matrix" classes ??  ## -- or do only once for all "Matrix" classes ??
74  dimnamesGets <- function (x, value) {  dimnamesGets <- function (x, value) {
# Line 75  Line 87 
87  setMethod("unname", signature("Matrix", force="missing"),  setMethod("unname", signature("Matrix", force="missing"),
88            function(obj) { obj@Dimnames <- list(NULL,NULL); obj})            function(obj) { obj@Dimnames <- list(NULL,NULL); obj})
89    
90    setMethod("all", signature(x = "Matrix"),
91              function(x, ..., na.rm)
92              callGeneric(as(x, "lMatrix"), ..., na.rm=na.rm))
93    
94    setMethod("any", signature(x = "Matrix"),
95              function(x, ..., na.rm)
96              callGeneric(as(x, "lMatrix"), ..., na.rm=na.rm))
97    
98    ## NOTE:  "&" and "|"  are now in group "Logic" c "Ops" --> ./Ops.R
99    ##        "!" is in ./not.R
100    
101    
102  Matrix <-  Matrix <-
103      function (data = NA, nrow = 1, ncol = 1, byrow = FALSE, dimnames = NULL,      function (data = NA, nrow = 1, ncol = 1, byrow = FALSE, dimnames = NULL,
104                sparse = NULL)                sparse = NULL, forceCheck = FALSE)
105  {  {
106      sparseDefault <- function(m)      sparseDefault <- function(m) prod(dim(m)) > 2*sum(isN0(as(m, "matrix")))
         prod(dim(m)) > 2*sum(as(m, "matrix") != 0)  
107    
108      i.M <- is(data, "Matrix")      i.M <- is(data, "Matrix")
109      if(is.null(sparse) && (i.M || is(data, "matrix")))      if(!i.M && inherits(data, "table")) # special treatment
110            class(data) <- "matrix" # "matrix" first for S4 dispatch
111        if(is.null(sparse1 <- sparse) && (i.M || is(data, "matrix")))
112          sparse <- sparseDefault(data)          sparse <- sparseDefault(data)
113    
114        doDN <- TRUE
115      if (i.M) {      if (i.M) {
116            if(!missing(nrow) || !missing(ncol)|| !missing(byrow))
117                warning("'nrow', 'ncol', etc, are disregarded when 'data' is \"Matrix\" already")
118          sM <- is(data,"sparseMatrix")          sM <- is(data,"sparseMatrix")
119          if((sparse && sM) || (!sparse && !sM))          if(!forceCheck && ((sparse && sM) || (!sparse && !sM)))
120              return(data)              return(data)
121          ## else : convert  dense <-> sparse -> at end          ## else : convert  dense <-> sparse -> at end
122      }      }
# Line 97  Line 125 
125              nrow <- ceiling(length(data)/ncol)              nrow <- ceiling(length(data)/ncol)
126          else if (missing(ncol))          else if (missing(ncol))
127              ncol <- ceiling(length(data)/nrow)              ncol <- ceiling(length(data)/nrow)
128            if(length(data) == 1 && is0(data) && !identical(sparse, FALSE)) {
129                ## Matrix(0, ...) : always sparse unless "sparse = FALSE":
130                if(is.null(sparse)) sparse1 <- sparse <- TRUE
131                i.M <- sM <- TRUE
132                ## will be sparse: do NOT construct full matrix!
133                data <- new(if(is.numeric(data)) "dgTMatrix" else
134                            if(is.logical(data)) "lgTMatrix" else
135                            stop("invalid 'data'"),
136                            Dim = as.integer(c(nrow,ncol)),
137                            Dimnames = if(is.null(dimnames)) list(NULL,NULL)
138                            else dimnames)
139            } else { ## normal case - using .Internal() to avoid more copying
140                if(getRversion() >= "2.7.0")
141                    data <- .Internal(matrix(data, nrow, ncol, byrow, dimnames))
142                else {
143          data <- .Internal(matrix(data, nrow, ncol, byrow))          data <- .Internal(matrix(data, nrow, ncol, byrow))
144                    dimnames(data) <- dimnames
145                }
146          if(is.null(sparse))          if(is.null(sparse))
147              sparse <- sparseDefault(data)              sparse <- sparseDefault(data)
148          dimnames(data) <- dimnames          }
149      } else if (!is.null(dimnames))          doDN <- FALSE
150          dimnames(data) <- dimnames      } else if(!missing(nrow) || !missing(ncol)|| !missing(byrow))
151            warning("'nrow', 'ncol', etc, are disregarded for matrix 'data'")
152    
153      ## 'data' is now a "matrix" or "Matrix"      ## 'data' is now a "matrix" or "Matrix"
154        if (doDN && !is.null(dimnames))
155            dimnames(data) <- dimnames
156    
157      ## check for symmetric / triangular / diagonal :      ## check for symmetric / triangular / diagonal :
158      isSym <- isSymmetric(data)      isSym <- isSymmetric(data)
# Line 114  Line 162 
162      if(isDiag)      if(isDiag)
163          isDiag <- isDiagonal(data)          isDiag <- isDiagonal(data)
164    
 ### TODO: Compare with as.Matrix() and its tests in ./dgeMatrix.R  
   
165      ## Find proper matrix class 'cl'      ## Find proper matrix class 'cl'
166      cl <-      cl <-
167          if(isDiag)          if(isDiag && !isTRUE(sparse1))
168              "diagonalMatrix" # -> will automatically check for type              "diagonalMatrix" # -> will automatically check for type
169          else {          else {
170              ## consider it's type              ## consider it's type
# Line 146  Line 192 
192                    }, sep="")                    }, sep="")
193          }          }
194    
195      ## Now coerce and return      ## Can we coerce and be done?
196        if(!canCoerce(data,cl)) { ## try to coerce ``via'' virtual classes
197            if(sparse && !sM)
198                data <- as(data, "sparseMatrix")
199            else if(!sparse && !is(data, "denseMatrix"))
200                data <- as(data, "denseMatrix")
201            if(isTri && !is(data, "triangularMatrix"))
202                data <- as(data, "triangularMatrix")
203            else if(isSym && !is(data, "symmetricMatrix"))
204                data <- as(data, "symmetricMatrix")
205        }
206        ## now coerce in any case .. maybe producing sensible error message:
207      as(data, cl)      as(data, cl)
208  }  }
209    
# Line 157  Line 214 
214    
215  setMethod("%*%", signature(x = "Matrix", y = "numeric"),  setMethod("%*%", signature(x = "Matrix", y = "numeric"),
216            function(x, y) callGeneric(x, as.matrix(y)))            function(x, y) callGeneric(x, as.matrix(y)))
   
217  setMethod("%*%", signature(x = "numeric", y = "Matrix"),  setMethod("%*%", signature(x = "numeric", y = "Matrix"),
218            function(x, y) callGeneric(rbind(x), y))            function(x, y) callGeneric(matrix(x, nrow = 1, byrow=TRUE), y))
219    
220    setMethod("%*%", signature(x = "Matrix", y = "matrix"),
221              function(x, y) callGeneric(x, Matrix(y)))
222    setMethod("%*%", signature(x = "matrix", y = "Matrix"),
223              function(x, y) callGeneric(Matrix(x), y))
224    
225    
226  setMethod("crossprod", signature(x = "Matrix", y = "numeric"),  setMethod("crossprod", signature(x = "Matrix", y = "numeric"),
227            function(x, y = NULL) callGeneric(x, as.matrix(y)))            function(x, y = NULL) callGeneric(x, as.matrix(y)))
   
228  setMethod("crossprod", signature(x = "numeric", y = "Matrix"),  setMethod("crossprod", signature(x = "numeric", y = "Matrix"),
229            function(x, y = NULL)  callGeneric(rbind(x), y))            function(x, y = NULL)  callGeneric(as.matrix(x), y))
230    
231    setMethod("crossprod", signature(x = "Matrix", y = "matrix"),
232              function(x, y = NULL) callGeneric(x, Matrix(y)))
233    setMethod("crossprod", signature(x = "matrix", y = "Matrix"),
234              function(x, y = NULL) callGeneric(Matrix(x), y))
235    
236    ## The as.matrix() promotion seems illogical to MM,
237    ## but is according to help(tcrossprod, package = "base") :
238    setMethod("tcrossprod", signature(x = "Matrix", y = "numeric"),
239              function(x, y = NULL) callGeneric(x, as.matrix(y)))
240    setMethod("tcrossprod", signature(x = "numeric", y = "Matrix"),
241              function(x, y = NULL)  callGeneric(as.matrix(x), y))
242    setMethod("tcrossprod", signature(x = "Matrix", y = "matrix"),
243              function(x, y = NULL) callGeneric(x, Matrix(y)))
244    setMethod("tcrossprod", signature(x = "matrix", y = "Matrix"),
245              function(x, y = NULL) callGeneric(Matrix(x), y))
246    
247    ## maybe not 100% optimal, but elegant:
248    setMethod("solve", signature(a = "Matrix", b = "missing"),
249              function(a, b, ...) solve(a, Diagonal(nrow(a))))
250    
251  setMethod("solve", signature(a = "Matrix", b = "numeric"),  setMethod("solve", signature(a = "Matrix", b = "numeric"),
252            function(a, b, ...) callGeneric(a, as.matrix(b)))            function(a, b, ...) callGeneric(a, Matrix(b)))
253    setMethod("solve", signature(a = "Matrix", b = "matrix"),
254              function(a, b, ...) callGeneric(a, Matrix(b)))
255    setMethod("solve", signature(a = "matrix", b = "Matrix"),
256              function(a, b, ...) callGeneric(Matrix(a), b))
257    
258    ## when no sub-class method is found, bail out
259    setMethod("solve", signature(a = "Matrix", b = "Matrix"),
260              function(a, b, ...) .bail.out.2("solve", class(a), class(b)))
261    
262  ## bail-out methods in order to get better error messages  ## bail-out methods in order to get better error messages
263  setMethod("%*%", signature(x = "Matrix", y = "Matrix"),  setMethod("%*%", signature(x = "Matrix", y = "Matrix"),
# Line 180  Line 269 
269            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
270  setMethod("crossprod", signature(x = "ANY", y = "Matrix"),  setMethod("crossprod", signature(x = "ANY", y = "Matrix"),
271            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))            function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
272    setMethod("tcrossprod", signature(x = "Matrix", y = "ANY"),
273              function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
274    setMethod("tcrossprod", signature(x = "ANY", y = "Matrix"),
275              function (x, y = NULL) .bail.out.2(.Generic, class(x), class(y)))
276    
277    ## cheap fallbacks
278    setMethod("crossprod", signature(x = "Matrix", y = "Matrix"),
279              function(x, y = NULL) t(x) %*% y)
280    setMethod("tcrossprod", signature(x = "Matrix", y = "Matrix"),
281              function(x, y = NULL) x %*% t(y))
282    
283  ## There are special sparse methods; this is a "fall back":  ## There are special sparse methods; this is a "fall back":
284  setMethod("kronecker", signature(X = "Matrix", Y = "ANY",  setMethod("kronecker", signature(X = "Matrix", Y = "ANY",
285                                   FUN = "ANY", make.dimnames = "ANY"),                                   FUN = "ANY", make.dimnames = "ANY"),
286            function(X, Y, FUN, make.dimnames, ...) {            function(X, Y, FUN, make.dimnames, ...) {
287                  if(is(X, "sparseMatrix"))
288                      warning("using slow kronecker() method")
289                X <- as(X, "matrix") ; Matrix(callGeneric()) })                X <- as(X, "matrix") ; Matrix(callGeneric()) })
290    
291  setMethod("kronecker", signature(X = "ANY", Y = "Matrix",  setMethod("kronecker", signature(X = "ANY", Y = "Matrix",
292                                   FUN = "ANY", make.dimnames = "ANY"),                                   FUN = "ANY", make.dimnames = "ANY"),
293            function(X, Y, FUN, make.dimnames, ...) {            function(X, Y, FUN, make.dimnames, ...) {
294                  if(is(Y, "sparseMatrix"))
295                      warning("using slow kronecker() method")
296                Y <- as(Y, "matrix") ; Matrix(callGeneric()) })                Y <- as(Y, "matrix") ; Matrix(callGeneric()) })
297    
298    
299    ## FIXME: All of these should never be called
300    setMethod("chol", signature(x = "Matrix"),
301              function(x, pivot = FALSE) .bail.out.1(.Generic, class(x)))
302    setMethod("determinant", signature(x = "Matrix"),
303              function(x, logarithm = TRUE) .bail.out.1(.Generic, class(x)))
304    
305    setMethod("diag", signature(x = "Matrix"),
306              function(x, nrow, ncol) .bail.out.1(.Generic, class(x)))
307  setMethod("t", signature(x = "Matrix"),  setMethod("t", signature(x = "Matrix"),
308            function(x) .bail.out.1(.Generic, class(x)))            function(x) .bail.out.1(.Generic, class(x)))
309    
310  ## Group Methods  setMethod("norm", signature(x = "Matrix", type = "character"),
311  setMethod("+", signature(e1 = "Matrix", e2 = "missing"), function(e1) e1)            function(x, type, ...) .bail.out.1(.Generic, class(x)))
312  ## "fallback":  setMethod("rcond", signature(x = "Matrix", type = "character"),
313  setMethod("-", signature(e1 = "Matrix", e2 = "missing"),            function(x, type, ...) .bail.out.1(.Generic, class(x)))
314            function(e1) {  
315                warning("inefficient method used for \"- e1\"")  
316                0-e1  ## for all :
317    setMethod("norm", signature(x = "ANY", type = "missing"),
318              function(x, type, ...) norm(x, type = "O", ...))
319    setMethod("rcond", signature(x = "ANY", type = "missing"),
320              function(x, type, ...) rcond(x, type = "O", ...))
321    
322    
323    
324    
325    
326    ## MM: More or less "Cut & paste" from
327    ## --- diff.default() from  R/src/library/base/R/diff.R :
328    setMethod("diff", signature(x = "Matrix"),
329              function(x, lag = 1, differences = 1, ...) {
330                  if (length(lag) > 1 || length(differences) > 1 ||
331                      lag < 1 || differences < 1)
332                      stop("'lag' and 'differences' must be integers >= 1")
333                  xlen <- nrow(x)
334                  if (lag * differences >= xlen)
335                      return(x[,FALSE][0])  # empty of proper mode
336    
337                  i1 <- -1:-lag
338                  for (i in 1:differences)
339                      x <- x[i1, , drop = FALSE] -
340                          x[-nrow(x):-(nrow(x)-lag+1), , drop = FALSE]
341                  x
342            })            })
343    
344  ## bail-outs:  setMethod("image", "Matrix",
345  setMethod("Compare", signature(e1 = "Matrix", e2 = "Matrix"),            function(x, ...) { # coercing to sparse is not inefficient,
346            function(e1, e2) {                ##               since we need 'i' and 'j' for levelplot()
347                d <- dimCheck(e1,e2)                x <- as(as(x, "sparseMatrix"), "dMatrix")
348                .bail.out.2(.Generic, class(e1), class(e2))                callGeneric()
349            })            })
 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)))  
350    
351    
352    ## Group Methods
353    
354    ##-> see ./Ops.R
355    ##         ~~~~~
356    ## For all  non-dMatrix objects, and note that  "all" and "any" have their own
357    setMethod("Summary", signature(x = "Matrix", na.rm = "ANY"),
358              function(x, ..., na.rm)
359              callGeneric(as(x,"dMatrix"), ..., na.rm = na.rm))
360    
361    
362  ### --------------------------------------------------------------------------  ### --------------------------------------------------------------------------
363  ###  ###
# Line 228  Line 370 
370  ## "x[]":  ## "x[]":
371  setMethod("[", signature(x = "Matrix",  setMethod("[", signature(x = "Matrix",
372                           i = "missing", j = "missing", drop = "ANY"),                           i = "missing", j = "missing", drop = "ANY"),
373            function (x, i, j, drop) x)            function (x, i, j, ..., drop) x)
374    
375  ## missing 'drop' --> 'drop = TRUE'  ## missing 'drop' --> 'drop = TRUE'
376  ##                     -----------  ##                     -----------
377  ## select rows  ## select rows
378  setMethod("[", signature(x = "Matrix", i = "index", j = "missing",  setMethod("[", signature(x = "Matrix", i = "index", j = "missing",
379                           drop = "missing"),                           drop = "missing"),
380            function(x,i,j, drop) callGeneric(x, i=i, drop= TRUE))            function(x,i,j, ..., drop) {
381                  if(nargs() == 1) { ## e.g. M[0] , M[TRUE],  M[1:2]
382                      if(any(i)) as.vector(x)[i] else as.vector(x[1,1])[FALSE]
383                  } else callGeneric(x, i=i, drop= TRUE)})
384    
385  ## select columns  ## select columns
386  setMethod("[", signature(x = "Matrix", i = "missing", j = "index",  setMethod("[", signature(x = "Matrix", i = "missing", j = "index",
387                           drop = "missing"),                           drop = "missing"),
388            function(x,i,j, drop) callGeneric(x, j=j, drop= TRUE))            function(x,i,j, ..., drop) callGeneric(x, j=j, drop= TRUE))
389  setMethod("[", signature(x = "Matrix", i = "index", j = "index",  setMethod("[", signature(x = "Matrix", i = "index", j = "index",
390                           drop = "missing"),                           drop = "missing"),
391            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))
392    
393  ## bail out if any of (i,j,drop) is "non-sense"  ## bail out if any of (i,j,drop) is "non-sense"
394  setMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY", drop = "ANY"),  setMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY", drop = "ANY"),
395            function(x,i,j, drop)            function(x,i,j, ..., drop)
396            stop("invalid or not-yet-implemented 'Matrix' subsetting"))            stop("invalid or not-yet-implemented 'Matrix' subsetting"))
397    
398  ##  "logical *vector* indexing, such as  M [ M >= 10 ] :  ## logical indexing, such as M[ M >= 7 ] *BUT* also M[ M[,1] >= 3,],
399  setMethod("[", signature(x = "Matrix", i = "lMatrix", j = "missing",  ## The following is *both* for    M [ <logical>   ]
400                           drop = "ANY"),  ##                 and also for   M [ <logical> , ]
401            function (x, i, j, drop) {  .M.sub.i.logical <- function (x, i, j, ..., drop)
402    {
403        nA <- nargs()
404        if(nA == 2) { ##  M [ M >= 7 ]
405            ## FIXME: when both 'x' and 'i' are sparse, this can be very inefficient
406                as(x, geClass(x))@x[as.vector(i)]                as(x, geClass(x))@x[as.vector(i)]
407                                          # -> error when lengths don't match          ## -> error when lengths don't match
408            })      } else if(nA == 3) { ##  M [ M[,1, drop=FALSE] >= 7, ]
409            stop("not-yet-implemented 'Matrix' subsetting") ## FIXME
410    
411        } else stop("nargs() = ", nA,
412                    ".  Extraneous illegal arguments inside '[ .. ]' (i.logical)?")
413    }
414    setMethod("[", signature(x = "Matrix", i = "lMatrix", j = "missing",
415                             drop = "ANY"),
416              .M.sub.i.logical)
417  setMethod("[", signature(x = "Matrix", i = "logical", j = "missing",  setMethod("[", signature(x = "Matrix", i = "logical", j = "missing",
418                           drop = "ANY"),                           drop = "ANY"),
419            function (x, i, j, drop) as(x, geClass(x))@x[i])            .M.sub.i.logical)
420    
421    
422    ## A[ ij ]  where ij is (i,j) 2-column matrix :
423    .M.sub.i.2col <- function (x, i, j, ..., drop)
424    {
425        nA <- nargs()
426        if(nA == 2) { ##  M [ cbind(ii,jj) ]
427            if(!is.integer(nc <- ncol(i)))
428                stop("'i' has no integer column number",
429                     " should never happen; please report")
430            if(is.logical(i))
431                return(.M.sub.i.logical(x,i,j,drop))
432            else if(!is.numeric(i) || nc != 2)
433                stop("such indexing must be by logical or 2-column numeric matrix")
434            m <- nrow(i)
435            if(m == 0) return(vector(mode = .type.kind[.M.kind(x)]))
436            ## else
437            i1 <- i[,1]
438            i2 <- i[,2]
439            ## potentially inefficient -- FIXME --
440            unlist(lapply(seq_len(m), function(j) x[i1[j], i2[j]]))
441    
442  ## "FIXME:"      } else stop("nargs() = ", nA,
443  ## How can we get at   A[ ij ]  where ij is (i,j) 2-column matrix?                  ".  Extraneous illegal arguments inside '[ .. ]' (i.2col)?")
444  ##  and                A[ LL ]  where LL is a logical *vector*  }
445  ## -> [.data.frame uses nargs() - can we do this in the *generic* ?  setMethod("[", signature(x = "Matrix", i = "matrix", j = "missing"),# drop="ANY"
446              .M.sub.i.2col)
447    
448    
449  ### "[<-" : -----------------  ### "[<-" : -----------------
# Line 274  Line 452 
452  setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "missing",  setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "missing",
453                                  value = "ANY"),## double/logical/...                                  value = "ANY"),## double/logical/...
454            function (x, value) {            function (x, value) {
455                x@x <- value                ## Fails for 'nMatrix' ... FIXME : make sure have method there
456                  x@x <- rep(value, length = length(x@x))
457                validObject(x)# check if type and lengths above match                validObject(x)# check if type and lengths above match
458                x                x
459            })            })
460    
461  ## Method for all 'Matrix' kinds (rather than incomprehensible error messages);  ## A[ ij ] <- value,  where ij is (i,j) 2-column matrix :
462    ## ----------------
463    ## The cheap general method --- FIXME: provide special ones; done for Tsparse..
464    ## NOTE:  need '...' below such that setMethod() does
465    ##        not use .local() such that nargs() will work correctly:
466    .M.repl.i.2col <- function (x, i, j, ..., value)
467    {
468        nA <- nargs()
469        if(nA == 3) { ##  M [ cbind(ii,jj) ] <- value
470            if(!is.integer(nc <- ncol(i)))
471                stop("'i' has no integer column number",
472                     " should never happen; please report")
473            else if(!is.numeric(i) || nc != 2)
474                stop("such indexing must be by logical or 2-column numeric matrix")
475            if(is.logical(i)) {
476                message(".M.repl.i.2col(): drop 'matrix' case ...")
477                i <- c(i) # drop "matrix"
478                return( callNextMethod() )
479            }
480            if(!is.integer(i)) storage.mode(i) <- "integer"
481            if(any(i < 0))
482                stop("negative values are not allowed in a matrix subscript")
483            if(any(is.na(i)))
484                stop("NAs are not allowed in subscripted assignments")
485            if(any(i0 <- (i == 0))) # remove them
486                i <- i[ - which(i0, arr.ind = TRUE)[,"row"], ]
487            ## now have integer i >= 1
488            m <- nrow(i)
489            ## mod.x <- .type.kind[.M.kind(x)]
490            if(length(value) > 0 && m %% length(value) != 0)
491                warning("number of items to replace is not a multiple of replacement length")
492            ## recycle:
493            value <- rep(value, length = m)
494            i1 <- i[,1]
495            i2 <- i[,2]
496            ## inefficient -- FIXME -- (also loses "symmetry" unnecessarily)
497            for(k in seq_len(m))
498                x[i1[k], i2[k]] <- value[k]
499    
500            x
501        } else stop("nargs() = ", nA,
502                    ".  Extraneous illegal arguments inside '[ .. ]' ?")
503    }
504    
505    setReplaceMethod("[", signature(x = "Matrix", i = "matrix", j = "missing",
506                                    value = "replValue"),
507              .M.repl.i.2col)
508    
509    
510    setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "ANY",
511                                    value = "Matrix"),
512                     function (x, i, j, ..., value)
513                     callGeneric(x=x, j=j, value = as.vector(value)))
514    
515    setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "missing",
516                                    value = "Matrix"),
517                     function (x, i, j, ..., value)
518                     callGeneric(x=x, i=i, value = as.vector(value)))
519    
520    setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",
521                                    value = "Matrix"),
522                     function (x, i, j, ..., value)
523                     callGeneric(x=x, i=i, j=j, value = as.vector(value)))
524    
525    setReplaceMethod("[", signature(x = "Matrix", i = "missing", j = "ANY",
526                                    value = "matrix"),
527                     function (x, i, j, ..., value)
528                     callGeneric(x=x, j=j, value = c(value)))
529    
530    setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "missing",
531                                    value = "matrix"),
532                     function (x, i, j, ..., value)
533                     callGeneric(x=x, i=i, value = c(value)))
534    
535    setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",
536                                    value = "matrix"),
537                     function (x, i, j, value)
538                     callGeneric(x=x, i=i, j=j, value = c(value)))
539    
540  ## (ANY,ANY,ANY) is used when no `real method' is implemented :  ## (ANY,ANY,ANY) is used when no `real method' is implemented :
541  setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",  setReplaceMethod("[", signature(x = "Matrix", i = "ANY", j = "ANY",
542                                  value = "ANY"),                                  value = "ANY"),
543            function (x, i, j, value) {            function (x, i, j, value) {
544                if(!is.atomic(value))                if(!is.atomic(value))
545                    stop("RHS 'value' must match matrix class ", class(x))                    stop(sprintf("RHS 'value' (class %s) matches 'ANY', but must match matrix class %s",
546                                   class(value),class(x)))
547                else stop("not-yet-implemented 'Matrix[<-' method")                else stop("not-yet-implemented 'Matrix[<-' method")
548            })            })
   
   
 ## 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.2081

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