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
74
75
76
77
78
79
80
81
82
|
\name{diagonalMatrix-class}
\title{Class "diagonalMatrix" of Diagonal Matrices}
\docType{class}
\alias{diagonalMatrix-class}
\alias{coerce,matrix,diagonalMatrix-method}
\alias{coerce,diagonalMatrix,generalMatrix-method}
\alias{coerce,diagonalMatrix,triangularMatrix-method}
\alias{coerce,diagonalMatrix,matrix-method}
\alias{coerce,diagonalMatrix,sparseMatrix-method}
\alias{coerce,diagonalMatrix,CsparseMatrix-method}
\alias{coerce,Matrix,diagonalMatrix-method}
\alias{Ops,diagonalMatrix,diagonalMatrix-method}
\alias{Ops,diagonalMatrix,ddiMatrix-method}
\alias{Ops,ddiMatrix,diagonalMatrix-method}
\alias{Ops,diagonalMatrix,ANY-method}
\alias{Ops,ANY,diagonalMatrix-method}
\alias{t,diagonalMatrix-method}
\alias{diag,diagonalMatrix-method}
\alias{show,diagonalMatrix-method}
\alias{\%*\%,dgeMatrix,diagonalMatrix-method}
\alias{\%*\%,sparseMatrix,diagonalMatrix-method}
\alias{\%*\%,matrix,diagonalMatrix-method}
\alias{\%*\%,diagonalMatrix,dgeMatrix-method}
\alias{\%*\%,diagonalMatrix,diagonalMatrix-method}
\alias{\%*\%,diagonalMatrix,matrix-method}
\alias{\%*\%,diagonalMatrix,sparseMatrix-method}
\alias{crossprod,diagonalMatrix,dgeMatrix-method}
\alias{crossprod,diagonalMatrix,diagonalMatrix-method}
\alias{crossprod,diagonalMatrix,matrix-method}
\alias{crossprod,diagonalMatrix,missing-method}
\alias{crossprod,diagonalMatrix,sparseMatrix-method}
\alias{crossprod,sparseMatrix,diagonalMatrix-method}
\alias{tcrossprod,diagonalMatrix,diagonalMatrix-method}
\alias{tcrossprod,diagonalMatrix,sparseMatrix-method}
\alias{tcrossprod,diagonalMatrix,matrix-method}
\alias{tcrossprod,diagonalMatrix,missing-method}
\alias{tcrossprod,sparseMatrix,diagonalMatrix-method}
\description{
Class "diagonalMatrix" is the virtual class of all diagonal matrices.
}
\section{Objects from the Class}{A virtual Class: No objects may be
created from it.}
\section{Slots}{
\describe{
\item{\code{diag}:}{code{"character"} string, either \code{"U"} or
\code{"N"}, where \code{"U"} means \sQuote{unit-diagonal}.}
\item{\code{Dim}:}{matrix dimension, and}
\item{\code{Dimnames}:}{the \code{\link{dimnames}}, a
\code{\link{list}}, see the \code{\linkS4class{Matrix}} class
description. Typically \code{list(NULL,NULL)} for diagonal matrices.}
}
}
\section{Extends}{
Class \code{"\linkS4class{denseMatrix}"}, directly.
}
\section{Methods}{
\describe{
\item{coerce}{\code{signature(from = "matrix", to = "diagonalMatrix")}: ... }
\item{coerce}{\code{signature(from = "diagonalMatrix", to = "triangularMatrix")}: ... }
\item{coerce}{\code{signature(from = "diagonalMatrix", to = "matrix")}: ... }
\item{coerce}{\code{signature(from = "Matrix", to = "diagonalMatrix")}: ... }
\item{t}{\code{signature(x = "diagonalMatrix")}: ... }
\item{\%*\%}{\code{signature(x = "dgeMatrix", y = "diagonalMatrix")}: ... }
\item{\%*\%}{\code{signature(x = "matrix", y = "diagonalMatrix")}: ... }
\item{\%*\%}{\code{signature(x = "diagonalMatrix", y = "matrix")}: ... }
\item{\%*\%}{\code{signature(x = "diagonalMatrix", y = "dgeMatrix")}: ... }
}
}
\seealso{
\code{\linkS4class{ddiMatrix}} and \code{\linkS4class{ldiMatrix}} are
\dQuote{actual} classes extending \code{"diagonalMatrix"}.
}
\examples{
I5 <- Diagonal(5)
D5 <- Diagonal(x = 10*(1:5))
## trivial (but explicitly defined) methods:
stopifnot(identical(crossprod(I5), I5),
identical(tcrossprod(I5), I5),
identical(crossprod(I5, D5), D5),
identical(tcrossprod(D5, I5), D5))
}
\keyword{classes}
|
