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 946, Wed Sep 28 08:56:42 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{show,dsyMatrix-method}
16    \alias{dspMatrix-class}
17    \alias{dsyMatrix-class}
18    \alias{norm,dspMatrix,character-method}
19    \alias{norm,dspMatrix,missing-method}
20  \alias{norm,dsyMatrix,character-method}  \alias{norm,dsyMatrix,character-method}
21  \alias{norm,dsyMatrix,missing-method}  \alias{norm,dsyMatrix,missing-method}
22    \alias{rcond,dspMatrix,character-method}
23    \alias{rcond,dspMatrix,missing-method}
24    \alias{rcond,dsyMatrix,character-method}
25    \alias{rcond,dsyMatrix,missing-method}
26    \alias{solve,dspMatrix,dgeMatrix-method}
27    \alias{solve,dspMatrix,integer-method}
28    \alias{solve,dspMatrix,matrix-method}
29    \alias{solve,dspMatrix,missing-method}
30    \alias{solve,dspMatrix,numeric-method}
31    \alias{solve,dsyMatrix,dgeMatrix-method}
32    \alias{solve,dsyMatrix,matrix-method}
33    \alias{solve,dsyMatrix,missing-method}
34    \alias{t,dspMatrix-method}
35  \alias{t,dsyMatrix-method}  \alias{t,dsyMatrix-method}
36  \title{Class "dsyMatrix" of symmetric matrices}  \alias{unpack,dspMatrix-method}
37  \description{The \code{"dsyMatrix"} class is the class of symmetric  \title{Symmetric Dense Numeric Matrices}
38    matrices in non-packed storage.  Only the upper triangle or the lower  \description{
39    triangle is stored.}    The \code{"dsyMatrix"} class is the class of symmetric, dense matrices
40      in non-packed storage and \code{"dspMatrix"} is the class of symmetric
41      dense matrices in packed storage.  Only the upper triangle or the
42      lower triangle is stored.
43    }
44  \section{Objects from the Class}{  \section{Objects from the Class}{
45  Objects can be created by calls of the form \code{new("dsyMatrix", ...)}.  Objects can be created by calls of the form \code{new("dsyMatrix", ...)}.
46  }  }
# Line 21  Line 50 
50        either "U", for upper triangular, and "L", for lower triangular.}        either "U", for upper triangular, and "L", for lower triangular.}
51      \item{\code{x}:}{Object of class \code{"numeric"}. The numeric      \item{\code{x}:}{Object of class \code{"numeric"}. The numeric
52        values that constitute the matrix, stored in column-major order.}        values that constitute the matrix, stored in column-major order.}
53      \item{\code{Dim}:}{Object of class \code{"integer"}. The dimensions      \item{\code{Dim},\code{Dimnames}:}{The dimension (a length-2
54        of the matrix which must be a two-element vector of non-negative        \code{"integer"}) and corresponding names (or \code{NULL}), see the
55        integers.}        \code{\link{Matrix-class}}.}
     \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.}  
56      \item{\code{rcond}:}{Object of class \code{"numeric"}. A named      \item{\code{rcond}:}{Object of class \code{"numeric"}. A named
57        numeric vector of reciprocal condition numbers in either the        numeric vector of reciprocal condition numbers in either the
58        1-norm \code{"O"} or the infinity norm \code{"I"}.}        1-norm \code{"O"} or the infinity norm \code{"I"}.}
# Line 37  Line 61 
61    }    }
62  }  }
63  \section{Extends}{  \section{Extends}{
64  Class \code{"dgeMatrix"}, directly.    \code{"dsyMatrix"} extends class \code{"dgeMatrix"}, directly, whereas\cr
65  Class \code{"Matrix"}, by class \code{"dgeMatrix"}.    \code{"dspMatrix"} extends class \code{"ddenseMatrix"}, directly.
66    
67      Both extend class \code{"symmetricMatrix"}, directly,
68      and class \code{"Matrix"} and others, \emph{in}directly, use
69      \code{\link{showClass}("dsyMatrix")}, e.g., for details.
70  }  }
71  \section{Methods}{  \section{Methods}{
72    \describe{    \describe{
73        \item{coerce}{\code{signature(from = "dspMatrix", to = "dgeMatrix")}}
74      \item{coerce}{\code{signature(from = "dsyMatrix", to = "dgeMatrix")}}      \item{coerce}{\code{signature(from = "dsyMatrix", to = "dgeMatrix")}}
75        \item{coerce}{\code{signature(from = "dspMatrix", to = "matrix")}}
76      \item{coerce}{\code{signature(from = "dsyMatrix", to = "matrix")}}      \item{coerce}{\code{signature(from = "dsyMatrix", to = "matrix")}}
77        \item{coerce}{\code{signature(from = "dsyMatrix", to = "dspMatrix")}}
78        \item{coerce}{\code{signature(from = "dspMatrix", to = "dsyMatrix")}}
79        \item{norm}{\code{signature(x = "dspMatrix", type = "character")}}
80      \item{norm}{\code{signature(x = "dsyMatrix", type = "character")}}      \item{norm}{\code{signature(x = "dsyMatrix", type = "character")}}
81        \item{norm}{\code{signature(x = "dspMatrix", type = "missing")}}
82        \item{norm}{\code{signature(x = "dsyMatrix", type = "missing")}}
83        \item{solve}{\code{signature(a = "dspMatrix", b = "missing")}}
84        \item{solve}{\code{signature(a = "dsyMatrix", b = "missing")}}
85        \item{solve}{\code{signature(a = "dspMatrix", b = "dgeMatrix")}}
86        \item{solve}{\code{signature(a = "dsyMatrix", b = "dgeMatrix")}}
87        \item{solve}{\code{signature(a = "dspMatrix", b = "matrix")}}
88        \item{solve}{\code{signature(a = "dsyMatrix", b = "matrix")}}
89    }    }
90  }  }
91  %\references{}  %\references{}
92  %\author{}  %\author{}
93  \seealso{  \seealso{
94    \code{\link{dgeMatrix-class}}, \code{\link{Matrix-class}}    \code{\link{dgeMatrix-class}}, \code{\link{Matrix-class}},
95      \code{\link[base]{solve}}, \code{\link{norm}}, \code{\link{rcond}},
96      \code{\link[base]{t}}
97    }
98    \examples{
99    ## Only upper triangular part matters (when uplo == "U" as per default)
100    (sy2 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, NA,32,77)))
101    (c2 <- chol(sy2))
102    all.equal(c2, c2. <- chol(as(sy2, "dpoMatrix")))# equal, but not same class
103    str(c2)
104    
105    ## An example where chol() can't work
106    (sy3 <- new("dsyMatrix", Dim = as.integer(c(2,2)), x = c(14, -1, 2, -7)))
107    
108    validObject(as(sy3, "dpoMatrix"), test=TRUE) # >> is not pos.def.
109    % .... Lapack routine dpotrf returned error code 2 -- FIXME: better message
110    try(chol(sy3)) ## Error: not pos.def
111  }  }
 %\examples{}  
112  \keyword{classes}  \keyword{classes}

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

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