SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

pkg/man/sscChol-class.Rd revision 48, Tue Apr 6 02:25:26 2004 UTC pkg/man/dCholCMatrix-class.Rd revision 489, Wed Feb 2 19:12:03 2005 UTC
# Line 1  Line 1 
1  \name{sscChol-class}  \name{dCholCMatrix-class}
2  \docType{class}  \docType{class}
3  \alias{sscChol-class}  \alias{dCholCMatrix-class}
4  \title{Cholesky decompositions of sscMatrix objects}  \title{Cholesky decompositions of dsCMatrix objects}
5  \description{The class of Cholesky decompositions of symmetric, sparse  \description{The class of Cholesky decompositions of symmetric, sparse
6    column matrices from the \code{"sscMatrix"} class.}    column matrices from the \code{"dsCMatrix"} class.}
7  \section{Objects from the Class}{  \section{Objects from the Class}{
8  Objects can be created by calls of the form \code{new("sscChol", ...)}  Objects can be created by calls of the form \code{new("dCholCMatrix", ...)}
9  but are more commonly created from \code{chol} applied to an  but are more commonly created from \code{chol} applied to an
10  \code{sscMatrix} object.  \code{dsCMatrix} object.
11  }  }
12  \section{Slots}{  \section{Slots}{
13    \describe{    \describe{
# Line 15  Line 15 
15        permutation of the rows and columns chosen to minimize fill-in.        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        If pivoting has not been applied this will be an integer vector of
17        length 0.}        length 0.}
     \item{\code{iperm}:}{Object of class \code{"integer"} - the inverse  
       permutation to the \code{perm} slot.}  
18      \item{\code{diag}:}{A character object indicating if the triangular      \item{\code{diag}:}{A character object indicating if the triangular
19        matrix is unit triangular or not.  This slot is inherited from the        matrix is unit triangular or not.  This slot is inherited from the
20        \code{"tscMatrix"} class.  It is always \code{"N"} for this class.}        \code{"dtCMatrix"} class.  It is always \code{"N"} for this class.}
21      \item{\code{uplo}:}{A character object indicating if the upper      \item{\code{uplo}:}{A character object indicating if the upper
22        triangle (\code{"U"} or \code{"u"}) or the lower triangle        triangle (\code{"U"} or \code{"u"}) or the lower triangle
23        (\code{"L"} or \code{"l"}) is stored.  At present only the lower        (\code{"L"} or \code{"l"}) is stored.  At present only the lower
# Line 32  Line 30 
30        each non-zero element in the matrix.}        each non-zero element in the matrix.}
31      \item{\code{x}:}{Object of class \code{"numeric"} - the non-zero      \item{\code{x}:}{Object of class \code{"numeric"} - the non-zero
32        elements of the matrix.}        elements of the matrix.}
33      \item{\code{factorization}:}{Object of class \code{"list"} - a list      \item{\code{factors}:}{Object of class \code{"list"} - a list
34        of factorizations of the matrix. }        of factorizations of the matrix. }
35      \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions      \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
36       of the matrix - must be an integer vector with exactly two       of the matrix - must be an integer vector with exactly two
37       non-negative values.}       non-negative values.}
38        \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    }    }
43  }  }
44  \section{Extends}{  \section{Extends}{
45  Class \code{"tscMatrix"}, directly.  Class \code{"dtCMatrix"}, directly.
46  Class \code{"cscMatrix"}, by class \code{"tscMatrix"}.  Class \code{"dgCMatrix"}, by class \code{"dtCMatrix"}.
47  }  }
48  \section{Methods}{  \section{Methods}{
49  No methods defined with class "sscChol" in the signature.  No methods defined with class "dCholCMatrix" in the signature.
50  }  }
51  %\references{}  %\references{}
52  %\author{}  %\author{}
53  %\note{}  %\note{}
54  \seealso{  \seealso{
55    \code{\link{cscMatrix-class}}    \code{\link{dgCMatrix-class}}
56  }  }
57  %\examples{}  %\examples{}
58  \examples{  \examples{

Legend:
Removed from v.48  
changed lines
  Added in v.489

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