SCM

SCM Repository

[matrix] Diff of /pkg/man/dsCMatrix-class.Rd
ViewVC logotype

Diff of /pkg/man/dsCMatrix-class.Rd

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

pkg/man/sscMatrix-class.Rd revision 480, Wed Feb 2 14:59:12 2005 UTC pkg/man/dsCMatrix-class.Rd revision 880, Tue Aug 30 14:36:41 2005 UTC
# Line 1  Line 1 
1  \name{dsCMatrix-class}  \name{dsCMatrix-class}
2    \title{Symmetric, compressed, sparse column matrices}
3  \docType{class}  \docType{class}
4  \alias{dsCMatrix-class}  \alias{dsCMatrix-class}
5    \alias{dsTMatrix-class}
6  \alias{solve,dsCMatrix,matrix-method}  \alias{solve,dsCMatrix,matrix-method}
7    \alias{solve,dsCMatrix,dgeMatrix-method}
8  \alias{chol,dsCMatrix,missing-method}  \alias{chol,dsCMatrix,missing-method}
9  \alias{chol,dsCMatrix,logical-method}  \alias{chol,dsCMatrix,logical-method}
10  \alias{t,dsCMatrix-method}  \alias{t,dsCMatrix-method}
11    \alias{t,dsTMatrix-method}
12  \alias{coerce,dsCMatrix,dgTMatrix-method}  \alias{coerce,dsCMatrix,dgTMatrix-method}
13    \alias{coerce,dsCMatrix,dsTMatrix-method}
14    \alias{coerce,dsCMatrix,dsyMatrix-method}
15  \alias{coerce,dsCMatrix,dgeMatrix-method}  \alias{coerce,dsCMatrix,dgeMatrix-method}
16  \alias{coerce,dsCMatrix,matrix-method}  \alias{coerce,dsCMatrix,matrix-method}
17    \alias{coerce,dsCMatrix,lsCMatrix-method}
18    \alias{coerce,dsTMatrix,matrix-method}
19    \alias{coerce,dsTMatrix,dgeMatrix-method}
20    \alias{coerce,dsTMatrix,dsCMatrix-method}
21    \alias{coerce,dsTMatrix,dsyMatrix-method}
22    \alias{coerce,graphNEL,dsCMatrix-method}
23  \alias{determinant,dsCMatrix,missing-method}  \alias{determinant,dsCMatrix,missing-method}
24  \alias{determinant,dsCMatrix,logical-method}  \alias{determinant,dsCMatrix,logical-method}
 \title{Symmetric, compressed, sparse column matrices}  
25  \description{The \code{dsCMatrix} class is a class of symmetric, sparse  \description{The \code{dsCMatrix} class is a class of symmetric, sparse
26    matrices in the compressed, column-oriented format.  In this    matrices in the compressed, column-oriented format.  In this
27    implementation the non-zero elements in the columns are sorted into    implementation the non-zero elements in the columns are sorted into
28    increasing row order.}    increasing row order. The \code{dsTMatrix} class is a class of
29      symmetric, sparse matrices in triplet format.}
30  \section{Objects from the Class}{  \section{Objects from the Class}{
31    Objects can be created by calls of the form \code{new("dsCMatrix", ...)}.    Objects can be created by calls of the form \code{new("dsCMatrix",
32        ...)} or \code{new("dsTMatrix", ...)}
33  }  }
34  \section{Slots}{  \section{Slots}{
35    \describe{    \describe{
# Line 26  Line 39 
39        triangle form is allowed.}        triangle form is allowed.}
40      \item{\code{p}:}{Object of class \code{"integer"} of pointers, one      \item{\code{p}:}{Object of class \code{"integer"} of pointers, one
41        for each column, to the initial (zero-based) index of elements in        for each column, to the initial (zero-based) index of elements in
42        the column.}        the column. (Only present in the \code{dsCMatrix} class.)}
43      \item{\code{i}:}{Object of class \code{"integer"} of length nnzero      \item{\code{i}:}{Object of class \code{"integer"} of length nnzero
44        (number of non-zero elements).  These are the row numbers for        (number of non-zero elements).  These are the row numbers for
45        each non-zero element in the matrix.}        each non-zero element in the matrix.}
46        \item{\code{j}:}{Object of class \code{"integer"} of length nnzero
47          (number of non-zero elements).  These are the column numbers for
48          each non-zero element in the matrix. (Only present in the
49          \code{dsTMatrix} class.)}
50      \item{\code{x}:}{Object of class \code{"numeric"} - the non-zero      \item{\code{x}:}{Object of class \code{"numeric"} - the non-zero
51        elements of the matrix.}        elements of the matrix.}
52      \item{\code{factors}:}{Object of class \code{"list"} - a list      \item{\code{factors}:}{Object of class \code{"list"} - a list
# Line 59  Line 76 
76          "logical")}: Evaluate the determinant of \code{x} on the          "logical")}: Evaluate the determinant of \code{x} on the
77        logarithm scale or not, according to the \code{logarithm}        logarithm scale or not, according to the \code{logarithm}
78        argument.  This creates and stores the Cholesky factorization.}        argument.  This creates and stores the Cholesky factorization.}
79        \item{t}{\code{signature(x = "dsCMatrix")}: Transpose.  Because
80          \code{x} is symmetric this has no effect.}
81        \item{t}{\code{signature(x = "dsTMatrix")}: Transpose.  For the
82          \code{dsTMatrix} class the row and column indices are interchanged
83          so that a matrix for which the upper triangle is stored produces a
84          matrix for which the lower triangle is stored and vice versa.}
85      \item{coerce}{\code{signature(from = "dsCMatrix", to = "dgTMatrix")}}      \item{coerce}{\code{signature(from = "dsCMatrix", to = "dgTMatrix")}}
86      \item{coerce}{\code{signature(from = "dsCMatrix", to = "dgeMatrix")}}      \item{coerce}{\code{signature(from = "dsCMatrix", to = "dgeMatrix")}}
87      \item{coerce}{\code{signature(from = "dsCMatrix", to = "matrix")}}      \item{coerce}{\code{signature(from = "dsCMatrix", to = "matrix")}}
88        \item{coerce}{\code{signature(from = "dsTMatrix", to = "dgeMatrix")}}
89        \item{coerce}{\code{signature(from = "dsTMatrix", to = "dsCMatrix")}}
90        \item{coerce}{\code{signature(from = "dsTMatrix", to = "dsyMatrix")}}
91        \item{coerce}{\code{signature(from = "dsTMatrix", to = "matrix")}}
92    }    }
93  }  }
94  %\references{}  %\references{}

Legend:
Removed from v.480  
changed lines
  Added in v.880

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