SCM

SCM Repository

[matrix] Annotation of /pkg/man/dCholCMatrix-class.Rd
ViewVC logotype

Annotation of /pkg/man/dCholCMatrix-class.Rd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 505 - (view) (download) (as text)

1 : bates 489 \name{dCholCMatrix-class}
2 : bates 10 \docType{class}
3 : bates 489 \alias{dCholCMatrix-class}
4 : maechler 505 \title{Cholesky Decompositions of dsCMatrix Objects}
5 : bates 10 \description{The class of Cholesky decompositions of symmetric, sparse
6 : maechler 505 compressed column matrices from the \code{"dsCMatrix"} class.}
7 : bates 10 \section{Objects from the Class}{
8 : maechler 505 Objects can be created by calls of the form \code{new("dCholCMatrix", ...)}
9 :     but are more commonly created from \code{chol} applied to an
10 :     \code{dsCMatrix} object.
11 : bates 10 }
12 :     \section{Slots}{
13 :     \describe{
14 :     \item{\code{perm}:}{Object of class \code{"integer"} giving the
15 :     permutation of the rows and columns chosen to minimize fill-in.
16 :     If pivoting has not been applied this will be an integer vector of
17 :     length 0.}
18 : bates 48 \item{\code{diag}:}{A character object indicating if the triangular
19 :     matrix is unit triangular or not. This slot is inherited from the
20 : bates 480 \code{"dtCMatrix"} class. It is always \code{"N"} for this class.}
21 : bates 10 \item{\code{uplo}:}{A character object indicating if the upper
22 :     triangle (\code{"U"} or \code{"u"}) or the lower triangle
23 :     (\code{"L"} or \code{"l"}) is stored. At present only the lower
24 :     triangle form is allowed.}
25 :     \item{\code{p}:}{Object of class \code{"integer"} of pointers, one
26 :     for each column, to the initial (zero-based) index of elements in
27 :     the column.}
28 :     \item{\code{i}:}{Object of class \code{"integer"} of length nnzero
29 :     (number of non-zero elements). These are the row numbers for
30 :     each non-zero element in the matrix.}
31 :     \item{\code{x}:}{Object of class \code{"numeric"} - the non-zero
32 :     elements of the matrix.}
33 : bates 476 \item{\code{factors}:}{Object of class \code{"list"} - a list
34 : bates 10 of factorizations of the matrix. }
35 :     \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
36 :     of the matrix - must be an integer vector with exactly two
37 :     non-negative values.}
38 : bates 257 \item{\code{D}:}{Object of class \code{"numeric"} - the diagonal
39 :     elements of the matrix D in the LDL' decomposition.}
40 :     \item{\code{Parent}:}{Object of class \code{"integer"} - the
41 :     elimination tree of the (possibly permuted) symmetric matrix.}
42 : bates 10 }
43 :     }
44 :     \section{Extends}{
45 : maechler 505 Class \code{"dtCMatrix"}, directly.
46 :     Class \code{"dgCMatrix"}, by class \code{"dtCMatrix"}.
47 : bates 10 }
48 :     \section{Methods}{
49 : maechler 505 No methods defined with class "dCholCMatrix" in the signature.
50 : bates 10 }
51 :     %\references{}
52 :     %\author{}
53 :     %\note{}
54 :     \seealso{
55 : bates 480 \code{\link{dgCMatrix-class}}
56 : bates 10 }
57 :     %\examples{}
58 :     \examples{
59 :     data(mm)
60 : maechler 505 xpx <- crossprod(mm)
61 : bates 10 str(xpx)
62 : maechler 505 str(ch <- chol(xpx))
63 :    
64 :     ## Visualize the sparseness:
65 :     image(xpx, main=paste("crossprod(mm) : Sparse",dQuote(class(xpx))))
66 :     image(ch, main=paste("chol (crossprod(mm)) : Sparse", dQuote(class(ch))))
67 : bates 10 }
68 :     \keyword{classes}
69 :     \keyword{algebra}

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge