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
|
\name{diagU2N}
\title{Transform Triangular Matrices from Unit Triangular to General Triangular and Back}
%
\keyword{array}
\keyword{attribute}
\keyword{utilities}
%
\alias{diagU2N}
\alias{diagN2U}
\alias{.diagU2N}
\alias{.diagN2U}
%
\description{
Transform a triangular matrix \code{x}, i.e., of \code{\link{class}}
\code{\linkS4class{triangularMatrix}},
from (internally!) unit triangular (\dQuote{unitriangular}) to
\dQuote{general} triangular (\code{diagU2N(x)}) or back (\code{diagN2U(x)}).
Note that the latter, \code{diagN2U(x)}, also sets the diagonal to one
in cases where \code{diag(x)} was not all one.
\code{.diagU2N(x)} and \code{.diagN2U(x)} assume \emph{without}
checking that \code{x} is a \code{\linkS4class{triangularMatrix}} with
suitable \code{diag} slot (\code{"U"} and \code{"N"}, respectively),
hence they should be used with care.
}
\usage{
diagU2N(x, cl = getClassDef(class(x)), checkDense = FALSE)
diagN2U(x, cl = getClassDef(class(x)), checkDense = FALSE)
.diagU2N(x, cl = getClassDef(class(x)), checkDense = FALSE)
.diagN2U(x, cl = getClassDef(class(x)), checkDense = FALSE)
}
\arguments{
\item{x}{a \code{\linkS4class{triangularMatrix}}, often sparse.}
\item{cl}{(optional, for speedup only:) class (definition) of \code{x}.}
\item{checkDense}{logical indicating if dense (see
\code{\linkS4class{denseMatrix}}) matrices should be considered at
all; i.e., when false, as per default, the result will be sparse even
when \code{x} is dense.}
}
\details{
The concept of unit triangular matrices with a \code{diag} slot of
\code{"U"} stems from LAPACK.
}
\note{Such internal storage details should rarely be of relevance to the
user. Hence, these functions really are rather \emph{internal}
utilities.
}
\value{
a triangular matrix of the same \code{\link{class}} but with a
different \code{diag} slot. For \code{diagU2N} (semantically) with
identical entries as \code{x}, whereas in \code{diagN2U(x)}, the
off-diagonal entries are unchanged and the diagonal is set to all
\code{1} even if it was not previously.
}
\seealso{
\code{"\linkS4class{triangularMatrix}"},
\code{"\linkS4class{dtCMatrix}"}.
}
\examples{
\dontshow{ % for R_DEFAULT_PACKAGES=NULL
library(stats, pos = "package:base", verbose = FALSE)
}
(T <- Diagonal(7) + triu(Matrix(rpois(49, 1/4), 7, 7), k = 1))
(uT <- diagN2U(T)) # "unitriangular"
(t.u <- diagN2U(10*T))# changes the diagonal!
stopifnot(all(T == uT), diag(t.u) == 1,
identical(T, diagU2N(uT)))
T[upper.tri(T)] <- 5 # still "dtC"
T <- diagN2U(as(T,"triangularMatrix"))
dT <- as(T, "denseMatrix") # (unitriangular)
dT.n <- diagU2N(dT, checkDense = TRUE)
sT.n <- diagU2N(dT)
stopifnot(is(dT.n, "denseMatrix"), is(sT.n, "sparseMatrix"),
dT@diag == "U", dT.n@diag == "N", sT.n@diag == "N",
all(dT == dT.n), all(dT == sT.n))
}
|
