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