SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 229 - (view) (download) (as text)
Original Path: pkg/man/syMatrix-class.Rd

1 : bates 10 \name{syMatrix-class}
2 :     \docType{class}
3 : bates 229 \alias{\%*\%,geMatrix,syMatrix-method}
4 :     \alias{\%*\%,syMatrix,geMatrix-method}
5 : bates 10 \alias{syMatrix-class}
6 :     \alias{coerce,syMatrix,geMatrix-method}
7 :     \alias{coerce,syMatrix,matrix-method}
8 :     \alias{norm,syMatrix,character-method}
9 :     \alias{norm,syMatrix,missing-method}
10 :     \alias{t,syMatrix-method}
11 :     \title{Class "syMatrix" of symmetric matrices}
12 :     \description{The \code{"syMatrix"} class is the class of symmetric
13 :     matrices in non-packed storage. Only the upper triangle or the lower
14 :     triangle is stored.}
15 :     \section{Objects from the Class}{
16 :     Objects can be created by calls of the form \code{new("syMatrix", ...)}.
17 :     }
18 :     \section{Slots}{
19 :     \describe{
20 :     \item{\code{uplo}:}{Object of class \code{"character"}. Must be
21 :     either "U", for upper triangular, and "L", for lower triangular.}
22 :     \item{\code{x}:}{Object of class \code{"numeric"}. The numeric
23 :     values that constitute the matrix, stored in column-major order.}
24 :     \item{\code{Dim}:}{Object of class \code{"integer"}. The dimensions
25 :     of the matrix which must be a two-element vector of non-negative
26 :     integers.}
27 :     \item{\code{norm}:}{Object of class \code{"numeric"}. A named
28 :     numeric vector of norms of the matrix. Some possible components
29 :     are \code{"O"}, the one norm; \code{"I"}, the infinity norm;
30 :     \code{"F"}, the Frobenius norm; and \code{"M"}, the maximum
31 :     absolute value.}
32 :     \item{\code{rcond}:}{Object of class \code{"numeric"}. A named
33 :     numeric vector of reciprocal condition numbers in either the
34 :     1-norm \code{"O"} or the infinity norm \code{"I"}.}
35 :     \item{\code{factorization}:}{Object of class \code{"list"}. A named
36 :     list of factorizations that have been computed for the matrix.}
37 :     }
38 :     }
39 :     \section{Extends}{
40 :     Class \code{"geMatrix"}, directly.
41 :     Class \code{"Matrix"}, by class \code{"geMatrix"}.
42 :     }
43 :     \section{Methods}{
44 :     \describe{
45 :     \item{coerce}{\code{signature(from = "syMatrix", to = "geMatrix")}}
46 :     \item{coerce}{\code{signature(from = "syMatrix", to = "matrix")}}
47 :     \item{norm}{\code{signature(x = "syMatrix", type = "character")}}
48 :     }
49 :     }
50 :     %\references{}
51 :     %\author{}
52 :     \seealso{
53 :     \code{\link{geMatrix-class}}, \code{\link{Matrix-class}}
54 :     }
55 :     %\examples{}
56 :     \keyword{classes}

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