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

revision 476, Wed Feb 2 11:51:24 2005 UTC revision 480, Wed Feb 2 14:59:12 2005 UTC
# Line 1  Line 1 
1  \name{sscMatrix-class}  \name{dsCMatrix-class}
2  \docType{class}  \docType{class}
3  \alias{sscMatrix-class}  \alias{dsCMatrix-class}
4  \alias{solve,sscMatrix,matrix-method}  \alias{solve,dsCMatrix,matrix-method}
5  \alias{chol,sscMatrix,missing-method}  \alias{chol,dsCMatrix,missing-method}
6  \alias{chol,sscMatrix,logical-method}  \alias{chol,dsCMatrix,logical-method}
7  \alias{t,sscMatrix-method}  \alias{t,dsCMatrix-method}
8  \alias{coerce,sscMatrix,tripletMatrix-method}  \alias{coerce,dsCMatrix,dgTMatrix-method}
9  \alias{coerce,sscMatrix,geMatrix-method}  \alias{coerce,dsCMatrix,dgeMatrix-method}
10  \alias{coerce,sscMatrix,matrix-method}  \alias{coerce,dsCMatrix,matrix-method}
11  \alias{determinant,sscMatrix,missing-method}  \alias{determinant,dsCMatrix,missing-method}
12  \alias{determinant,sscMatrix,logical-method}  \alias{determinant,dsCMatrix,logical-method}
13  \title{Symmetric, compressed, sparse column matrices}  \title{Symmetric, compressed, sparse column matrices}
14  \description{The \code{sscMatrix} class is a class of symmetric, sparse  \description{The \code{dsCMatrix} class is a class of symmetric, sparse
15    matrices in the compressed, column-oriented format.  In this    matrices in the compressed, column-oriented format.  In this
16    implementation the non-zero elements in the columns are sorted into    implementation the non-zero elements in the columns are sorted into
17    increasing row order.}    increasing row order.}
18  \section{Objects from the Class}{  \section{Objects from the Class}{
19    Objects can be created by calls of the form \code{new("sscMatrix", ...)}.    Objects can be created by calls of the form \code{new("dsCMatrix", ...)}.
20  }  }
21  \section{Slots}{  \section{Slots}{
22    \describe{    \describe{
# Line 40  Line 40 
40    }    }
41  }  }
42  \section{Extends}{  \section{Extends}{
43  Class \code{"cscMatrix"}, directly.  Class \code{"dgCMatrix"}, directly.
44  }  }
45  \section{Methods}{  \section{Methods}{
46    \describe{    \describe{
47      \item{solve}{\code{signature(a = "sscMatrix", b = "matrix")}: Solve      \item{solve}{\code{signature(a = "dsCMatrix", b = "matrix")}: Solve
48        a linear system of equations defined by \code{x} using a Cholesky        a linear system of equations defined by \code{x} using a Cholesky
49        decomposition.}        decomposition.}
50      \item{chol}{\code{signature(x = "sscMatrix", pivot = "logical")}:      \item{chol}{\code{signature(x = "dsCMatrix", pivot = "logical")}:
51        Returns (and stores) the Cholesky decomposition of the matrix        Returns (and stores) the Cholesky decomposition of the matrix
52        \code{x}. If \code{pivot} is \code{TRUE} (the default) Metis is        \code{x}. If \code{pivot} is \code{TRUE} (the default) Metis is
53        used to create a reordering of the rows and columns of \code{x} so        used to create a reordering of the rows and columns of \code{x} so
54        as to minimize fill-in.}        as to minimize fill-in.}
55      \item{determinant}{\code{signature(x = "sscMatrix", logarithm =      \item{determinant}{\code{signature(x = "dsCMatrix", logarithm =
56          "missing")}: Evaluate the determinant of \code{x} on the          "missing")}: Evaluate the determinant of \code{x} on the
57        logarithm scale.  This creates and stores the Cholesky factorization.}        logarithm scale.  This creates and stores the Cholesky factorization.}
58      \item{determinant}{\code{signature(x = "sscMatrix", logarithm =      \item{determinant}{\code{signature(x = "dsCMatrix", logarithm =
59          "logical")}: Evaluate the determinant of \code{x} on the          "logical")}: Evaluate the determinant of \code{x} on the
60        logarithm scale or not, according to the \code{logarithm}        logarithm scale or not, according to the \code{logarithm}
61        argument.  This creates and stores the Cholesky factorization.}        argument.  This creates and stores the Cholesky factorization.}
62      \item{coerce}{\code{signature(from = "sscMatrix", to = "tripletMatrix")}}      \item{coerce}{\code{signature(from = "dsCMatrix", to = "dgTMatrix")}}
63      \item{coerce}{\code{signature(from = "sscMatrix", to = "geMatrix")}}      \item{coerce}{\code{signature(from = "dsCMatrix", to = "dgeMatrix")}}
64      \item{coerce}{\code{signature(from = "sscMatrix", to = "matrix")}}      \item{coerce}{\code{signature(from = "dsCMatrix", to = "matrix")}}
65    }    }
66  }  }
67  %\references{}  %\references{}
68  %\author{}  %\author{}
69  %\note{}  %\note{}
70  \seealso{  \seealso{
71    \code{\link{cscMatrix-class}}, \code{\link{tripletMatrix-class}},    \code{\link{dgCMatrix-class}}, \code{\link{dgTMatrix-class}},
72    \code{\link{geMatrix-class}}    \code{\link{dgeMatrix-class}}
73  }  }
74  %\examples{}  %\examples{}
75  \keyword{classes}  \keyword{classes}

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

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