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{MatrixFactorization-class}
\alias{MatrixFactorization-class}
\alias{CholeskyFactorization-class}
\docType{class}
\title{Class "MatrixFactorization" of Matrix Factorizations}
%
\alias{dim,MatrixFactorization-method}
\alias{expand,MatrixFactorization-method}
\alias{show,MatrixFactorization-method}
\alias{solve,MatrixFactorization,numeric-method}
\alias{solve,MatrixFactorization,ANY-method}
\alias{solve,MatrixFactorization,missing-method}
\description{
The class \code{"MatrixFactorization"} is the virtual (super) class of
(potentially) all matrix factorizations of matrices from package
\pkg{Matrix}.
The class \code{"CholeskyFactorization"} is the virtual class of all
Cholesky decompositions from \pkg{Matrix} (and trivial sub class of
\code{"MatrixFactorization"}).
}
\section{Objects from the Class}{A virtual Class: No objects may be
created from it.}
\section{Slots}{
\describe{
\item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
of the original matrix - must be an integer vector with exactly two
non-negative values.}
}
}
\section{Methods}{
\describe{
\item{dim}{\code{(x)} simply returns \code{x@Dim}, see above.}
\item{expand}{\code{signature(x = "MatrixFactorization")}: this has
not been implemented yet for all matrix factorizations. It should
return a list whose components are matrices which when multiplied
return the original \code{\linkS4class{Matrix}} object.}
\item{show}{\code{signature(object = "MatrixFactorization")}: simple
printing, see \code{\link{show}}.}
\item{solve}{\code{signature(a = "MatrixFactorization", b= .)}:
solve \eqn{A x = b} for \eqn{x}; has not been implemented for
all factorizations, but e.g., for \code{\linkS4class{CHMfactor}},
see there.}
}
}
\seealso{
classes inheriting from \code{"MatrixFactorization"}, such as
\code{\linkS4class{LU}},
\code{\linkS4class{Cholesky}},
\code{\linkS4class{CHMfactor}}, and
\code{\linkS4class{sparseQR}}.
}
\examples{
showClass("MatrixFactorization")
getClass("CholeskyFactorization")
}
\keyword{classes}
|
