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