File: matrix.csr.chol-class.Rd

package info (click to toggle)
r-cran-sparsem 1.77-1
  • links: PTS
  • area: main
  • in suites: buster
  • size: 1,992 kB
  • ctags: 483
  • sloc: fortran: 3,958; ansic: 55; makefile: 1
file content (41 lines) | stat: -rw-r--r-- 2,222 bytes parent folder | download | duplicates (4)
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
\name{matrix.csr.chol-class}
\docType{class}
\alias{matrix.csr.chol-class}
\title{Class "matrix.csr.chol"}
\description{A class of objects returned from Ng and Peyton's (1993) block
sparse Cholesky algorithm}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("matrix.csr.chol", ...)}.
}
\section{Slots}{
  \describe{
    \item{\code{nrow}:}{Object of class \code{integer}, number of rows in the linear system of equations }
    \item{\code{nnzlindx}:}{Object of class \code{numeric}, number of non-zero elements in lindx}
    \item{\code{nsuper}:}{Object of class \code{integer}, number of supernodes}
    \item{\code{lindx}:}{Object of class \code{integer}, vector of integer
containing, in column major order, the row subscripts of the non-zero entries 
in the Cholesky factor in a compressed storage format}
    \item{\code{xlindx}:}{Object of class \code{integer}, vector of integer of pointers for lindx}
    \item{\code{nnzl}:}{Object of class \code{numeric}, number of non-zero
entries, including the diagonal entries, of the Cholesky factor stored in lnz}
    \item{\code{lnz}:}{Object of class \code{numeric}, contains the entries of the Cholesky factor }
    \item{\code{log.det}:}{Object of class \code{numeric}, log determinant of the Cholesky factor}
    \item{\code{xlnz}:}{Object of class \code{integer}, column pointer for the Cholesky factor stored in lnz}
    \item{\code{invp}:}{Object of class \code{integer}, vector of integer of inverse permutation vector}
    \item{\code{perm}:}{Object of class \code{integer}, vector of integer of permutation vector }
    \item{\code{xsuper}:}{Object of class \code{integer}, array containing the supernode partioning}
    \item{\code{det}:}{Object of class \code{numeric}, determinant of the Cholesky factor}
    \item{\code{ierr}:}{Object of class \code{integer}, error flag }
    \item{\code{time}:}{Object of class \code{numeric} execution time }
  }
}

\section{Methods}{
  \describe{
    \item{backsolve}{\code{signature(r = "matrix.csr.chol")}: ... }
    \item{as.matrix.csr}{\code{signature(x = "matrix.csr.chol", upper.tri=TRUE)}: ... }
  }
}
\seealso{\code{\link{chol}}, \code{\link{backsolve}}}
\keyword{classes}