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 10 - (view) (download) (as text)
Original Path: pkg/man/sscChol-class.Rd

1 : bates 10 \name{sscChol-class}
2 :     \docType{class}
3 :     \alias{sscChol-class}
4 :     \title{Cholesky decompositions of sscMatrix objects}
5 :     \description{The class of Cholesky decompositions of symmetric, sparse
6 :     column matrices from the \code{"sscMatrix"} class.}
7 :     \section{Objects from the Class}{
8 :     Objects can be created by calls of the form \code{new("sscChol", ...)}
9 :     but are more commonly created from \code{chol} applied to an
10 :     \code{sscMatrix} object.
11 :     }
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 :     \item{\code{iperm}:}{Object of class \code{"integer"} - the inverse
19 :     permutation to the \code{perm} slot.}
20 :     \item{\code{uplo}:}{A character object indicating if the upper
21 :     triangle (\code{"U"} or \code{"u"}) or the lower triangle
22 :     (\code{"L"} or \code{"l"}) is stored. At present only the lower
23 :     triangle form is allowed.}
24 :     \item{\code{p}:}{Object of class \code{"integer"} of pointers, one
25 :     for each column, to the initial (zero-based) index of elements in
26 :     the column.}
27 :     \item{\code{i}:}{Object of class \code{"integer"} of length nnzero
28 :     (number of non-zero elements). These are the row numbers for
29 :     each non-zero element in the matrix.}
30 :     \item{\code{x}:}{Object of class \code{"numeric"} - the non-zero
31 :     elements of the matrix.}
32 :     \item{\code{factorization}:}{Object of class \code{"list"} - a list
33 :     of factorizations of the matrix. }
34 :     \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
35 :     of the matrix - must be an integer vector with exactly two
36 :     non-negative values.}
37 :     }
38 :     }
39 :     \section{Extends}{
40 :     Class \code{"tscMatrix"}, directly.
41 :     Class \code{"cscMatrix"}, by class \code{"tscMatrix"}.
42 :     }
43 :     \section{Methods}{
44 :     No methods defined with class "sscChol" in the signature.
45 :     }
46 :     %\references{}
47 :     %\author{}
48 :     %\note{}
49 :     \seealso{
50 :     \code{\link{cscMatrix-class}}
51 :     }
52 :     %\examples{}
53 :     \examples{
54 :     data(mm)
55 :     xpx = crossprod(mm)
56 :     str(xpx)
57 :     str(chol(xpx))
58 :     }
59 :     \keyword{classes}
60 :     \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