SCM

SCM Repository

[matrix] Annotation of /pkg/man/lsparseMatrix-classes.Rd
ViewVC logotype

Annotation of /pkg/man/lsparseMatrix-classes.Rd

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : bates 720 \name{lgCMatrix-class}
2 :     \docType{class}
3 :     \alias{lgCMatrix-class}
4 : bates 722 \alias{ltCMatrix-class}
5 :     \alias{lsCMatrix-class}
6 : bates 720 \alias{\%*\%,lgCMatrix,lgCMatrix-method}
7 :     \alias{coerce,matrix,lgCMatrix-method}
8 :     \alias{t,lgCMatrix-method}
9 :     \title{Compressed, sparse, column-oriented logical matrices}
10 : bates 722 \description{The \code{lgCMatrix} class is a class of general, sparse,
11 :     logical matrices in the compressed, sparse, column-oriented format.
12 :     \code{lsCMatrix} and \code{ltCMatrix} are similar classes representing
13 :     symmetric and triangular matrices respectively.
14 :    
15 :     In this implementation the non-zero elements in the columns are sorted into
16 : bates 720 increasing row order. There is no \code{x} slot in this class because
17 :     the only non-zero value stored is \code{TRUE}.}
18 :     \section{Objects from the Class}{
19 :     Objects can be created by calls of the form \code{new("lgCMatrix", ...)}.
20 :     }
21 :     \section{Slots}{
22 :     \describe{
23 : bates 722 \item{\code{uplo}:}{Object of class \code{"character"}. Must be
24 :     either "U", for upper triangular, and "L", for lower
25 :     triangular. Present in the triangular and symmetric classes but not
26 :     in the general class.}
27 :     \item{\code{diag}:}{Object of class \code{"character"}. Must be
28 :     either \code{"U"}, for unit triangular (diagonal is all ones), or
29 :     \code{"N"} for non-unit. The implicit diagonal elements are not
30 :     explicitly stored when \code{diag} is \code{"U"}. Present in the
31 :     triangular classes only.}
32 : bates 720 \item{\code{p}:}{Object of class \code{"integer"} of pointers, one
33 :     for each column, to the initial (zero-based) index of elements in
34 :     the column.}
35 :     \item{\code{i}:}{Object of class \code{"integer"} of length nnzero
36 :     (number of non-zero elements). These are the row numbers for
37 :     each TRUE element in the matrix. All other elements are FALSE.}
38 :     \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
39 :     of the matrix.}
40 :     }
41 :     }
42 :     \section{Methods}{
43 :     \describe{
44 :     \item{coerce}{\code{signature(from = "dgCMatrix", to = "lgCMatrix")}}
45 :     \item{t}{\code{signature(x = "lgCMatrix")}: returns the transpose
46 :     of \code{x}}
47 :     }
48 :     }
49 :     %\references{}
50 :     %\author{}
51 :     \note{
52 :     This class is most frequently used during the symbolic analysis phase
53 :     of an algorithm involving sparse matrices. Frequently such algorithms
54 :     involve two phases: a symbolic phase wherein the positions of the
55 :     non-zeros in the result are determined and a numeric phase wherein the
56 :     actual results are calculated. During the symbolic phase only the
57 :     positions of the non-zero elements in any operands are of interest,
58 :     hence any numeric sparse matrices can be treated as a logical sparse
59 :     matrices.
60 :     }
61 :     \seealso{
62 : bates 722 \code{\link{dgCMatrix-class}}
63 : bates 720 }
64 :     %\examples{}
65 :     \keyword{classes}
66 :     \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