SCM

SCM Repository

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

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

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

revision 481, Wed Feb 2 15:01:50 2005 UTC revision 634, Sun Mar 13 21:01:45 2005 UTC
# Line 3  Line 3 
3  \alias{\%*\%,dgeMatrix,dsyMatrix-method}  \alias{\%*\%,dgeMatrix,dsyMatrix-method}
4  \alias{\%*\%,dsyMatrix,dgeMatrix-method}  \alias{\%*\%,dsyMatrix,dgeMatrix-method}
5  \alias{dsyMatrix-class}  \alias{dsyMatrix-class}
6    \alias{dspMatrix-class}
7  \alias{coerce,dsyMatrix,dgeMatrix-method}  \alias{coerce,dsyMatrix,dgeMatrix-method}
8  \alias{coerce,dsyMatrix,matrix-method}  \alias{coerce,dsyMatrix,matrix-method}
9    \alias{chol,dsyMatrix,ANY-method}
10  \alias{norm,dsyMatrix,character-method}  \alias{norm,dsyMatrix,character-method}
11  \alias{norm,dsyMatrix,missing-method}  \alias{norm,dsyMatrix,missing-method}
12  \alias{t,dsyMatrix-method}  \alias{t,dsyMatrix-method}
13  \title{Class "dsyMatrix" of symmetric matrices}  \title{Symmetric, dense matrices}
14  \description{The \code{"dsyMatrix"} class is the class of symmetric  \description{The \code{"dsyMatrix"} class is the class of symmetric, dense
15    matrices in non-packed storage.  Only the upper triangle or the lower    matrices in non-packed storage and \code{"dsyMatrix"} is the class of
16      symmetric dense matrices in packed storage.  Only the upper triangle or the lower
17    triangle is stored.}    triangle is stored.}
18  \section{Objects from the Class}{  \section{Objects from the Class}{
19  Objects can be created by calls of the form \code{new("dsyMatrix", ...)}.  Objects can be created by calls of the form \code{new("dsyMatrix", ...)}.
# Line 24  Line 27 
27      \item{\code{Dim}:}{Object of class \code{"integer"}. The dimensions      \item{\code{Dim}:}{Object of class \code{"integer"}. The dimensions
28        of the matrix which must be a two-element vector of non-negative        of the matrix which must be a two-element vector of non-negative
29        integers.}        integers.}
     \item{\code{norm}:}{Object of class \code{"numeric"}. A named  
       numeric vector of norms of the matrix.  Some possible components  
       are \code{"O"}, the one norm; \code{"I"}, the infinity norm;  
       \code{"F"}, the Frobenius norm; and \code{"M"}, the maximum  
       absolute value.}  
30      \item{\code{rcond}:}{Object of class \code{"numeric"}. A named      \item{\code{rcond}:}{Object of class \code{"numeric"}. A named
31        numeric vector of reciprocal condition numbers in either the        numeric vector of reciprocal condition numbers in either the
32        1-norm \code{"O"} or the infinity norm \code{"I"}.}        1-norm \code{"O"} or the infinity norm \code{"I"}.}
# Line 44  Line 42 
42    \describe{    \describe{
43      \item{coerce}{\code{signature(from = "dsyMatrix", to = "dgeMatrix")}}      \item{coerce}{\code{signature(from = "dsyMatrix", to = "dgeMatrix")}}
44      \item{coerce}{\code{signature(from = "dsyMatrix", to = "matrix")}}      \item{coerce}{\code{signature(from = "dsyMatrix", to = "matrix")}}
45        \item{chol}{\code{signature(x = "dsyMatrix")}: works via coercion to
46          positive definite matrix, see \code{\link{dpoMatrix-class}}.}
47      \item{norm}{\code{signature(x = "dsyMatrix", type = "character")}}      \item{norm}{\code{signature(x = "dsyMatrix", type = "character")}}
48    }    }
49  }  }
# Line 52  Line 52 
52  \seealso{  \seealso{
53    \code{\link{dgeMatrix-class}}, \code{\link{Matrix-class}}    \code{\link{dgeMatrix-class}}, \code{\link{Matrix-class}}
54  }  }
55  %\examples{}  \examples{
56    ## Only upper triangular part matters (when uplo == "U" as per default)
57    (sy2 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, NA,32,77)))
58    (c2 <- chol(sy2))
59    str(c2)
60    
61    ## An example where chol() can't work
62    (sy3 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, -1, 2, -7)))
63    validObject(as(sy3, "dpoMatrix"), test=TRUE) # >> is not pos.def.
64    try(chol(sy3)) ## Error: not pos.def
65    }
66  \keyword{classes}  \keyword{classes}

Legend:
Removed from v.481  
changed lines
  Added in v.634

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