1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
\name{TsparseMatrix-class}
\title{Class "TsparseMatrix" of Sparse Matrices in Triplet Form}
\docType{class}
\alias{TsparseMatrix-class}
%% Methods:
\alias{coerce,TsparseMatrix,CsparseMatrix-method}
% "[" are in ./Xtrct-methods.Rd
\alias{\%*\%,TsparseMatrix,ANY-method}
\alias{\%*\%,ANY,TsparseMatrix-method}
\alias{crossprod,TsparseMatrix,missing-method}
\alias{crossprod,TsparseMatrix,ANY-method}
\alias{tcrossprod,TsparseMatrix,missing-method}
\alias{tcrossprod,TsparseMatrix,ANY-method}
\alias{colMeans,TsparseMatrix-method}
\alias{colSums,TsparseMatrix-method}
\alias{rowMeans,TsparseMatrix-method}
\alias{rowSums,TsparseMatrix-method}
\alias{t,TsparseMatrix-method}
%
\description{The \code{"TsparseMatrix"} class is the virtual class of
all sparse matrices coded in triplet form. Since it is a virtual class,
no objects may be created from it. See
\code{showClass("TsparseMatrix")} for its subclasses.
}
\section{Slots}{
\describe{
\item{\code{Dim}, \code{Dimnames}:}{from the \code{"Matrix"} class,}
\item{\code{factors}:}{from class \code{"sparseMatrix"}, see
\code{\linkS4class{sparseMatrix}}.}
\item{\code{i}:}{Object of class \code{"integer"} - the row indices
of non-zero entries \emph{in 0-base}, i.e., must be in
\code{0:(nrow(.)-1)}.}
\item{\code{j}:}{Object of class \code{"integer"} - the column
indices of non-zero entries. Must be the same length as slot
\code{i} and \emph{0-based} as well, i.e., in \code{0:(ncol(.)-1)}.}
}
}
\section{Extends}{
Class \code{"sparseMatrix"}, directly.
Class \code{"Matrix"}, by class \code{"sparseMatrix"}.
}
\section{Methods}{
Extraction (\code{"["}) methods, see
\code{\link{[-methods}}.%-> ./Xtrct-methods.Rd
}
\note{
Most operations with sparse matrices are performed using the
compressed, column-oriented or \code{\linkS4class{CsparseMatrix}}
representation. The triplet representation is convenient for
creating a sparse matrix or for reading and writing such
matrices. Once it is created, however, the matrix is generally
coerced to a \code{\linkS4class{CsparseMatrix}} for further
operations.
For convenience, methods for some operations such as \code{\%*\%}
and \code{crossprod} are defined for
\code{\linkS4class{TsparseMatrix}} objects. These methods simply
coerce the \code{\linkS4class{TsparseMatrix}} object to a
\code{\linkS4class{CsparseMatrix}} object then perform the
operation.
}
% \author{Martin Maechler}
\seealso{
its superclass, \code{\linkS4class{sparseMatrix}}, and the
\code{\linkS4class{dgTMatrix}} class, for the links to other classes.
}
\examples{
showClass("TsparseMatrix")
## or just the subclasses' names
names(getClass("TsparseMatrix")@subclasses)
}
\keyword{classes}
|
