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
|
\name{matrix.csr-class}
\title{Class "matrix.csr" - Sparse Matrices in Compressed Sparse Row Format}
\docType{class}
\alias{matrix.csr-class}
\alias{matrix.diag.csr-class}
\alias{show,matrixSpM-method}
\alias{show,matrix.csr.chol-method}
\description{
A class for sparse matrices stored in compressed sparse row ('csr') format.
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("matrix.csr", ...)}
and coerced from various other formats. Coercion of integer scalars
and vectors into identity matrices and diagonal matrices respectively
is accomplished by \code{as(x,"matrix.diag.csr")} which generates an
object that has all the rights and responsibilties of the \code{"matrix.csr"} class.
The default \code{"matrix.csr"} object, i.e., \code{new("matrix.csr")}, is
a scalar (1 by 1) matrix with element 0.
}
\section{Slots}{
\describe{
\item{\code{ra}:}{Object of class \code{numeric}, a real array of nnz elements containing the non-zero
elements of A, stored in row order. Thus, if \eqn{i < j}, all elements
of row i precede elements from row j. The order of elements
within the rows is immaterial.}
\item{\code{ja}:}{Object of class \code{integer}, an integer array of nnz elements containing the column
indices of the elements stored in \code{ra}.}
\item{\code{ia}:}{A class \code{integer} array of n+1 elements containing pointers to
the beginning of each row in the arrays \code{ra} and \code{ja}. Thus
`ia[i]' indicates the position in the arrays \code{ra} and \code{ja}
where the ith row begins. The last, (n+1)st, element of \code{ia}
indicates where the n+1 row would start, if it existed.}
\item{\code{dimension}:}{An \code{integer}, dimension of the matrix }
}
}
\section{Methods}{
\describe{
\item{\%*\%}{\code{signature(x = "matrix.csr", y = "matrix.csr")}: ... }
\item{\%*\%}{\code{signature(x = "matrix.csr", y = "matrix")}: ... }
\item{\%*\%}{\code{signature(x = "matrix.csr", y = "numeric")}: ... }
\item{\%*\%}{\code{signature(x = "matrix", y = "matrix.csr")}: ... }
\item{\%*\%}{\code{signature(x = "numeric", y = "matrix.csr")}: ... }
\item{as.matrix.csc}{\code{signature(x = "matrix.csr")}: ... }
\item{as.matrix.ssc}{\code{signature(x = "matrix.csr")}: ... }
\item{as.matrix.ssr}{\code{signature(x = "matrix.csr")}: ... }
\item{as.matrix.coo}{\code{signature(x = "matrix.csr")}: ... }
\item{as.matrix}{\code{signature(x = "matrix.csr")}: ... }
\item{chol}{\code{signature(x = "matrix.csr")}: ... }
\item{diag}{\code{signature(x = "matrix.csr")}: ... }
\item{diag<-}{\code{signature(x = "matrix.csr")}: ... }
\item{dim}{\code{signature(x = "matrix.csr")}: ... }
\item{image}{\code{signature(x = "matrix.csr")}: ... }
\item{solve}{\code{signature(a = "matrix.csr")}: ... }
\item{t}{\code{signature(x = "matrix.csr")}: ... }
\item{diff}{\code{signature(x = "matrix.csr")}: ... }
% those for signature "matrix.diag.csr" ----------
\item{diag<-}{\code{signature(x = "matrix.diag.csr")}: ... }
}
}
\seealso{\code{\link{matrix.csc-class}}
}
\examples{
new("matrix.csr") # the 1x1 matrix [0]
new("matrix.diag.csr") # the 'same'
as(1:5, "matrix.diag.csr") # a sparse version of diag(1:5)
}
\keyword{classes}
|
