SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 476 - (view) (download) (as text)

1 : bates 10 \name{trMatrix-class}
2 :     \docType{class}
3 : bates 229 \alias{\%*\%,geMatrix,trMatrix-method}
4 :     \alias{\%*\%,trMatrix,geMatrix-method}
5 : bates 10 \alias{coerce,trMatrix,geMatrix-method}
6 :     \alias{coerce,trMatrix,matrix-method}
7 :     \alias{crossprod,trMatrix,missing-method}
8 :     \alias{determinant,trMatrix,logical-method}
9 :     \alias{determinant,trMatrix,missing-method}
10 :     \alias{norm,trMatrix,character-method}
11 :     \alias{norm,trMatrix,missing-method}
12 :     \alias{rcond,trMatrix,character-method}
13 :     \alias{rcond,trMatrix,missing-method}
14 :     \alias{solve,trMatrix,matrix-method}
15 :     \alias{solve,trMatrix,missing-method}
16 :     \alias{t,trMatrix-method}
17 :     \alias{trMatrix-class}
18 :     \title{Triangular, dense, non-packed, real matrices}
19 :     \description{The \code{"trMatrix"} class is the class of triangular
20 :     matrices in dense, non-packed storage.}
21 :     \section{Objects from the Class}{
22 :     Objects can be created by calls of the form \code{new("trMatrix", ...)}.
23 :     }
24 :     \section{Slots}{
25 :     \describe{
26 :     \item{\code{uplo}:}{Object of class \code{"character"}. Must be
27 :     either "U", for upper triangular, and "L", for lower triangular.}
28 :     \item{\code{diag}:}{Object of class \code{"character"}. Must be
29 :     either \code{"U"}, for unit triangular (diagonal is all ones), or
30 :     \code{"N"} for non-unit. The implicit diagonal elements are not
31 :     explicitly stored when \code{diag} is \code{"U"}.}
32 :     \item{\code{x}:}{Object of class \code{"numeric"}. The numeric
33 :     values that constitute the matrix, stored in column-major order.}
34 :     \item{\code{Dim}:}{Object of class \code{"integer"}. The dimensions
35 :     of the matrix which must be a two-element vector of non-negative
36 :     integers.}
37 :     \item{\code{norm}:}{Object of class \code{"numeric"}. A named
38 :     numeric vector of norms of the matrix. Some possible components
39 :     are \code{"O"}, the one norm; \code{"I"}, the infinity norm;
40 :     \code{"F"}, the Frobenius norm; and \code{"M"}, the maximum
41 :     absolute value.}
42 :     \item{\code{rcond}:}{Object of class \code{"numeric"}. A named
43 :     numeric vector of reciprocal condition numbers in either the
44 :     1-norm \code{"O"} or the infinity norm \code{"I"}.}
45 : bates 476 \item{\code{factors}:}{Object of class \code{"list"}. A named
46 : bates 10 list of factorizations that have been computed for the matrix.}
47 :     }
48 :     }
49 :     \section{Extends}{
50 :     Class \code{"geMatrix"}, directly.
51 :     Class \code{"Matrix"}, by class \code{"geMatrix"}.
52 :     }
53 :     \section{Methods}{
54 :     \describe{
55 :     \item{coerce}{\code{signature(from = "trMatrix", to = "geMatrix")}}
56 :     \item{coerce}{\code{signature(from = "trMatrix", to = "matrix")}}
57 :     \item{norm}{\code{signature(x = "trMatrix", type = "character")}}
58 :     \item{rcond}{\code{signature(x = "trMatrix", type = "character")}}
59 :     \item{solve}{\code{signature(a = "trMatrix", b = "missing")}}
60 :     \item{solve}{\code{signature(a = "trMatrix", b = "matrix")}}
61 :     }
62 :     }
63 :     %\references{}
64 :     %\author{}
65 :     \seealso{
66 :     \code{\link{geMatrix-class}}, \code{\link{Matrix-class}}
67 :     }
68 :     %\examples{}
69 :     \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