# SCM Repository

[matrix] View of /pkg/man/dCholCMatrix-class.Rd
 [matrix] / pkg / man / dCholCMatrix-class.Rd

# View of /pkg/man/dCholCMatrix-class.Rd

Mon Mar 22 20:20:05 2004 UTC (15 years, 7 months ago) by bates
Original Path: pkg/man/sscChol-class.Rd
File size: 2152 byte(s)
Initial import
\name{sscChol-class}
\docType{class}
\alias{sscChol-class}
\title{Cholesky decompositions of sscMatrix objects}
\description{The class of Cholesky decompositions of symmetric, sparse
column matrices from the \code{"sscMatrix"} class.}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("sscChol", ...)}
but are more commonly created from \code{chol} applied to an
\code{sscMatrix} object.
}
\section{Slots}{
\describe{
\item{\code{perm}:}{Object of class \code{"integer"} giving the
permutation of the rows and columns chosen to minimize fill-in.
If pivoting has not been applied this will be an integer vector of
length 0.}
\item{\code{iperm}:}{Object of class \code{"integer"} - the inverse
permutation to the \code{perm} slot.}
\item{\code{uplo}:}{A character object indicating if the upper
triangle (\code{"U"} or \code{"u"}) or the lower triangle
(\code{"L"} or \code{"l"}) is stored.  At present only the lower
triangle form is allowed.}
\item{\code{p}:}{Object of class \code{"integer"} of pointers, one
for each column, to the initial (zero-based) index of elements in
the column.}
\item{\code{i}:}{Object of class \code{"integer"} of length nnzero
(number of non-zero elements).  These are the row numbers for
each non-zero element in the matrix.}
\item{\code{x}:}{Object of class \code{"numeric"} - the non-zero
elements of the matrix.}
\item{\code{factorization}:}{Object of class \code{"list"} - a list
of factorizations of the matrix. }
\item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
of the matrix - must be an integer vector with exactly two
non-negative values.}
}
}
\section{Extends}{
Class \code{"tscMatrix"}, directly.
Class \code{"cscMatrix"}, by class \code{"tscMatrix"}.
}
\section{Methods}{
No methods defined with class "sscChol" in the signature.
}
%\references{}
%\author{}
%\note{}
\seealso{
}
%\examples{}
\examples{
data(mm)
xpx = crossprod(mm)
str(xpx)
str(chol(xpx))
}
\keyword{classes}
\keyword{algebra}