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