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
|
\name{RsparseMatrix-class}
\title{Class "RsparseMatrix" of Sparse Matrices in Row-compressed Form}
%
\docType{class}
\keyword{array}
\keyword{classes}
%
\alias{RsparseMatrix-class}
%
\alias{coerce,matrix,RsparseMatrix-method}
\alias{coerce,vector,RsparseMatrix-method}
\alias{diag,RsparseMatrix-method}
\alias{diag<-,RsparseMatrix-method}
\alias{t,RsparseMatrix-method}
%
\description{The \code{"RsparseMatrix"} class is the virtual class of
all sparse matrices coded in sorted compressed row-oriented form.
Since it is a virtual class, no objects may be created from it. See
\code{showClass("RsparseMatrix")} for its subclasses.
}
\section{Slots}{
\describe{
\item{\code{j}:}{Object of class \code{"integer"} of length \code{nnzero}
(number of non-zero elements). These are the row numbers for
each non-zero element in the matrix.}
\item{\code{p}:}{Object of class \code{"integer"} of pointers, one
for each row, to the initial (zero-based) index of elements in
the row.}
\item{\code{Dim}, \code{Dimnames}:}{inherited from
the superclass, see \code{\linkS4class{sparseMatrix}}.}
}
}
\section{Extends}{
Class \code{"sparseMatrix"}, directly.
Class \code{"Matrix"}, by class \code{"sparseMatrix"}.
}
\section{Methods}{
Originally, \bold{few} methods were defined on purpose, as we
rather use the \code{\linkS4class{CsparseMatrix}} in \pkg{Matrix}.
Then, more methods were added but \emph{beware} that these
typically do \emph{not} return \code{"RsparseMatrix"} results, but
rather Csparse* or Tsparse* ones; e.g., \code{R[i, j] <- v} for an
\code{"RsparseMatrix"} \code{R} works, but after the assignment, \code{R}
is a (triplet) \code{"TsparseMatrix"}.
\describe{
\item{t}{\code{signature(x = "RsparseMatrix")}: ... }
\item{coerce}{\code{signature(from = "RsparseMatrix", to = "CsparseMatrix")}: ... }
\item{coerce}{\code{signature(from = "RsparseMatrix", to = "TsparseMatrix")}: ... }
}
}
\seealso{
its superclass, \code{\linkS4class{sparseMatrix}}, and, e.g., class
\code{\linkS4class{dgRMatrix}} for the links to other classes.
}
\examples{
showClass("RsparseMatrix")
}
|
