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