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 651, Tue Mar 15 01:54:50 2005 UTC
# Line 1  Line 1 
1  \name{dsyMatrix-class}  \name{dsyMatrix-class}
2  \docType{class}  \docType{class}
3  \alias{\%*\%,dgeMatrix,dsyMatrix-method}  \alias{\%*\%,dgeMatrix,dsyMatrix-method}
4    \alias{\%*\%,dspMatrix,dgeMatrix-method}
5    \alias{\%*\%,dspMatrix,matrix-method}
6  \alias{\%*\%,dsyMatrix,dgeMatrix-method}  \alias{\%*\%,dsyMatrix,dgeMatrix-method}
7  \alias{dsyMatrix-class}  \alias{coerce,dspMatrix,dgeMatrix-method}
8    \alias{coerce,dspMatrix,dsyMatrix-method}
9    \alias{coerce,dspMatrix,matrix-method}
10  \alias{coerce,dsyMatrix,dgeMatrix-method}  \alias{coerce,dsyMatrix,dgeMatrix-method}
11    \alias{coerce,dsyMatrix,dspMatrix-method}
12  \alias{coerce,dsyMatrix,matrix-method}  \alias{coerce,dsyMatrix,matrix-method}
13    \alias{dspMatrix-class}
14    \alias{dsyMatrix-class}
15    \alias{norm,dspMatrix,character-method}
16    \alias{norm,dspMatrix,missing-method}
17  \alias{norm,dsyMatrix,character-method}  \alias{norm,dsyMatrix,character-method}
18  \alias{norm,dsyMatrix,missing-method}  \alias{norm,dsyMatrix,missing-method}
19    \alias{rcond,dspMatrix,character-method}
20    \alias{rcond,dspMatrix,missing-method}
21    \alias{rcond,dsyMatrix,character-method}
22    \alias{rcond,dsyMatrix,missing-method}
23    \alias{solve,dspMatrix,dgeMatrix-method}
24    \alias{solve,dspMatrix,matrix-method}
25    \alias{solve,dspMatrix,missing-method}
26    \alias{solve,dsyMatrix,dgeMatrix-method}
27    \alias{solve,dsyMatrix,matrix-method}
28    \alias{solve,dsyMatrix,missing-method}
29    \alias{t,dspMatrix-method}
30  \alias{t,dsyMatrix-method}  \alias{t,dsyMatrix-method}
31  \title{Class "dsyMatrix" of symmetric matrices}  \alias{unpack,dspMatrix-method}
32  \description{The \code{"dsyMatrix"} class is the class of symmetric  \title{Symmetric, dense matrices}
33    matrices in non-packed storage.  Only the upper triangle or the lower  \description{The \code{"dsyMatrix"} class is the class of symmetric, dense
34      matrices in non-packed storage and \code{"dsyMatrix"} is the class of
35      symmetric dense matrices in packed storage.  Only the upper triangle or the lower
36    triangle is stored.}    triangle is stored.}
37  \section{Objects from the Class}{  \section{Objects from the Class}{
38  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 46 
46      \item{\code{Dim}:}{Object of class \code{"integer"}. The dimensions      \item{\code{Dim}:}{Object of class \code{"integer"}. The dimensions
47        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
48        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.}  
49      \item{\code{rcond}:}{Object of class \code{"numeric"}. A named      \item{\code{rcond}:}{Object of class \code{"numeric"}. A named
50        numeric vector of reciprocal condition numbers in either the        numeric vector of reciprocal condition numbers in either the
51        1-norm \code{"O"} or the infinity norm \code{"I"}.}        1-norm \code{"O"} or the infinity norm \code{"I"}.}
# Line 42  Line 59 
59  }  }
60  \section{Methods}{  \section{Methods}{
61    \describe{    \describe{
62        \item{coerce}{\code{signature(from = "dspMatrix", to = "dgeMatrix")}}
63      \item{coerce}{\code{signature(from = "dsyMatrix", to = "dgeMatrix")}}      \item{coerce}{\code{signature(from = "dsyMatrix", to = "dgeMatrix")}}
64        \item{coerce}{\code{signature(from = "dspMatrix", to = "matrix")}}
65      \item{coerce}{\code{signature(from = "dsyMatrix", to = "matrix")}}      \item{coerce}{\code{signature(from = "dsyMatrix", to = "matrix")}}
66        \item{coerce}{\code{signature(from = "dsyMatrix", to = "dspMatrix")}}
67        \item{coerce}{\code{signature(from = "dspMatrix", to = "dsyMatrix")}}
68        \item{norm}{\code{signature(x = "dspMatrix", type = "character")}}
69      \item{norm}{\code{signature(x = "dsyMatrix", type = "character")}}      \item{norm}{\code{signature(x = "dsyMatrix", type = "character")}}
70        \item{norm}{\code{signature(x = "dspMatrix", type = "missing")}}
71        \item{norm}{\code{signature(x = "dsyMatrix", type = "missing")}}
72        \item{solve}{\code{signature(a = "dspMatrix", b = "missing")}}
73        \item{solve}{\code{signature(a = "dsyMatrix", b = "missing")}}
74        \item{solve}{\code{signature(a = "dspMatrix", b = "dgeMatrix")}}
75        \item{solve}{\code{signature(a = "dsyMatrix", b = "dgeMatrix")}}
76        \item{solve}{\code{signature(a = "dspMatrix", b = "matrix")}}
77        \item{solve}{\code{signature(a = "dsyMatrix", b = "matrix")}}
78    }    }
79  }  }
80  %\references{}  %\references{}
81  %\author{}  %\author{}
82  \seealso{  \seealso{
83    \code{\link{dgeMatrix-class}}, \code{\link{Matrix-class}}    \code{\link{dgeMatrix-class}}, \code{\link{Matrix-class}},
84      \code{\link[base]{solve}}, \code{\link{norm}}, \code{\link{rcond}},
85      \code{\link[base]{t}}
86    }
87    \examples{
88    ## Only upper triangular part matters (when uplo == "U" as per default)
89    (sy2 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, NA,32,77)))
90    (c2 <- chol(sy2))
91    str(c2)
92    
93    ## An example where chol() can't work
94    (sy3 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, -1, 2, -7)))
95    validObject(as(sy3, "dpoMatrix"), test=TRUE) # >> is not pos.def.
96    try(chol(sy3)) ## Error: not pos.def
97  }  }
 %\examples{}  
98  \keyword{classes}  \keyword{classes}

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

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