SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

pkg/man/lgCMatrix-class.Rd revision 720, Mon May 9 01:32:44 2005 UTC pkg/man/lsparseMatrix-classes.Rd revision 868, Fri Aug 19 17:01:11 2005 UTC
# Line 1  Line 1 
1  \name{lgCMatrix-class}  \name{lsparseMatrix-classes}
2  \docType{class}  \docType{class}
3    \alias{lsparseMatrix-class}
4  \alias{lgCMatrix-class}  \alias{lgCMatrix-class}
5    \alias{ltCMatrix-class}
6    \alias{lsCMatrix-class}
7    \alias{lgRMatrix-class}
8    \alias{ltRMatrix-class}
9    \alias{lsRMatrix-class}
10    \alias{lgTMatrix-class}
11    \alias{ltTMatrix-class}
12    \alias{lsTMatrix-class}
13  \alias{\%*\%,lgCMatrix,lgCMatrix-method}  \alias{\%*\%,lgCMatrix,lgCMatrix-method}
14  \alias{coerce,matrix,lgCMatrix-method}  \alias{chol,lsCMatrix,logical-method}
15    \alias{chol,lsCMatrix,missing-method}
16    \alias{coerce,dgCMatrix,lgCMatrix-method}
17    \alias{coerce,lgCMatrix,dgCMatrix-method}
18    \alias{coerce,lgCMatrix,lgTMatrix-method}
19    \alias{coerce,lgCMatrix,matrix-method}
20    \alias{coerce,lgTMatrix,lgCMatrix-method}
21    \alias{coerce,lgTMatrix,matrix-method}
22    \alias{coerce,lsCMatrix,dsCMatrix-method}
23    \alias{coerce,ltCMatrix,dtCMatrix-method}
24    \alias{crossprod,lgCMatrix,missing-method}
25    \alias{crossprod,lgTMatrix,missing-method}
26    \alias{image,lgCMatrix-method}
27    \alias{image,lsCMatrix-method}
28    \alias{image,ltCMatrix-method}
29  \alias{t,lgCMatrix-method}  \alias{t,lgCMatrix-method}
30  \title{Compressed, sparse, column-oriented logical matrices}  \alias{t,lgTMatrix-method}
31  \description{The \code{dgCMatrix} class is a class of sparse logical  \alias{t,lsCMatrix-method}
32    matrices in the compressed, sparse, column-oriented format.  In this  \alias{t,ltCMatrix-method}
33    implementation the non-zero elements in the columns are sorted into  \alias{tcrossprod,lgCMatrix-method}
34    increasing row order.  There is no \code{x} slot in this class because  \alias{tcrossprod,lgTMatrix-method}
35    the only non-zero value stored is \code{TRUE}.}  \title{Sparse logical matrices}
36    \description{The \code{lsparseMatrix} class is a virtual class of sparse
37      matrices with \code{TRUE}/\code{FALSE} entries.  Only the positions of the
38      elements that are \code{TRUE} are stored.  These can be stored in the
39      ``triplet'' form (classes \code{lgTMatrix}, \code{lsTMatrix}, and
40      \code{ltTMatrix} which really contain pairs, not triplets) or in
41      compressed column-oriented form (classes \code{lgCMatrix},
42      \code{lsCMatrix}, and \code{ltCMatrix}) or in compressed row-oriented
43      form (classes \code{lgRMatrix}, \code{lsRMatrix}, and
44      \code{ltRMatrix}).  The second letter in the name of these non-virtual
45      classes indicates \code{g}eneral, \code{s}ymmetric, or \code{t}riangular.
46    }
47  \section{Objects from the Class}{  \section{Objects from the Class}{
48    Objects can be created by calls of the form \code{new("lgCMatrix", ...)}.    Objects can be created by calls of the form \code{new("lgCMatrix",
49        ...)} and so on.  More frequently objects are created by coercion of
50      a numeric sparse matrix to the logical form for use in
51      the symbolic analysis phase
52      of an algorithm involving sparse matrices.  Such algorithms often
53      involve two phases: a symbolic phase wherein the positions of the
54      non-zeros in the result are determined and a numeric phase wherein the
55      actual results are calculated.  During the symbolic phase only the
56      positions of the non-zero elements in any operands are of interest,
57      hence any numeric sparse matrices can be treated as logical sparse
58      matrices.
59  }  }
60  \section{Slots}{  \section{Slots}{
61    \describe{    \describe{
62        \item{\code{uplo}:}{Object of class \code{"character"}. Must be
63          either "U", for upper triangular, and "L", for lower
64          triangular. Present in the triangular and symmetric classes but not
65          in the general class.}
66        \item{\code{diag}:}{Object of class \code{"character"}. Must be
67          either \code{"U"}, for unit triangular (diagonal is all ones), or
68          \code{"N"} for non-unit.  The implicit diagonal elements are not
69          explicitly stored when \code{diag} is \code{"U"}.  Present in the
70          triangular classes only.}
71      \item{\code{p}:}{Object of class \code{"integer"} of pointers, one      \item{\code{p}:}{Object of class \code{"integer"} of pointers, one
72        for each column, to the initial (zero-based) index of elements in        for each column (row), to the initial (zero-based) index of elements in
73        the column.}        the column.  Present in compressed column-oriented and compressed
74          row-oriented forms only.}
75      \item{\code{i}:}{Object of class \code{"integer"} of length nnzero      \item{\code{i}:}{Object of class \code{"integer"} of length nnzero
76        (number of non-zero elements).  These are the row numbers for        (number of non-zero elements).  These are the row numbers for
77        each TRUE element in the matrix.  All other elements are FALSE.}        each TRUE element in the matrix.  All other elements are FALSE.
78          Present in triplet and compressed column-oriented forms only.}
79        \item{\code{j}:}{Object of class \code{"integer"} of length nnzero
80          (number of non-zero elements).  These are the column numbers for
81          each TRUE element in the matrix.  All other elements are FALSE.
82          Present in triplet and compressed column-oriented forms only.}
83      \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions      \item{\code{Dim}:}{Object of class \code{"integer"} - the dimensions
84        of the matrix.}        of the matrix.}
85    }    }
# Line 34  Line 93 
93  }  }
94  %\references{}  %\references{}
95  %\author{}  %\author{}
96  \note{  %\note{}
   This class is most frequently used during the symbolic analysis phase  
   of an algorithm involving sparse matrices.  Frequently such algorithms  
   involve two phases: a symbolic phase wherein the positions of the  
   non-zeros in the result are determined and a numeric phase wherein the  
   actual results are calculated.  During the symbolic phase only the  
   positions of the non-zero elements in any operands are of interest,  
   hence any numeric sparse matrices can be treated as a logical sparse  
   matrices.  
 }  
97  \seealso{  \seealso{
98    \code{\link{dgCMatrix-class}}, \code{\link{ltCMatrix-class}},    \code{\link{dgCMatrix-class}}
99      \code{\link{lsCMatrix-class}}  }
100    \examples{
101    m <- Matrix(c(0,0,2:0), 3,5, dimnames=list(LETTERS[1:3],NULL))
102    (dm <- as(m, "dgCMatrix"))# no dimnames for sparse here
103    (lm <- as(dm, "lgCMatrix"))
104    str(lm)
105  }  }
 %\examples{}  
106  \keyword{classes}  \keyword{classes}
107  \keyword{algebra}  \keyword{algebra}

Legend:
Removed from v.720  
changed lines
  Added in v.868

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