SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 476 - (view) (download) (as text)
Original Path: pkg/man/sscMatrix-class.Rd

1 : bates 10 \name{sscMatrix-class}
2 :     \docType{class}
3 :     \alias{sscMatrix-class}
4 :     \alias{solve,sscMatrix,matrix-method}
5 :     \alias{chol,sscMatrix,missing-method}
6 :     \alias{chol,sscMatrix,logical-method}
7 :     \alias{t,sscMatrix-method}
8 : bates 79 \alias{coerce,sscMatrix,tripletMatrix-method}
9 :     \alias{coerce,sscMatrix,geMatrix-method}
10 : bates 396 \alias{coerce,sscMatrix,matrix-method}
11 :     \alias{determinant,sscMatrix,missing-method}
12 :     \alias{determinant,sscMatrix,logical-method}
13 : bates 10 \title{Symmetric, compressed, sparse column matrices}
14 :     \description{The \code{sscMatrix} class is a class of symmetric, sparse
15 :     matrices in the compressed, column-oriented format. In this
16 :     implementation the non-zero elements in the columns are sorted into
17 :     increasing row order.}
18 :     \section{Objects from the Class}{
19 :     Objects can be created by calls of the form \code{new("sscMatrix", ...)}.
20 :     }
21 :     \section{Slots}{
22 :     \describe{
23 :     \item{\code{uplo}:}{A character object indicating if the upper
24 :     triangle (\code{"U"} or \code{"u"}) or the lower triangle
25 :     (\code{"L"} or \code{"l"}) is stored. At present only the lower
26 :     triangle form is allowed.}
27 :     \item{\code{p}:}{Object of class \code{"integer"} of pointers, one
28 :     for each column, to the initial (zero-based) index of elements in
29 :     the column.}
30 :     \item{\code{i}:}{Object of class \code{"integer"} of length nnzero
31 :     (number of non-zero elements). These are the row numbers for
32 :     each non-zero element in the matrix.}
33 :     \item{\code{x}:}{Object of class \code{"numeric"} - the non-zero
34 :     elements of the matrix.}
35 : bates 476 \item{\code{factors}:}{Object of class \code{"list"} - a list
36 : bates 10 of factorizations of the matrix. }
37 :     \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
38 :     of the matrix - must be an integer vector with exactly two
39 :     non-negative values.}
40 :     }
41 :     }
42 :     \section{Extends}{
43 :     Class \code{"cscMatrix"}, directly.
44 :     }
45 :     \section{Methods}{
46 :     \describe{
47 :     \item{solve}{\code{signature(a = "sscMatrix", b = "matrix")}: Solve
48 :     a linear system of equations defined by \code{x} using a Cholesky
49 :     decomposition.}
50 :     \item{chol}{\code{signature(x = "sscMatrix", pivot = "logical")}:
51 :     Returns (and stores) the Cholesky decomposition of the matrix
52 :     \code{x}. If \code{pivot} is \code{TRUE} (the default) Metis is
53 :     used to create a reordering of the rows and columns of \code{x} so
54 :     as to minimize fill-in.}
55 : bates 396 \item{determinant}{\code{signature(x = "sscMatrix", logarithm =
56 :     "missing")}: Evaluate the determinant of \code{x} on the
57 :     logarithm scale. This creates and stores the Cholesky factorization.}
58 :     \item{determinant}{\code{signature(x = "sscMatrix", logarithm =
59 :     "logical")}: Evaluate the determinant of \code{x} on the
60 :     logarithm scale or not, according to the \code{logarithm}
61 :     argument. This creates and stores the Cholesky factorization.}
62 : bates 79 \item{coerce}{\code{signature(from = "sscMatrix", to = "tripletMatrix")}}
63 :     \item{coerce}{\code{signature(from = "sscMatrix", to = "geMatrix")}}
64 : bates 396 \item{coerce}{\code{signature(from = "sscMatrix", to = "matrix")}}
65 : bates 10 }
66 :     }
67 :     %\references{}
68 :     %\author{}
69 :     %\note{}
70 :     \seealso{
71 : bates 79 \code{\link{cscMatrix-class}}, \code{\link{tripletMatrix-class}},
72 :     \code{\link{geMatrix-class}}
73 : bates 10 }
74 :     %\examples{}
75 :     \keyword{classes}
76 :     \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