File: MatrixClass.Rd

package info (click to toggle)
rmatrix 1.7-4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 12,096 kB
  • sloc: ansic: 97,203; makefile: 280; sh: 165
file content (41 lines) | stat: -rw-r--r-- 1,164 bytes parent folder | download | duplicates (2)
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
39
40
41
\name{MatrixClass}
\title{The Matrix (Super-) Class of a Class}
%
\keyword{utilities}
%
\alias{MatrixClass}
\description{
  Return the (maybe super-)\code{\link{class}} of class \code{cl} from
  package \pkg{Matrix}, returning \code{\link{character}(0)} if there is none.
}
\usage{
MatrixClass(cl, cld = getClassDef(cl), ...Matrix = TRUE,
            dropVirtual = TRUE, ...)
}
\arguments{
  \item{cl}{string, class name}
  \item{cld}{its class definition}
  \item{...Matrix}{\code{\link{logical}} indicating if the result must be of
    pattern \code{"[dlniz]..Matrix"} where the first letter "[dlniz]"
    denotes the content kind.}
  \item{dropVirtual}{\code{\link{logical}} indicating if virtual classes
    are included or not.}% ?? (FIXME) -- example
  \item{\dots}{further arguments are passed to
    \code{\link{.selectSuperClasses}()}.}
}
\value{
  a \code{\link{character}} string
}
\author{Martin Maechler, 24 Mar 2009}
%% \details{
%% }
\seealso{
  \code{\linkS4class{Matrix}}, the mother of all \pkg{Matrix} classes.
}
\examples{
mkA <- setClass("A", contains="dgCMatrix")
(A <- mkA())
stopifnot(identical(
     MatrixClass("A"),
     "dgCMatrix"))
}