| Line 13... |
Line 13... |
| 13 |
all triangular matrices.
|
13 |
all triangular matrices.
|
| 14 |
}
|
14 |
}
|
| 15 |
% \section{Objects from the Class}{A virtual Class: No objects may be created from it.}
|
15 |
% \section{Objects from the Class}{A virtual Class: No objects may be created from it.}
|
| 16 |
\section{Slots}{
|
16 |
\section{Slots}{
|
| 17 |
\describe{
|
17 |
\describe{
|
| 18 |
\item{\code{uplo}:}{Object of class \code{"character"}. Must be
|
18 |
\item{\code{uplo}:}{String (of class \code{"character"}). Must be
|
| 19 |
either "U", for upper triangular, and "L", for lower triangular.}
|
19 |
either "U", for upper triangular, and "L", for lower triangular.}
|
| 20 |
\item{\code{diag}:}{Object of class \code{"character"}. Must be
|
20 |
\item{\code{diag}:}{String (of class \code{"character"}). Must be
|
| 21 |
either \code{"U"}, for unit triangular (diagonal is all ones), or
|
21 |
either \code{"U"}, for unit triangular (diagonal is all ones), or
|
| 22 |
\code{"N"} for non-unit. The diagonal elements are not
|
22 |
\code{"N"} for non-unit. The diagonal elements are not
|
| 23 |
accessed internally when \code{diag} is \code{"U"} (but need to be
|
23 |
accessed internally when \code{diag} is \code{"U"}. For
|
| 24 |
allocated, i.e., \code{length(x)} does not depend on \code{diag}).}
|
24 |
\code{\linkS4class{denseMatrix}} classes, they need to be
|
| 25 |
%% below {Dim, Dimnames} work around Slot parsing buglet (< 2.2.0)
|
25 |
allocated though, i.e., the length of the \code{x} slot does not
|
| - |
|
26 |
depend on \code{diag}.}
|
| 26 |
\item{\code{Dim, Dimnames}:}{The dimension (a length-2
|
27 |
\item{\code{Dim}, \code{Dimnames}:}{The dimension (a length-2
|
| 27 |
\code{"integer"}) and corresponding names (or \code{NULL}),
|
28 |
\code{"integer"}) and corresponding names (or \code{NULL}),
|
| 28 |
inherited from the \code{\linkS4class{Matrix}}, see there.}
|
29 |
inherited from the \code{\linkS4class{Matrix}}, see there.}
|
| 29 |
}
|
30 |
}
|
| 30 |
}
|
31 |
}
|
| 31 |
\section{Extends}{
|
32 |
\section{Extends}{
|
| 32 |
Class \code{"Matrix"}, directly.
|
33 |
Class \code{"Matrix"}, directly.
|
| 33 |
}
|
34 |
}
|
| 34 |
\section{Methods}{
|
35 |
\section{Methods}{
|
| 35 |
There's a C function \code{triangularMatrix_validity()}
|
36 |
There's a C function \code{triangularMatrix_validity()}
|
| 36 |
called by the internal validity checking functions.
|
37 |
called by the internal validity checking functions.
|
| - |
|
38 |
|
| 37 |
%% Currently:
|
39 |
Currently, \code{\link{Schur}}, \code{\link{isSymmetric}} and
|
| - |
|
40 |
\code{as()} (i.e. \code{\link{coerce}}) have methods with
|
| 38 |
%% No methods defined with class "triangularMatrix" in the signature.
|
41 |
\code{triangularMatrix} in their signature.
|
| 39 |
}
|
42 |
}
|
| 40 |
\seealso{
|
43 |
\seealso{
|
| 41 |
Classes \code{\linkS4class{symmetricMatrix}}, and, e.g.,
|
44 |
Classes \code{\linkS4class{symmetricMatrix}}, and, e.g.,
|
| 42 |
\code{\linkS4class{dtrMatrix}} for numeric \emph{dense} matrices, or
|
45 |
\code{\linkS4class{dtrMatrix}} for numeric \emph{dense} matrices, or
|
| 43 |
\code{\linkS4class{ltCMatrix}} for a logical \emph{sparse} matrix
|
46 |
\code{\linkS4class{ltCMatrix}} for a logical \emph{sparse} matrix
|
The R Project SVN
R-packages