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

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

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