SCM

SCM Repository

[matrix] Annotation of /pkg/Matrix/man/boolean-matprod.Rd
ViewVC logotype

Annotation of /pkg/Matrix/man/boolean-matprod.Rd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3069 - (view) (download) (as text)

1 : mmaechler 3069 \name{\%&\%-methods}
2 :     \title{Boolean Arithmetic Matrix Products: \code{\%&\%} and Methods}
3 :     \docType{methods}
4 :     \alias{\%&\%}
5 :     \alias{\%&\%-methods}
6 :     \alias{\%&\%,ANY,ANY-method}
7 :     \alias{\%&\%,ANY,matrix-method}
8 :     \alias{\%&\%,ANY,Matrix-method}
9 :     \alias{\%&\%,matrix,ANY-method}
10 :     \alias{\%&\%,Matrix,ANY-method}
11 :     \alias{\%&\%,matrix,matrix-method}
12 :     \alias{\%&\%,Matrix,Matrix-method}
13 :     \alias{\%&\%,mMatrix,mMatrix-method}
14 :     \alias{\%&\%,mMatrix,nMatrix-method}
15 :     \alias{\%&\%,nMatrix,mMatrix-method}
16 :     \alias{\%&\%,nMatrix,nMatrix-method}
17 :     \alias{\%&\%,nMatrix,nsparseMatrix-method}
18 :     \alias{\%&\%,nsparseMatrix,nMatrix-method}
19 :     \alias{\%&\%,nsparseMatrix,nsparseMatrix-method}
20 :     \alias{\%&\%,nCsparseMatrix,nCsparseMatrix-method}
21 :     \alias{\%&\%,nCsparseMatrix,nsparseMatrix-method}
22 :     \alias{\%&\%,nsparseMatrix,nCsparseMatrix-method}
23 :     \alias{\%&\%,diagonalMatrix,geMatrix-method}
24 :     \alias{\%&\%,geMatrix,diagonalMatrix-method}
25 :     \alias{\%&\%,CsparseMatrix,diagonalMatrix-method}
26 :     \alias{\%&\%,diagonalMatrix,CsparseMatrix-method}
27 :     \alias{\%&\%,diagonalMatrix,diagonalMatrix-method}
28 :     \alias{\%&\%,diagonalMatrix,sparseMatrix-method}
29 :     \alias{\%&\%,sparseMatrix,diagonalMatrix-method}
30 :    
31 :     \description{
32 :     For boolean or \dQuote{patter\bold{n}} matrices, i.e., \R object of
33 :     class \code{\linkS4class{nMatrix}}, it is natural to allow matrix
34 :     products using boolean instead of numerical arithmetic.
35 :    
36 :     In package \pkg{Matrix}, we use the (\dQuote{infix}) function aka
37 :     binary operator \code{\%&\%} for this and provide methods for all our
38 :     matrices and the traditional \R matrices (see \code{\link{matrix}}).
39 :     }
40 :     \section{Methods}{
41 :     We provide methods for both the \dQuote{traditional} (\R base) matrices
42 :     and conceptually all matrices in package \pkg{Matrix}.
43 :     \describe{
44 :     \item{\code{signature(x = "ANY", y = "ANY")}}{
45 :     }
46 :    
47 :     \item{\code{signature(x = "ANY", y = "matrix")}}{
48 :     }
49 :    
50 :     \item{\code{signature(x = "ANY", y = "Matrix")}}{
51 :     }
52 :    
53 :     \item{\code{signature(x = "matrix", y = "ANY")}}{
54 :     }
55 :    
56 :     \item{\code{signature(x = "Matrix", y = "ANY")}}{
57 :     }
58 :    
59 :     \item{\code{signature(x = "matrix", y = "matrix")}}{
60 :     }
61 :    
62 :     \item{\code{signature(x = "Matrix", y = "Matrix")}}{
63 :     }
64 :    
65 :     \item{\code{signature(x = "Matrix", y = "nMatrix")}}{
66 :     }
67 :    
68 :     \item{\code{signature(x = "nMatrix", y = "Matrix")}}{
69 :     }
70 :    
71 :     \item{\code{signature(x = "nMatrix", y = "nMatrix")}}{
72 :     }
73 :    
74 :     \item{\code{signature(x = "nMatrix", y = "nsparseMatrix")}}{
75 :     }
76 :    
77 :     \item{\code{signature(x = "nsparseMatrix", y = "nMatrix")}}{
78 :     }
79 :    
80 :     \item{\code{signature(x = "nsparseMatrix", y = "nsparseMatrix")}}{
81 :     }
82 :     }% {describe}
83 :     }% {Methods}
84 :     \value{
85 :     a pattern matrix, i.e., inheriting from \code{"\linkS4class{nMatrix}"},
86 :     or an \code{"\linkS4class{ldiMatrix}"} in case of a diagonal matrix.
87 :     }
88 :     \examples{
89 :     set.seed(7)
90 :     L <- Matrix(rnorm(20) > 1, 4,5)
91 :     (N <- as(L, "nMatrix"))
92 :     D <- Matrix(round(rnorm(30)), 5,6) # -> values in -1:1 (for this seed)
93 :     L \%&\% D
94 :     stopifnot(identical(L \%&\% D, N \%&\% D),
95 :     all(L \%&\% D == as((L \%*\% abs(D)) > 0, "sparseMatrix")))
96 :     \dontshow{% maybe move to ../tests/matprod.R later
97 :     ## for "many" more seeds:
98 :     for(nn in 1:256) {
99 :     L <- Matrix(rnorm(20) > 1, 4,5)
100 :     D <- Matrix(round(rnorm(30)), 5,6)
101 :     stopifnot(all(L \%&\% D == as((L \%*\% abs(D)) > 0, "sparseMatrix")))
102 :     }
103 :     }%dont
104 :     %% Fails currently :
105 :     %% crossprod(D, boolArith = TRUE)
106 :     }
107 :     \keyword{methods}
108 :    

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