SCM

SCM Repository

[matrix] Annotation of /pkg/man/dMatrix-class.Rd
ViewVC logotype

Annotation of /pkg/man/dMatrix-class.Rd

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : maechler 606 \name{dMatrix-class}
2 :     \docType{class}
3 :     \alias{dMatrix-class}
4 : bates 723 \alias{lMatrix-class}
5 : maechler 1548 %
6 : maechler 606 \alias{show,dMatrix-method}
7 : maechler 621 \alias{coerce,dMatrix,matrix-method}
8 : maechler 1548 \alias{coerce,dMatrix,lMatrix-method}
9 :     \alias{coerce,lMatrix,dMatrix-method}
10 : maechler 1331 %\alias{coerce,dMatrix,dgeMatrix-method}
11 : maechler 1226 \alias{[,dMatrix,lMatrix,missing,ANY-method}
12 :     \alias{[,dMatrix,logical,missing,ANY-method}
13 : maechler 606 % Group methods
14 : maechler 1456 \alias{Arith,dMatrix,dMatrix-method}
15 : maechler 606 \alias{Math2,dMatrix,numeric-method}% Math2 = round + signif, but
16 : maechler 1329 \alias{Math2,dMatrix,missing-method}
17 : maechler 946 \alias{Summary,dMatrix-method}
18 : maechler 956 \alias{Compare,dMatrix,dMatrix-method}
19 : maechler 946 \alias{Compare,dMatrix,numeric-method}
20 : maechler 956 \alias{Compare,numeric,dMatrix-method}
21 : maechler 925 % for silly reasons, need these 2+3 as well:
22 : maechler 606 \alias{round,dMatrix,numeric-method}
23 :     \alias{signif,dMatrix,numeric-method}
24 : maechler 925 \alias{log,dMatrix-method}
25 :     \alias{gamma,dMatrix-method}
26 :     \alias{lgamma,dMatrix-method}
27 :     %
28 : maechler 1389 \alias{zapsmall,dMatrix-method}
29 :     %
30 : bates 683 % operations with one argument from the "integer" class
31 :     \alias{crossprod,dMatrix,integer-method}
32 :     \alias{crossprod,integer,dMatrix-method}
33 :     \alias{solve,dMatrix,integer-method}
34 :     \alias{\%*\%,dMatrix,integer-method}
35 :     \alias{\%*\%,integer,dMatrix-method}
36 : maechler 606 \title{(Virtual) Class "dMatrix" of "double" Matrices}
37 :     \description{
38 :     The \code{dMatrix} class is a virtual class contained by all actual
39 : bates 723 classes of numeric matrices in the \pkg{Matrix} package. Similarly,
40 :     all the actual classes of logical matrices inherit from the
41 :     \code{lMatrix} class.
42 : maechler 606 }
43 :     %\section{Objects from the Class}{A virtual Class: No objects may be
44 :     % created from it.
45 :     %}
46 :     \section{Slots}{
47 :     Common to \emph{all} matrix object in the package:
48 :     \describe{
49 :     \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
50 :     of the matrix - must be an integer vector with exactly two
51 :     non-negative values.}
52 :     \item{\code{Dimnames}:}{list of length two; each component
53 :     containing NULL or a \code{\link{character}} vector length
54 :     equal the corresponding \code{Dim} element.}
55 :     }
56 :     }
57 :     \section{Methods}{
58 : maechler 1389 There are (relatively simple) group methods (see, e.g., \code{\link{Arith}})
59 : maechler 606 \describe{
60 :     \item{Arith}{\code{signature(e1 = "dMatrix", e2 = "dMatrix")}: ... }
61 :     \item{Arith}{\code{signature(e1 = "dMatrix", e2 = "numeric")}: ... }
62 :     \item{Arith}{\code{signature(e1 = "numeric", e2 = "dMatrix")}: ... }
63 :     \item{Math}{\code{signature(x = "dMatrix")}: ... }
64 : maechler 1389 \item{Math2}{\code{signature(x = "dMatrix", digits = "numeric")}:
65 :     this group contains \code{\link{round}()} and \code{\link{signif}()}.}
66 :     \item{Compare}{\code{signature(e1 = "numeric", e2 = "dMatrix")}: ... }
67 :     \item{Compare}{\code{signature(e1 = "dMatrix", e2 = "numeric")}: ... }
68 :     \item{Compare}{\code{signature(e1 = "dMatrix", e2 = "dMatrix")}: ... }
69 :     \item{Summary}{\code{signature(x = "dMatrix")}: The \code{"Summary"}
70 :     group contains the seven functions
71 :     \code{\link{max}()}, \code{\link{min}()}, \code{\link{range}()},
72 :     \code{\link{prod}()}, \code{\link{sum}()},
73 :     \code{\link{any}()}, and \code{\link{all}()}.}
74 : maechler 606 }
75 : maechler 1389 The following methods are also defined for all double matrices:
76 :     \describe{
77 :     \item{coerce}{\code{signature(from = "dMatrix", to = "matrix")}: ... }
78 :     %
79 :     \item{expm}{\code{signature(x = "dMatrix")}: computes the
80 :     \emph{\dQuote{Matrix Exponential}}, see \code{\link{expm}}.}
81 :     \item{zapsmall}{\code{signature(x = "dMatrix")}: ... }
82 :     }
83 : maechler 606 }
84 :     %\references{}
85 :     % Martin + Doug\author{Douglas Bates \email{bates@stat.wisc.edu}}
86 :     \seealso{
87 : maechler 1548 The nonzero-pattern matrix class \code{\linkS4class{nMatrix}},
88 :     and the numeric matrix classes \code{\linkS4class{dgeMatrix}},
89 : maechler 1281 \code{\linkS4class{dgCMatrix}}, and \code{\linkS4class{Matrix}}.
90 : maechler 606 }
91 : maechler 946 \examples{
92 :     showClass("dMatrix")
93 : maechler 1389
94 :     set.seed(101)
95 :     round(Matrix(rnorm(28), 4,7), 2)
96 :     (M <- zapsmall(Matrix(rlnorm(56, sd=10), 4,14)))
97 :     table(as.logical(M == 0))
98 : maechler 946 }
99 : maechler 606 \keyword{classes}
100 :     \keyword{algebra}

R-Forge@R-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business University of Wisconsin - Madison Powered By FusionForge