SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : bates 480 \name{dgTMatrix-class}
2 : bates 10 \docType{class}
3 : bates 480 \alias{dgTMatrix-class}
4 :     \alias{+,dgTMatrix,dgTMatrix-method}
5 :     \alias{coerce,dgTMatrix,dgeMatrix-method}
6 :     \alias{coerce,dgTMatrix,matrix-method}
7 :     \alias{coerce,dgTMatrix,dgCMatrix-method}
8 :     \alias{coerce,dgTMatrix,dsCMatrix-method}
9 :     \alias{image,dgTMatrix-method}
10 :     \alias{t,dgTMatrix-method}
11 : bates 492 \alias{crossprod,dgTMatrix,missing-method}
12 :     \alias{crossprod,dgTMatrix,matrix-method}
13 :     \alias{crossprod,dgTMatrix,numeric-method}
14 :     \title{Sparse matrices in triplet form}
15 : bates 480 \description{The \code{"dgTMatrix"} class is the class of sparse
16 : bates 10 matrices stored as (possibly redundant) triplets.}
17 :     \section{Objects from the Class}{
18 : bates 480 Objects can be created by calls of the form \code{new("dgTMatrix", ...)}.
19 : bates 10 }
20 :     \section{Slots}{
21 :     \describe{
22 :     \item{\code{i}:}{Object of class \code{"integer"} - the row indices
23 :     of non-zero entries.}
24 :     \item{\code{j}:}{Object of class \code{"integer"} - the column
25 :     indices of non-zero entries. Must be the same length as slot \code{i}.}
26 :     \item{\code{x}:}{Object of class \code{"numeric"} - the (non-zero)
27 :     entry at position \code{(i,j)}. Must be the same length as slot
28 :     \code{i}. If an index pair occurs more than once the corresponding
29 :     values of slot \code{x} are added to form the element of the matrix.}
30 :     \item{\code{Dim}:}{Object of class \code{"integer"} of length 2 -
31 :     the dimensions of the matrix.}
32 :     }
33 :     }
34 :     \section{Methods}{
35 :     \describe{
36 : bates 480 \item{+}{\code{signature(e1 = "dgTMatrix", e2 = "dgTMatrix")}}
37 :     \item{coerce}{\code{signature(from = "dgTMatrix", to = "dgCMatrix")}}
38 :     \item{coerce}{\code{signature(from = "dgTMatrix", to = "dgeMatrix")}}
39 :     \item{coerce}{\code{signature(from = "dgTMatrix", to = "matrix")}}
40 :     \item{coerce}{\code{signature(from = "dgTMatrix", to = "dsCMatrix")}}
41 : bates 492 \item{crossprod}{\code{signature(x = "dgTMatrix", y = "missing")}
42 :     returns \code{t(x) \%*\% x} as an \code{dsCMatrix} object.}
43 :     \item{crossprod}{\code{signature(x = "dgTMatrix", y = "matrix")}: ... }
44 :     \item{crossprod}{\code{signature(x = "dgTMatrix", y = "numeric")}: ... }
45 : bates 480 \item{image}{\code{signature(x = "dgTMatrix")}: plots an image of
46 : bates 79 \code{x} using the \code{\link[lattice]{levelplot}} function}
47 : bates 480 \item{t}{\code{signature(x = "dgTMatrix")}: returns the transpose of
48 : bates 79 \code{x}}
49 : bates 10 }
50 :     }
51 :     %\references{}
52 :     %\author{}
53 :     \note{Triplet matrices are a convenient form in which to construct sparse
54 : bates 480 matrices after which they can be coerced to \code{dgCMatrix} objects.}
55 : bates 10 \seealso{
56 : bates 480 \code{\link{dgCMatrix-class}}
57 : bates 10 }
58 :     %\examples{}
59 :     \keyword{classes}
60 :     \keyword{algebra}

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