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 683 - (view) (download) (as text)

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