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 396 - (view) (download) (as text)
Original Path: pkg/man/tripletMatrix-class.Rd

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