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

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