File: compMatrix-class.Rd

package info (click to toggle)
rmatrix 0.9975-6-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 4,136 kB
  • ctags: 2,162
  • sloc: ansic: 35,914; makefile: 225; fortran: 151; sh: 67
file content (38 lines) | stat: -rw-r--r-- 1,066 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
\name{compMatrix-class}
\docType{class}
\alias{compMatrix-class}

\title{Class "compMatrix" of Composite (Factorizable) Matrices}
\description{
  Virtual class of \emph{composite} matrices; i.e., matrices
  that can be \emph{factorized}, typically as a product of simpler
  matrices.
}
\section{Objects from the Class}{A virtual Class: No objects may be created from it.}
\section{Slots}{
  \describe{
    \item{\code{factors}:}{Object of class \code{"list"} - a list
      of factorizations of the matrix.  Note that this is typically
      empty, i.e. \code{list()}, initially and is updated automagically
      whenever a matrix factorization is computed.}
    \item{\code{Dim}}{,}
    \item{\code{Dimnames}:}{inherited from the
      \code{\linkS4class{Matrix}} class, see there.}
  }
}
\section{Extends}{
  Class \code{"Matrix"}, directly.
}
% \section{Methods}{
%   No methods defined with class "compMatrix" in the signature.
% }

%% FIXME:  add stuff here:

% \seealso{
%
% }
% \examples{
% ##---- Should be DIRECTLY executable !! ----
% }
\keyword{classes}