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{ddiMatrix-class}
\title{Class "ddiMatrix" of Diagonal Numeric Matrices}
\docType{class}
\alias{ddiMatrix-class}
% Deprecated:
\alias{coerce,ddiMatrix,dgCMatrix-method}
\alias{coerce,ddiMatrix,dgTMatrix-method}
%
\alias{chol,ddiMatrix,ANY-method}
\description{The class \code{"ddiMatrix"} of numerical diagonal matrices.
%% FIXME add more
Note that diagonal matrices extend \emph{dense}, not sparse matrices.
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("ddiMatrix", ...)}
but typically rather via \code{\link{Diagonal}}.
}
\section{Slots}{
\describe{
\item{\code{x}:}{numeric vector. For an \eqn{n \times n}{n * n}
matrix, the \code{x} slot is of length \eqn{n} or \code{0},
depending on the \code{diag} slot:}
\item{\code{diag}:}{\code{"character"} string, either \code{"U"} or
\code{"N"} where \code{"U"} denotes unit-diagonal, i.e., identity
matrices.}
\item{\code{Dim},\code{Dimnames}:}{matrix dimension and
\code{\link{dimnames}}, see the \code{\linkS4class{Matrix}} class
description.}
}
}
\section{Extends}{
Class \code{"\linkS4class{diagonalMatrix}"}, directly.
Class \code{"\linkS4class{ddenseMatrix}"}, directly.
Classes \code{"denseMatrix"} and \code{"dMatrix"} and their super
classes, indirectly, see \code{\link{showClass}("ddiMatrix")}.
}
\section{Methods}{
\describe{
\item{\%*\%}{\code{signature(x = "ddiMatrix", y = "ddiMatrix")}: ... }
}
}
\seealso{
Class \code{\linkS4class{diagonalMatrix}} and function \code{\link{Diagonal}}.
}
\examples{
(d2 <- Diagonal(x = c(10,1)))
str(d2)
## slightly larger in internal size:
str(as(d2, "sparseMatrix"))
M <- Matrix(cbind(1,2:4))
M \%*\% d2 #> `fast' multiplication
chol(d2) # trivial
}
\keyword{classes}
|
