SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : bates 597 \name{dtpMatrix-class}
2 :     \docType{class}
3 :     \alias{dtpMatrix-class}
4 : bates 1463 \alias{\%*\%,dtpMatrix,ddenseMatrix-method}
5 : maechler 611 \alias{\%*\%,dgeMatrix,dtpMatrix-method}
6 :     \alias{\%*\%,dtpMatrix,matrix-method}
7 : maechler 628 \alias{\%*\%,matrix,dtpMatrix-method}
8 : maechler 1173 \alias{coerce,dtpMatrix,dtTMatrix-method}
9 : bates 597 \alias{coerce,dtpMatrix,dtrMatrix-method}
10 : maechler 956 \alias{coerce,dtpMatrix,ltpMatrix-method}
11 : bates 597 \alias{coerce,dtpMatrix,matrix-method}
12 : maechler 657 \alias{coerce,matrix,dtpMatrix-method}
13 : bates 597 \alias{determinant,dtpMatrix,missing-method}
14 :     \alias{determinant,dtpMatrix,logical-method}
15 :     \alias{diag,dtpMatrix-method}
16 :     \alias{norm,dtpMatrix,character-method}
17 :     \alias{norm,dtpMatrix,missing-method}
18 :     \alias{rcond,dtpMatrix,character-method}
19 :     \alias{rcond,dtpMatrix,missing-method}
20 :     \alias{solve,dtpMatrix,missing-method}
21 :     \alias{solve,dtpMatrix,matrix-method}
22 : bates 1463 \alias{solve,dtpMatrix,ddenseMatrix-method}
23 : bates 597 \alias{t,dtpMatrix-method}
24 : bates 646 \alias{unpack,dtpMatrix-method}
25 : bates 597 \title{Packed triangular dense matrices}
26 :     \description{The \code{"dtpMatrix"} class is the class of triangular,
27 :     dense, numeric matrices in packed storage. The \code{"dtrMatrix"}
28 :     class is the same except in nonpacked storage.}
29 :     \section{Objects from the Class}{
30 :     Objects can be created by calls of the form \code{new("dtpMatrix",
31 :     ...)} or by coercion from other classes of matrices.
32 :     }
33 :     \section{Slots}{
34 :     \describe{
35 :     \item{\code{uplo}:}{Object of class \code{"character"}. Must be
36 :     either "U", for upper triangular, and "L", for lower triangular.}
37 :     \item{\code{diag}:}{Object of class \code{"character"}. Must be
38 :     either \code{"U"}, for unit triangular (diagonal is all ones), or
39 : maechler 1281 \code{"N"}; see \code{\linkS4class{triangularMatrix}}.}
40 : bates 597 \item{\code{x}:}{Object of class \code{"numeric"}. The numeric
41 :     values that constitute the matrix, stored in column-major order.}
42 : maechler 891 \item{\code{Dim},\code{Dimnames}:}{The dimension (a length-2
43 :     \code{"integer"}) and corresponding names (or \code{NULL}),
44 : maechler 1281 inherited from the \code{\linkS4class{Matrix}}, see there.}
45 : bates 597 }
46 :     }
47 :     \section{Extends}{
48 : maechler 891 Class \code{"ddenseMatrix"}, directly.
49 :     Class \code{"triangularMatrix"}, directly.
50 :     Class \code{"dMatrix"} and more by class \code{"ddenseMatrix"} etc, see
51 :     the examples.
52 : bates 597 }
53 :     \section{Methods}{
54 :     \describe{
55 :     \item{\%*\%}{\code{signature(x = "dtpMatrix", y = "dgeMatrix")}:
56 : maechler 611 Matrix multiplication; dito for several other signature
57 :     combinations, see \code{showMethods("\%*\%", class = "dtpMatrix")}.}
58 : bates 597 \item{coerce}{\code{signature(from = "dtpMatrix", to = "dtrMatrix")}}
59 :     \item{coerce}{\code{signature(from = "dtpMatrix", to = "matrix")}}
60 :     \item{determinant}{\code{signature(x = "dtpMatrix", logarithm = "missing")}: ... }
61 :     \item{determinant}{\code{signature(x = "dtpMatrix", logarithm = "logical")}: ... }
62 :     \item{diag}{\code{signature(x = "dtpMatrix")}: ... }
63 :     \item{norm}{\code{signature(x = "dtpMatrix", type = "character")}: ... }
64 :     \item{norm}{\code{signature(x = "dtpMatrix", type = "missing")}: ... }
65 :     \item{rcond}{\code{signature(x = "dtpMatrix", type = "character")}: ... }
66 :     \item{rcond}{\code{signature(x = "dtpMatrix", type = "missing")}: ... }
67 :     \item{solve}{\code{signature(a = "dtpMatrix", b = "missing")}: ... }
68 :     \item{solve}{\code{signature(a = "dtpMatrix", b = "matrix")}: ... }
69 :     \item{t}{\code{signature(x = "dtpMatrix")}: ... }
70 : bates 646 \item{unpack}{\code{signature(x = "dtpMatrix")}: ... }
71 : bates 597 }
72 :     }
73 :     \seealso{
74 : maechler 1281 Class \code{\linkS4class{dtrMatrix}}
75 : bates 597 }
76 : maechler 830 \examples{
77 : maechler 891 showClass("dtrMatrix")
78 :    
79 : maechler 1356 example("dtrMatrix-class")
80 :     (p1 <- as(T2, "dtpMatrix"))
81 :     str(p1)
82 :     (pp <- as(T, "dtpMatrix"))
83 :     stopifnot(length(p1@x) == 3, length(pp@x) == 3,
84 :     p1 @ uplo == T2 @ uplo, pp @ uplo == T @ uplo)
85 : maechler 830 }
86 : bates 597 \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